1. 接口描述
接口请求域名: sqlserver.tencentcloudapi.com 。
本接口(DescribeBackups)用于查询备份列表。
默认接口请求频率限制:60次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBackups。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
StartTime | 是 | Timestamp | 开始时间(yyyy-MM-dd HH:mm:ss) 示例值:2018-03-28 00:00:00 |
EndTime | 是 | Timestamp | 结束时间(yyyy-MM-dd HH:mm:ss) 示例值:2018-04-20 00:00:00 |
InstanceId | 是 | String | 实例ID,形如mssql-njj2mtpl 示例值:mssql-njj2mtpl |
Limit | 否 | Integer | 分页返回,每页返回的数目,取值为1-100,默认值为20 示例值:20 |
Offset | 否 | Integer | 分页返回,页编号,默认值为第0页 示例值:0 |
BackupName | 否 | String | 按照备份名称筛选,不填则不筛选此项 示例值:DBName |
Strategy | 否 | Integer | 按照备份策略筛选,0-实例备份,1-多库备份,不填则不筛选此项 示例值:0 |
BackupWay | 否 | Integer | 按照备份方式筛选,0-后台自动定时备份,1-用户手动临时备份,2-定期备份,不填则不筛选此项 示例值:0 |
BackupId | 否 | Integer | 按照备份ID筛选,不填则不筛选此项 示例值:558800 |
DatabaseName | 否 | String | 按照备份的库名称筛选,不填则不筛选此项 示例值:db1 |
Group | 否 | Integer | 是否分组查询,默认是0,单库备份情况下 0-兼容老方式不分组,1-单库备份分组后展示 示例值:0 |
Type | 否 | Integer | 备份类型,1-数据备份,2-日志备份,默认值为1 示例值:1 |
BackupFormat | 否 | String | 按照备份文件形式筛选,pkg-打包备份文件,single-单库备份文件 示例值:pkg |
StorageStrategy | 否 | Integer | 备份存储策略 0-跟随自定义备份保留策略 1-跟随实例生命周期直到实例下线,默认取值0 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 备份总数量 示例值:2 |
Backups | Array of Backup | 备份列表详情 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询备份列表
输入示例
POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackups
<公共请求参数>
{
"InstanceId": "mssql-njj2mtpl",
"EndTime": "2018-04-20 00:00:00",
"Limit": "20",
"StartTime": "2018-03-28 00:00:00",
"Offset": "0"
}
输出示例
{
"Response": {
"RequestId": "863b2797-858b-49f3-88e9-50159e564cbc",
"TotalCount": 1,
"Backups": [
{
"BackupFormat": "single",
"BackupName": "mssql-xxx_20220619114124",
"BackupWay": 0,
"DBs": [
"test_db"
],
"CrossBackupAddr": [
{
"CrossExternalAddr": "http",
"CrossInternalAddr": "http",
"CrossRegion": "ap-beijing"
}
],
"CrossBackupStatus": [
{
"CrossRegion": "ap-beijing",
"CrossStatus": 1
}
],
"EndTime": "2022-06-19 11:54:53",
"ExternalAddr": "",
"FileName": "",
"GroupId": "16556099469691",
"Id": 0,
"InternalAddr": "",
"Size": 20887196,
"StartTime": "2022-06-19 11:41:24",
"Status": 1,
"Strategy": 0,
"Region": "ap-guangzhou"
}
]
}
}
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.CosError | 查询对象存储失败。 |
FailedOperation.DBError | 数据库错误。 |
FailedOperation.GcsError | 操作失败或者网络超时。 |
InternalError | 内部错误。 |
InternalError.SystemError | 系统错误。 |
InternalError.UnknownError | 未知错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InputIllegal | 输入错误。 |
InvalidParameter.ParamsAssertFailed | 参数断言转换错误。 |
ResourceNotFound.InstanceNotFound | 实例不存在。 |
UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |