查询实例备份列表
最近更新时间: 2024-10-18 10:38:26
1. 接口描述
接口请求域名: mongodb.api3.fincloud.tencent.cn。
本接口(DescribeDBBackups)用于查询实例备份列表,目前只支持7天内的备份查询。
默认接口请求频率限制:20次/秒。
接口更新时间:2019-10-11 21:28:02。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DescribeDBBackups |
Version | 是 | 否 | String | 公共参数,本接口取值:2019-07-25 |
Region | 是 | 否 | String | 公共参数,详见产品支持的地域列表(TODO) |
InstanceId | 是 | 否 | String | 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BackupList | BackupInfo | 备份列表 |
TotalCount | Uint64 | 备份总数 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | |
InvalidParameterValue.NotFoundInstance | |
InvalidParameter.PermissionDenied |