更新节点池弹性预约伸缩规则。

请求说明

VKE 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://vke.cn-beijing.volcengineapi.com?Action=UpdateScalingPolicy&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateScalingPolicy	接口名称。当前 API 的名称为 UpdateScalingPolicy。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 2022-05-12。
ClusterId	String	是	cc5silum********	集群 ID。可以调用 ListClusters 接口，获取集群 ID。注意集群必须处于{Running,[Ok]}或{Updating,[Progressing]}状态。可调用 ListClusters 接口获取集群当前的状态。
NodePoolId	String	是	pc51i0m6********	节点池 ID。注意节点池必须处于{Running,[*]}状态。可调用 ListNodePools 接口获取节点池当前的状态。
Id	String	是	spco2o8q2n********	弹性预约伸缩规则 ID。
AdjustmentValue	Integer	否	1	节点池弹性伸缩时，增加的节点数量。整数形式，取值范围为 1～500。
ScheduledPolicy	Object of ScheduledPolicyForUpdate	否	-	定时任务或周期任务配置。
ScheduledInstancePolicy	Object of ScheduledInstancePolicyForUpdate	否	-	弹性预约伸缩规则配置。
Enabled	Boolean	否	false	是否启用伸缩规则，取值: true：启用 false：禁用
ClientToken	String	否	BC028527-33B9-4990-A633-84E9F9******	用于保证请求幂等性的字符串。该字符串由调用方传入，需保证不同请求之间唯一。ClientToken 对大小写敏感，且最大值不超过 64 个 ASCII 字符。
Name	String	否	test-policy	弹性预约伸缩规则的名称。支持中文、英文字母、数字、下划线(_)和中划线(-)，暂不支持特殊字符。仅允许以中文、英文字母开头。长度限制为 1~128个字符。说明同一个节点池下，规则名称必须唯一。

ScheduledPolicyForUpdate

参数	类型	是否必选	示例值	描述
LaunchTime	String	否	2022-04-01T16:00Z	任务的开始时间，UTC 时间，精确到分钟。仅当Type取值为Scheduled或Recurrence时有效且必填。当Type取值为Scheduled时，表示定时任务的触发时间。当Type取值为Recurrence时，表示周期任务的开始时间。需大于当前时间，且仅支持配置自创建/修改时间起 90 日内的时间。说明为保证预约扩容请求提交成功，建议配置的LaunchTime至少晚于当前时间 1 分钟。
RecurrenceType	String	否	Daily	周期任务的重复周期，仅当Type取值为Recurrence时有效且必填。取值： Daily：每隔几天执行一次。 Weekly：选择每周中的几天，每天执行一次。 Monthly：选择每月中几号到几号，每天执行一次。
RecurrenceValue	String	否	1	周期任务的重复执行次数。仅当Type取值为Recurrence时有效且必填。当RecurrenceType取值为Daily时，只能填写一个值，取值范围为 1 ~ 31。当RecurrenceType取值为Weekly时，支持填入多个值，使用英文逗号,分隔。星期一到星期日的取值依次为：1,2,3,4,5,6,7。当RecurrenceType取值为Monthly时，格式为A-B。A、B 的取值范围均为 1~31，且 B 必须大于等于 A。
RecurrenceEndTime	String	否	2022-04-02T16:00Z	周期任务的结束时间，UTC 时间，精确到分钟。仅当Type取值为Recurrence时有效且必填。需大于等于LaunchTime，且仅支持配置自创建/修改时刻起 365 日内的时间。

ScheduledInstancePolicyForUpdate

