Skip to Content
云数据库 MongoDB UDB(NVMe)获取实例备份策略 - GetUMongoDBBackupParam

获取实例备份策略 - GetUMongoDBBackupParam

简介

获取实例备份策略

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称,当前 API 为 GetUMongoDBBackupParamYes
PublicKeystring用户公钥,可从 控制台 获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名,参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
Zonestring可用区。参见 可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口No
ClusterIdstring实例IDYes

响应字段

字段名类型描述信息必填
RetCodeint返回状态码,为 0 则为成功返回,非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息,当 RetCode 非 0 时提供详细的描述信息No
DataSetBackupParam备份策略信息Yes

数据模型

BackupParam

字段名类型描述信息必填
ClusterIdstring实例IDYes
AutoBackupToggleWeekstring自动备份预期周几 (1-7 表示 周一到周末,多个数据用’,‘分割,eg: 3,7)No
AutoBackupToggleTimestring自动备份预期时间范围 (24小时制,精确到分钟,00:00~23:59)No
AutoBackupCopiesint自动备份保存份数No
ManualBackupCopiesint手动备份保存份数No
Disabledboolean是否禁用(false:未禁用;true:禁用)No

示例

请求示例

https://api.an-link.com/?Action=GetUMongoDBBackupParam &Region=cn-zj &Zone=cn-zj-01 &ClusterId=DmBGvXyK &ProjectId=VGopVKMd

响应示例

{ "Action": "GetUMongoDBBackupParamResponse", "DataSet": {}, "Message": "eBkJLfZH", "RetCode": 0 }