1. 接口描述
接口请求域名： redis.tencentcloudapi.com 。
本接口（DescribeBackupDetail）用于查询实例的备份信息详情。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeBackupDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例 ID。 示例值：crs-4y9t57vt |
| BackupId | 是 | String | 备份 ID，可通过接口 DescribeInstanceBackups 返回的参数 RedisBackupSet 获取。 示例值：678362566696298532848117 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BackupId | String | 备份 ID。 示例值：678362566696298532848117 |
| StartTime | String | 备份开始时间。 示例值："2022-03-24 11:52:20" |
| EndTime | String | 备份结束时间。 示例值："2022-03-24 11:59:16" |
| BackupType | String | 备份方式。 - 1：手动备份。 - 0：自动备份。 示例值："1" |
| Status | Integer | 备份状态。 - 1：备份被其它流程锁定。 - 2：备份正常，没有被任何流程锁定。 - -1：备份已过期。 - 3：备份正在被导出。 - 4：备份导出成功。 示例值：2 |
| Remark | String | 备份的备注信息。 示例值："" |
| Locked | Integer | 备份是否被锁定。 - 0：未被锁定。 - 1：已被锁定。 示例值：0 |
| BackupSize | Integer | 备份文件大小。单位：Byte。 示例值：10240 |
| InstanceType | Integer | 实例类型。 示例值：6 |
| MemSize | Integer | 单分片内存规格大小，单位：MB。 示例值：4096 |
| ShardNum | Integer | 分片数量。 示例值：3 |
| ReplicasNum | Integer | 副本数量。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询备份信息详情
通过该接口查询指定实例备份 ID 的备份信息。
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupDetail
<公共请求参数>
{
"InstanceId": "crs-g9my5vt7",
"BackupId": "154571841-1165701309-438602494"
}输出示例
{
"Response": {
"BackupId": "154571841-1165701309-438602494",
"BackupSize": 528,
"BackupType": "0",
"EndTime": "2022-12-19 19:42:20",
"InstanceType": 9,
"Locked": 0,
"MemSize": 2048,
"Remark": "test005",
"ReplicasNum": 1,
"RequestId": "add15b91-8f3c-4ff3-ba52-7c64c9c435ba",
"ShardNum": 3,
"StartTime": "2022-12-19 19:41:42",
"Status": 2
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.SystemError | 内部系统错误，和业务无关。 |
| InternalError.DbOperationFailed | 统一的 DB 操作错误，可以是 update insert select..。 |
| InternalError.InternalError | 内部错误。 |
| InvalidParameter.PermissionDenied | 接口没有cam权限。 |
| InvalidParameterValue.BackupNotExists | 备份不存在。 |
| ResourceNotFound.InstanceNotExists | 根据 serialId 没有找到对应 redis。 |
| UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |
