1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
本接口 (DescribeBackupPlans) 用于实例所有的备份计划查询
默认接口请求频率限制:1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBackupPlans。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DBInstanceId | 是 | String | 实例ID。可通过DescribeDBInstances接口获取 示例值:postgres-xxxxxxxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Plans | Array of BackupPlan | 实例的备份计划集 示例值:[ { "BackupPeriod": "["monday","thursday","friday"]", "BaseBackupRetentionPeriod": 3, "MaxBackupStartTime": "10:00:00", "MinBackupStartTime": "08:00:00" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例所有备份计划
查询postgres-xxxxxxxx实例的所有备份计划
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupPlans
<公共请求参数>
{
"DBInstanceId": "postgres-1xm16x1d"
}
输出示例
{
"Response": {
"Plans": [
{
"BackupPeriod": "[\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\",\"saturday\",\"sunday\"]",
"BackupPeriodType": "week",
"BaseBackupRetentionPeriod": 7,
"LogBackupRetentionPeriod": 7,
"MaxBackupStartTime": "05:16:05",
"MinBackupStartTime": "01:16:05",
"PlanId": "422a5f4d-52af-5cb1-9474-324d63ccc62c",
"PlanName": "default",
"PlanType": "default"
},
{
"BackupPeriod": "[\"1\",\"2\"]",
"BackupPeriodType": "month",
"BaseBackupRetentionPeriod": 40,
"LogBackupRetentionPeriod": 7,
"MaxBackupStartTime": "02:00:00",
"MinBackupStartTime": "01:00:00",
"PlanId": "dfea3bb4-8ca7-5e79-aefb-9d231f2b66b6",
"PlanName": "plan_test",
"PlanType": "custom"
}
],
"RequestId": "0b6c3429-6dfc-4ecd-ab80-b25631f0821e"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.CamCheckResourceError | 获取权限失败,请稍后重试。如果持续不成功,请联系客服进行处理。。 |
FailedOperation.CamSigAndAuthError | 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.DatabaseAccessError | 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.FailedOperationError | 操作失败,请稍后重试。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
OperationDenied.CamDeniedError | 当前操作被限制。 |
OperationDenied.InstanceAccessDeniedError | 您没有权限操作当前资源。 |
OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
ResourceNotFound.InstanceNotFoundError | 实例不存在。 |