查看AnalyticDB PostgreSQL版实例的计划详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
| gp-bp12ga6v69h86**** |
PlanDesc | string | 否 | 计划描述。 | this is a test plan |
PlanType | string | 否 | 计划类型,取值如下:
| PauseResume |
PlanScheduleType | string | 否 | 计划执行方式,取值如下:
| Regular |
PlanId | string | 否 | 计划 ID。 说明
您可以调用 DescribeDBInstancePlans 接口查看计划的详细信息,包括计划 ID。
| 1234 |
PlanCreateDate | string | 否 | 过滤该日期之前创建的计划,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间),不传入该参数表示返回所有时间的计划。 | 2022-04-17T23:00Z |
返回参数
示例
正常返回示例
JSON
格式
{
"Status": "success",
"ErrorMessage": "****",
"RequestId": "34b32a0a-08ef-4a87-b6be-cdd988888888",
"TotalRecordCount": 1,
"PageRecordCount": 1,
"PageNumber": 1,
"Items": {
"PlanList": [
{
"PlanName": "test-plan",
"PlanDesc": "this is a test plan",
"PlanId": "1234",
"PlanStatus": "active",
"PlanType": "PauseResume",
"PlanScheduleType": "Regular",
"PlanStartDate": "2022-04-17T23:00Z",
"PlanEndDate": "2023-04-17T23:00Z",
"PlanConfig": "{\"pause\":{\"planCronTime\":\"0 22 * * 5\"},\"resume\":{\"planCronTime\":\"0 23 * * 5\"}}",
"DBInstanceId": "gp-bp12ga6v69h86****"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-08-25 | 新增 OpenAPI | 看变更集 |