备份集群数据库 - BackupUMongoDBCluster
简介
备份集群数据库
定义
公共参数
| 参数名 | 类型 | 描述信息 | 必填 | 
|---|---|---|---|
| Action | string | 对应的 API 指令名称,当前 API 为 BackupUMongoDBCluster | Yes | 
| PublicKey | string | 用户公钥,可从 控制台 获取 | Yes | 
| Signature | string | 根据公钥及 API 指令生成的用户签名,参见 签名算法 | Yes | 
请求参数
| 参数名 | 类型 | 描述信息 | 必填 | 
|---|---|---|---|
| Region | string | 地域。 参见 地域和可用区列表 | Yes | 
| Zone | string | 可用区。参见 可用区列表 | Yes | 
| ProjectId | string | 项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口 | No | 
| ClusterId | string | 实例ID | Yes | 
| BackupName | string | 备份名称 | Yes | 
响应字段
| 字段名 | 类型 | 描述信息 | 必填 | 
|---|---|---|---|
| RetCode | int | 返回状态码,为 0 则为成功返回,非 0 为失败 | Yes | 
| Action | string | 操作指令名称 | Yes | 
| Message | string | 返回错误消息,当 RetCode非 0 时提供详细的描述信息 | No | 
| BackupId | string | 备份ID | Yes | 
| ClusterId | string | 实例ID | Yes | 
示例
请求示例
https://api.tnqacloud.com/?Action=BackupUMongoDBCluster
&Region=cn-zj
&Zone=cn-zj-01
&ClusterId=EtfjIAHQ
&BackupName=DsvzYyWJ
&ProjectId=LSeAPhsD响应示例
{
  "Action": "BackupUMongoDBClusterResponse",
  "BackupId": "arLjWxWT",
  "ClusterId": "RvZdcFFU",
  "Message": "FdpUlgpc",
  "RetCode": 0
}