1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
本接口(DescribeBackups)用于查询云数据库实例的备份数据。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBackups。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同。 示例值:cdb-c1nl9rpv |
Offset | 否 | Integer | 偏移量,最小值为0。 示例值:0 |
Limit | 否 | Integer | 分页大小,默认值为20,最小值为1,最大值为100。 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合查询条件的实例总数。 示例值:2 |
Items | Array of BackupInfo | 符合查询条件的备份信息详情。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询数据备份文件列表
查询数据备份文件列表
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackups
<公共请求参数>
{
"InstanceId": "cdb-c1nl9rpv"
}
输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 2,
"Items": [
{
"Status": "SUCCESS",
"FinishTime": "2017-07-23 12:03:42",
"Name": "ivansqwutestdr_backup_20170429000134",
"IntranetUrl": "http://gz.tencent.com",
"Creator": "SYSTEM",
"BackupId": 12445233,
"Date": "2017-04-29 00:01:34",
"StartTime": "2017-07-22 00:01:34",
"InternetUrl": "http://gz.tencent.com",
"Type": "logical",
"Way": "automatic",
"ManualBackupName": "ab",
"SaveMode": "save_mode_regular",
"RemoteInfo": [],
"Region": "ap-guangzhou",
"Method": "full",
"CosStorageType": 0,
"Size": 653226,
"InstanceId": "cdb-sadq",
"EncryptionFlag": "off"
},
{
"Status": "SUCCESS",
"FinishTime": "2017-07-23 12:03:42",
"StartTime": "2017-07-23 00:01:34",
"Name": "ivansqwutestdr_backup_20170430000129",
"IntranetUrl": "http://gz.tencent.com",
"Creator": "SYSTEM",
"BackupId": 436184134,
"Date": "2017-04-30 00:01:29",
"InternetUrl": "http://gz.tencent.com",
"Type": "logical",
"Way": "automatic",
"ManualBackupName": "abv",
"SaveMode": "save_mode_regular",
"RemoteInfo": [],
"Region": "ap-guangzhou",
"Method": "full",
"CosStorageType": 0,
"Size": 653226,
"InstanceId": "cdb-asdqwdqd",
"EncryptionFlag": "on"
}
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
CdbError | 后端错误或者流程错误。 |
InternalError.CdbError | 系统错误。 |
InternalError.DBError | 数据库异常。 |
InternalError.DBOperationError | 数据库操作失败。 |
InternalError.DatabaseAccessError | 数据库内部错误。 |
InternalError.DesError | 系统内部错误。 |
InternalError.FtpError | 文件传输异常。 |
InternalError.HttpError | Http请求异常。 |
InternalError.UndefinedError | 未知错误。 |
InternalError.UnknownError | 未知错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ControllerNotFoundError | 未找到该接口。 |
InvalidParameter.InstanceNotFound | 实例不存在。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
OperationDenied.UserHasNoStrategy | 用户没有该策略权限。 |
OperationDenied.WrongStatus | 后端任务状态非法。 |
UnsupportedOperation | 操作不支持。 |