Backup Cluster Database - BackupUMongoDBCluster
Overview
Backup Cluster Database
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is BackupUMongoDBCluster. | Yes |
| PublicKey | string | The user’s public key can be obtained from Console  | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes |
| Zone | string | Availability Zone. See Availability Zone List | Yes |
| ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
| ClusterId | string | Instance ID | Yes |
| BackupName | string | Backup Name | Yes |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
| BackupId | string | Backup ID | Yes |
| ClusterId | string | Instance ID | Yes |
Example
Request Example
https://api.sigcalcloud.com/?Action=BackupUMongoDBCluster
&Region=cn-zj
&Zone=cn-zj-01
&ClusterId=EtfjIAHQ
&BackupName=DsvzYyWJ
&ProjectId=LSeAPhsDResponse Example
{
"Action": "BackupUMongoDBClusterResponse",
"BackupId": "arLjWxWT",
"ClusterId": "RvZdcFFU",
"Message": "FdpUlgpc",
"RetCode": 0
}