文档

UpdateDBInstancePlan - 修改定时计划

更新时间:

修改AnalyticDB PostgreSQL版的定时计划。

接口说明

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

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:UpdateDBInstancePlanRead
  • DBInstance
    acs:gpdb:*:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp12ga6v69h86****
PlanNamestring

计划名称。

test-plan
PlanDescstring

计划描述。

this is a test plan
PlanStartDatestring

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

说明
  • 周期执行的计划需要设置该参数。
  • 不传默认为当前时间。
  • 2022-04-17T23:00Z
    PlanEndDatestring

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

    说明
  • 周期执行的计划需要设置该参数。
  • 该参数非必填,没有结束时间,计划删除周期停止。
  • 2023-04-17T23:00Z
    PlanConfigstring

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

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

    计划 ID。

    说明 您可以调用 DescribeDBInstancePlans 接口查看计划的详细信息,包括计划 ID。
    1234

    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 表达式

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad
    Statusstring

    API 执行状态。

    执行成功则返回 success;执行失败则不返回该参数。

    success
    ErrorMessagestring

    错误信息。

    只会在 API 执行失败时返回该参数。

    ****
    DBInstanceIdstring

    实例 ID。

    gp-bp12ga6v69h86****
    PlanIdstring

    计划 ID。

    1234

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2022-08-25新增 OpenAPI查看变更详情