查询Redis实例备份列表
最近更新时间: 2024-10-18 10:38:31
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 | 公共参数,详见产品支持的地域列表(TODO) |
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 | |
UnauthorizedOperation.NoCAMAuthed | |
InternalError.InternalError |