CreateDBInstancePlan - 创建定时计划 - 云原生数据仓库AnalyticDB

接口说明

实例付费类型必须为按量付费。
实例变配和规格变更时，可能会导致业务闪断，建议您将执行时间设置为业务低峰期。

请确保在使用该接口前，已充分了解 AnalyticDB PostgreSQL 版产品的收费方式和价格。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:CreateDBInstancePlan

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的实例 ID。	gp-bp12ga6v69h86****
PlanName	string	是	计划名称。	test-plan
PlanDesc	string	否	计划描述。	this is a test plan
PlanType	string	是	计划类型，取值如下： PauseResume：自动启停。 Resize：实例变配，即增加或减少计算节点。 ModifySpec：规格变更，即变更计算节点规格。说明实例变配仅支持 Serverless 模式实例。规格变更仅支持存储弹性模式实例。	PauseResume
PlanScheduleType	string	是	计划执行方式，取值如下： Postpone：稍后执行。 Regular：周期执行。	Regular
PlanStartDate	string	否	计划的开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明仅 PlanScheduleType 为 Regular 时需要设置该参数。不传默认为当前时间。	2022-04-17T23:00:00Z
PlanEndDate	string	否	计划的结束时间，需要大于查询开始时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明仅 PlanScheduleType 为 Regular 时需要设置该参数。该参数非必填，没有结束时间，计划删除周期停止。	2023-04-17T23:00: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 表达式。

返回参数

名称	类型	描述	示例值
	object
DBInstanceId	string	实例 ID。	gp-bp12ga6v69h86****
ErrorMessage	string	错误信息。只会在 API 执行失败时返回该参数。	****
PlanId	string	计划 ID。	1234
RequestId	string	请求 ID。	34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad
Status	string	API 执行状态。执行成功则返回 success；执行失败则不返回该参数。	success

示例

正常返回示例

JSON格式

{
  "DBInstanceId": "gp-bp12ga6v69h86****",
  "ErrorMessage": "****",
  "PlanId": "1234",
  "RequestId": "34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad",
  "Status": "success"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。