数据库备份服务查询备份计划列表

1. 接口描述

接口请求域名： dbs.tencentcloudapi.com 。

本接口（DescribeBackupPlans）用于查询备份计划列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBackupPlans。
Version	是	String	公共参数，本接口取值：2021-11-08。
Region	是	String	公共参数，详见产品支持的地域列表。
BackupPlanId	否	String	过滤条件，备份计划 ID。示例值：dbs-xxxxxxxx
Status.N	否	Array of String	过滤条件，备份计划状态。示例值：["checkPass", "running"]
DatabaseType.N	否	Array of String	过滤条件，数据库类型。示例值：["mysql","mariadb"]
AccessType.N	否	Array of String	过滤条件，接入访问类型。示例值：["ccn","cdb"]
BackupPlanName	否	String	过滤条件，备份计划名称。示例值：name_test
TagFilters.N	否	Array of TagFilter	过滤条件，标签键值。示例值：{"TagKey":"key","TagValue":["v1", "v2"]}
Limit	否	Integer	分页参数。取值范围为(0, 100]，默认值为20。示例值：20
Offset	否	Integer	分页参数。默认值为0。示例值：0

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	备份计划数量。示例值：10
Items	Array of BackupPlanInfo	备份计划详情。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询备份计划列表

输入示例

POST / HTTP/1.1
Host: dbs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupPlans
<公共请求参数>

{
    "Status": [
        "running",
        "checkPass"
    ],
    "AccessType": [
        "extranet"
    ],
    "Limit": 20
}

输出示例

{
    "Response": {
        "Items": [
            {
                "AccessType": "extranet",
                "AutoRenewFlag": 1,
                "BackupMethod": "logical",
                "BackupPlanId": "dbs-testcloud",
                "BackupPlanName": "dbs-nametest",
                "CreateTime": "2022-03-15 17:49:31",
                "DatabaseType": "percona",
                "EnableIncrement": false,
                "ExpireTime": "2022-05-15 17:49:31",
                "InstanceClass": "micro",
                "OfflineTime": "2022-05-31 09:36:18",
                "PayType": "prePay",
                "Region": "ap-guangzhou",
                "SourceInfo": [
                    "1.0.0.10:8888"
                ],
                "Status": "isolated",
                "Tags": [
                    {
                        "TagKey": "key",
                        "TagValue": "v"
                    }
                ]
            }
        ],
        "TotalCount": 2,
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure.UnauthorizedOperationError	权限不足
UnauthorizedOperation	未授权操作。

查询备份计划列表

本页目录：