Docs
api
Cloud MongoDB Database(UDB NVMe)
BackupUMongoDBCluster

Backup Cluster Database - BackupUMongoDBCluster

Overview

Backup Cluster Database

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is BackupUMongoDBCluster.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
ClusterIdstringInstance IDYes
BackupNamestringBackup NameYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
BackupIdstringBackup IDYes
ClusterIdstringInstance IDYes

Example

Request Example

https://api.dezai.com/?Action=BackupUMongoDBCluster
&Region=cn-zj
&Zone=cn-zj-01
&ClusterId=EtfjIAHQ
&BackupName=DsvzYyWJ
&ProjectId=LSeAPhsD

Response Example

{
  "Action": "BackupUMongoDBClusterResponse",
  "BackupId": "arLjWxWT",
  "ClusterId": "RvZdcFFU",
  "Message": "FdpUlgpc",
  "RetCode": 0
}