UpdateDBInstancePlan
修改AnalyticDB PostgreSQL版的定时计划
服务地址:
华东1 金融云
输入参数
只看必填
DBInstanceId实例ID
PlanName计划名称
PlanDesc计划描述
PlanStartDate计划的开始时间
PlanEndDate计划的结束时间
PlanConfig执行计划具体信息
PlanId计划ID
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。展开详情

示例值:gp-bp12ga6v69h86****参考取值来源:
    UpgradeDBInstance
    CreateDBInstance
    DescribeDBInstances
    PauseInstance
    ModifyDBInstancePayType
    ResumeInstance
    UploadDocumentAsync
    DownloadDiagnosisRecords
    UnloadSampleData
PlanNamestring

计划名称。

示例值:test-plan参考取值来源:
    CreateDBInstancePlan
PlanDescstring

计划描述。

示例值:this is a test plan参考取值来源:
    DescribeDBInstancePlans
PlanStartDatestring

计划的开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。展开详情

示例值:2022-04-17T23:00Z参考取值来源:
    DescribeDBInstancePlans
PlanEndDatestring

计划的结束时间,需要大于查询开始时间,格式为yyy-MM-ddTHH:mm:ssZ(UTC 时间)。展开详情

示例值:2023-04-17T23:00Z参考取值来源:
    DescribeDBInstancePlans
PlanConfigstring

执行计划具体信息,JSON 格式,内容需根据 PlanType 参数和 PlanScheduleType 参数的值进行调整,具体说明请参见以下补充说明。

示例值:{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}
PlanIdstring

计划 ID。展开详情

示例值:1234正则:^\d+$

请求说明

PlanConfig 参数补充说明

计划任务为实例启停时:

  • 计划执行方式为稍后执行时,只需要指定启动或暂停的具体时间,其中 pause 为暂停实例;resume 为启动实例;executeTime 为启停的时间(UTC 时间),示例如下:
    • 暂停实例:{"pause":{"executeTime":"2022-08-30T16:00:00Z"}}
    • 启动实例:{"resume":{"executeTime":"2022-08-30T16:00:00Z"}}
  • 计划执行方式为周期执行时,需要指定周期启动和暂停的时间,其中 pause 为暂停实例;resume 为启动实例;planCronTime 为周期启停的时间,Cron 格式(UTC 时间),示例如下: {"pause":{"planCronTime":"0 0 12 1/1 * ? "},"resume":{"planCronTime":"0 0 0 1/1 * ? "}}

计划任务为扩缩容时:

  • 计划执行方式为稍后执行时,需要指定扩容或缩容的时间和目标节点数,其中 scaleOut 为扩容实例;scaleIn 为缩容实例;executeTime 为扩缩容的时间(UTC 时间);segmentNodeNum 为目标节点数,示例如下:
    • 扩容实例:{"scaleOut":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":4}}
    • 缩容实例:{"scaleIn":{"executeTime":"2022-08-30T16:00:00Z","segmentNodeNum":2}}
  • 计划执行方式为周期执行时,需要指定周期扩缩容的时间和目标节点数,其中 scaleOut 为扩容实例;scaleIn 为缩容实例;planCronTime 为周期扩缩容的时间,Cron 格式(UTC 时间);segmentNodeNum 为目标节点数,示例如下: {"scaleIn":{"segmentNodeNum":2,"planCronTime":"0 0 12 1/1 * ? "},"scaleOut":{"segmentNodeNum":4,"planCronTime":"0 0 0 1/1 * ? "}}
说明 Cron 表达式的说明和相关使用方法,请参见 Cron 表达式

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad
Statusstring

API 执行状态。展开详情

示例值:success
ErrorMessagestring

错误信息。展开详情

示例值:****
DBInstanceIdstring

实例 ID。

示例值:gp-bp12ga6v69h86****
PlanIdstring

计划 ID。

示例值:1234
变更历史
变更时间变更内容概要操作
2022-08-25
新增OpenAPI,修改定时计划