调用ModifyElasticPlan修改分时弹性计划。该接口仅适用于数仓版弹性模式集群版(新版)。
接口说明
该接口仅适用于数仓版弹性模式集群版(新版)32 核及以上规格的集群。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
adb:ModifyElasticPlan | update | *DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 数仓版集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有数仓版集群的集群 ID。
| am-bp1rqvm70uh2v**** |
ElasticPlanName | string | 是 | 弹性计划名称,取值说明:
说明
您可以调用 DescribeElasticPlan 接口查看指定集群下所有弹性计划的详细信息,包括弹性计划名称。
| realtime |
ResourcePoolName | string | 否 | 资源组名称。 说明
您可以调用 DescribeDBResourceGroup 接口查看资源组名称。
| test |
ElasticPlanNodeNum | integer | 否 | 弹性计划节点数。
| 0 |
ElasticPlanTimeStart | string | 否 | 弹性计划扩容时间,只支持设置整点时间。格式:HH:mm:ss。 | 8:00:00 |
ElasticPlanTimeEnd | string | 否 | 弹性计划还原时间,只支持设置整点时间,与弹性计划扩容时间的间隔不能超过 24 小时。格式:HH:mm:ss。 | 10:00:00 |
ElasticPlanWeeklyRepeat | string | 否 | 执行弹性计划的周期。0~6 表示周日到周六,多个日期用半角逗号(,)分隔。 | 1,2,3,4,5 |
ElasticPlanMonthlyRepeat | string | 否 | 执行弹性计划的周期。数字表示每个月的几号,多个日期用半角逗号(,)分隔。 | 1,15,25 |
ElasticPlanStartDay | string | 否 | 弹性计划起始日期,格式:yyyy-MM-dd。 | 2022-12-02 |
ElasticPlanEndDay | string | 否 | 弹性计划结束日期,格式:yyyy-MM-dd。 | 2022-12-09 |
ElasticPlanEnable | boolean | 是 | 弹性计划是否生效,取值说明:
| true |
ElasticPlanType | string | 否 | 弹性计划资源类型,取值说明:
说明
| worker |
ElasticPlanWorkerSpec | string | 否 | 弹性计划支持扩容的资源规格,取值说明:
| 16 Core 64 GB |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ElasticPlanParameterError | The specified elastic plan parameter is invalid. | 弹性计划参数错误 |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-02-05 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-12-27 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-06 | OpenAPI 错误码发生变更 | 查看变更详情 |