创建定时计划。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| gpdb:CreateDBInstancePlan | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例ID。 说明
您可以调用DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL实例的实例ID。
| gp-bp12ga6v69h86**** |
| PlanName | string | 是 | 计划名称。 | test-plan |
| PlanDesc | string | 否 | 计划描述。 | this is a test plan |
| PlanType | string | 是 | 计划类型，取值如下：
说明
| PauseResume |
| PlanScheduleType | string | 是 | 计划执行方式，取值如下：
| Regular |
| PlanStartDate | string | 否 | 计划的开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。 说明
| 2022-04-17T23:00Z |
| PlanEndDate | string | 否 | 计划的结束时间，需要大于查询开始时间，格式为yyy-MM-ddTHH:mmZ（UTC时间）。 说明
| 2023-04-17T23:00Z |
| PlanConfig | string | 是 | 执行计划具体信息，JSON格式，内容需根据PlanType参数和PlanScheduleType参数的值进行调整，具体说明请参见以下补充说明。 | {"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}} |
PlanConfig参数补充说明
PlanType为PauseResume时：
- PlanScheduleType为Postpone时，只需要指定启动或暂停的具体时间，其中pause为暂停实例；resume为启动实例；executeTime为启停的时间（UTC时间），示例如下：
- 暂停实例：
{"pause":{"executeTime":"2022-08-30T16:00:00Z"}} - 启动实例：
{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}
- 暂停实例：
- PlanScheduleType为Regular时，需要指定周期启动和暂停的时间，其中pause为暂停实例；resume为启动实例；planCronTime为周期启停的时间，Cron格式（UTC时间），示例如下：
{"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}。
PlanType为Resize时：
- PlanScheduleType为Postpone时，需要指定扩容或缩容的时间和目标节点数，其中scaleOut为扩容实例；scaleIn为缩容实例；executeTime为扩缩容的时间（UTC时间）；segmentNodeNum为目标节点数，示例如下：
- 扩容实例：
{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}} - 缩容实例：
{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}
- 扩容实例：
- PlanScheduleType为Regular时，需要指定周期扩缩容的时间和目标节点数，其中scaleOut为扩容实例；scaleIn为缩容实例；planCronTime为周期扩缩容的时间，Cron格式（UTC时间）；segmentNodeNum为目标节点数，示例如下：
{"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}。
PlanType为ModifySpec时：
- PlanScheduleType为Postpone时，需要指定升配或降配的时间和目标规格，其中scaleUp为实例升配；scaleDown为实例降配；executeTime为扩缩容的时间（UTC时间）；instanceSpec为目标规格，示例如下：
- 实例升配：
{"scaleUp":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"4C32G"}} - 实例降配：
{"scaleDown":{"executeTime":"2022-08-30T16:00:00Z","instanceSpec":"2C16G"}}
- 实例升配：
- PlanScheduleType为Regular时，需要指定周期升降配的时间和目标规格，其中scaleUp为实例升配；scaleDown为实例降配；planCronTime为周期扩缩容的时间，Cron格式（UTC时间）；instanceSpec为目标规格，示例如下：
{"scaleUp":{"instanceSpec":"4C32G","planCronTime":"0 0 12 1/1 * ? "},"scaleDown":{"instanceSpec":"2C16G","planCronTime":"0 0 0 1/1 * ? "}}。
说明
Cron表达式的说明和相关使用方法，请参见Cron表达式。
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad",
"Status": "success",
"ErrorMessage": "****",
"DBInstanceId": "gp-bp12ga6v69h86****",
"PlanId": "1234"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-08-25 | 新增 OpenAPI | 看变更集 |