参数	类型	是否必选	示例值	描述
ElasticScheduledInstanceType	String	否	Esi	弹性预约实例类型，取值： Esi：弹性预约实例-通用型 Segmented：弹性预约实例-时段型
DeliveryType	String	否	Reserve	弹性预约实例-时段型的交付类型，取值： Reserve：预约交付 Immediate：立即交付说明仅当ElasticScheduledInstanceType取值为Segmented，即为弹性预约实例-时段型类型时有效且必填。
AutoReleaseTime	String	否	2022-04-01T18:10Z	预约实例的自动释放时间，UTC 时间，精确到分钟。当ElasticScheduledInstanceType为Segmented，即为弹性预约实例-时段型类型时有效且必填。必须为 10 分钟整点。如果DeliveryType为Reserve，即为预约交付类型时，该时间必须大于预约交付 +1 小时。如果DeliveryType为Immediate，即为立即交付类型时，最早释放时间为当前时间下一个整十分钟时间点。例如：当前时间5:02，则最早自动释放时间为 5:20。
StartDeliveryTime	String	否	2022-04-01T16:00Z	弹性预约实例的交付开始时间，UTC 时间，精确到分钟。必须为 10 分钟整点，取值: 当ElasticScheduledInstanceType为 Esi，即为弹性预约实例-通用型类型时，有效且必填：取值为周期任务的开始时间LaunchTime后的 4～8 小时内。当ElasticScheduledInstanceType为Segmented，即为弹性预约实例-时段型类型时：如果DeliveryType为Reserve，即为预约交付类型时，有效且必填。取值为周期任务的开始时间LaunchTime的 24 小时以内。如果DeliveryType为Reserve，即为立即交付类型时，无需传入该参数。
EndDeliveryTime	String	否	2022-04-01T16:10Z	弹性预约实例的交付结束时间，UTC 时间，精确到分钟。必须为 10 分钟整点，且与StartDeliveryTime的间隔为 10 分钟。取值：当ElasticScheduledInstanceType为 Esi，即为弹性预约实例-通用型类型时，有效且必填：取值为周期任务的开始时间LaunchTime后的 4～8 小时内。当ElasticScheduledInstanceType为Segmented，即为弹性预约实例-时段型类型时：如果DeliveryType为Reserve，即为预约交付类型时，有效且必填。取值为周期任务的开始时间LaunchTime的 24 小时以内。如果DeliveryType为Reserve，即为立即交付类型时，无需传入该参数。
BestEffort	Boolean	否	true	当弹性预约实例的库存不能完全满足预约需求时，是否尽可能多的预约实例。 false：最多生成一个预约单。 true：当单个预约单无法满足需求时，会提交多个预约单。

请求示例

返回参数

本接口无专有返回参数，公共返回参数请参见返回结果。

返回示例

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	OperationDenied.ClusterStatus	The action is forbidden due to cluster status {{statusPhase}} and {{statusConditions}}.	指定集群的当前状态不支持该操作。请确认该接口依赖的集群状态后重试。
400	OperationDenied.NodePoolStatus	The action is forbidden on node pool {{nodePoolId}} due to node pool status {{statusPhase}} and {{statusConditions}}.	指定节点池的当前状态不支持该操作。请确认该接口依赖的节点池状态后重试。
400	NotSupportScalingPolicy.NodePoolConfig	The specified nodepool config does not support scaling policy.	指定的节点池配置不支持伸缩规则。请重新指定参数后重试。
400	LaunchTimeMismatch.StartDeliveryTime	The specified StartDeliveryTime and LaunchTime are mismatched.	指定的开始交付时间与任务触发时间不匹配。
400	LaunchTimeMismatch.EndDeliveryTime	The specified EndDeliveryTime and LaunchTime are mismatched.	指定的结束交付时间与提交预约单时间不匹配。请根据参数说明，配置准确的参数值后重试。
400	StartDeliveryTimeMismatch.EndDeliveryTime	The specified EndDeliveryTime and StartDeliveryTime are mismatched.	指定的结束交付时间与开始交付时间不匹配，两者必须间隔 10 分钟。请重新指定参数后重试。
400	LimitExceeded.AdjustmentValue	You have reached the limit on the size of AdjustmentValue.	伸缩行为的调整数值超过了支持的最大交付数量。请重新指定参数后重试。
400	EndDeliveryTimeMismatch.AutoReleaseTime	The specified EndDeliveryTime and AutoReleaseTime are mismatched.	指定的自动释放时间与结束交付时间不匹配。请根据参数说明，配置准确的参数值后重试。
400	LaunchTimeMismatch.AutoReleaseTime	The specified AutoReleaseTime and LaunchTime are mismatched.	指定的自动释放时间与提交预约单时间不匹配。请根据参数说明，配置准确的参数值后重试。
400	InvalidRegionForScheduledInstance.Unsupported	The specified region does not support scheduled instance.	指定的地域不支持弹性预约实例。支持的地域详情，请参见弹性预约实例概述。
409	Conflict.Name	The specified name conflicts with existing {{resourceType}}.	指定节点池下存在同名资源，请更新资源名称后重试。

容器服务