DescribeInstanceBackups
最近更新时间: 2025-10-20 17:05:53
1. 接口描述
接口请求域名： redis.api3.fincloud.tencent.cn。
查询 CRS 实例备份列表
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-25 11:10:51。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeInstanceBackups |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Limit | 否 | 否 | Int64 | 实例列表大小，默认大小20 |
| Offset | 否 | 否 | Int64 | 偏移量，取Limit整数倍 |
| InstanceId | 是 | 否 | String | 待操作的实例ID，可通过 DescribeInstance 接口返回值中的 InstanceId 获取。 |
| BeginTime | 否 | 否 | String | 开始时间，格式如：2017-02-08 16:46:34。查询实例在 [beginTime, endTime] 时间段内开始备份的备份列表。 |
| EndTime | 否 | 否 | String | 结束时间，格式如：2017-02-08 19:09:26。查询实例在 [beginTime, endTime] 时间段内开始备份的备份列表。 |
| Status | 否 | 否 | Array of Int64 | 1：备份在流程中，2：备份正常，3：备份转RDB文件处理中，4：已完成RDB转换，-1：备份已过期，-2：备份已删除。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 此参数对外不可见。 备份总数 |
| BackupSet | RedisBackupSet | 此参数对外不可见。 实例的备份数组 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidParameter | 业务参数错误。 |
| ResourceNotFound.InstanceNotExists | 根据 serialId 没有找到对应 redis。 |
| UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |
| InternalError.InternalError | 内部错误。 |