全部产品
Search
文档中心

云服务器 ECS:ModifyAutoProvisioningGroup - 修改一个弹性供应组的设置

更新时间:Nov 29, 2024

调用ModifyAutoProvisioningGroup接口修改一个弹性供应组的设置。

接口说明

修改弹性供应组前,请注意:

  • 如果修改了供应组容量或者容量相关设置,供应组会在修改完成后执行一次调度任务。
  • 如果供应组处于删除中状态,无法修改供应组。

调试

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

授权信息

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

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

请求参数

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

弹性供应组所在地域的 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
AutoProvisioningGroupIdstring

弹性供应组的 ID。

apg-bp67acfmxazb4ph****
ExcessCapacityTerminationPolicystring

弹性供应组实时容量超过目标容量并触发缩容时,是否释放缩容的实例。取值范围:

  • termination:释放缩容的实例。
  • no-termination:只将缩容的实例移出弹性供应组。
no-termination
DefaultTargetCapacityTypestring

PayAsYouGoTargetCapacity 和 SpotTargetCapacity 之和小于 TotalTargetCapacity 时,指定差额容量的计费方式。取值范围:

  • PayAsYouGo:按量付费实例。
  • Spot:抢占式实例。
Spot
TerminateInstancesWithExpirationboolean

弹性供应组到期时,是否释放组内实例。取值范围:

  • true:释放组内实例。
  • false:只将组内实例移出弹性供应组。
false
MaxSpotPricefloat

弹性供应组内抢占式实例的最高价格。

说明 同时设置了 MaxSpotPrice 和 LaunchTemplateConfig.N.MaxPrice 时,以最低值为准。LaunchTemplateConfig.N.MaxPrice 在创建弹性供应组时设置,且不可修改。
0.5
TotalTargetCapacitystring

弹性供应组的目标总容量。取值范围:正整数。

总容量必须大于等于 PayAsYouGoTargetCapacity(指定的按量付费实例目标容量)和 SpotTargetCapacity(指定的抢占式实例目标容量)取值之和。

70
PayAsYouGoTargetCapacitystring

弹性供应组内,按量付费实例的目标容量。取值范围:小于 TotalTargetCapacity 的参数取值。

30
SpotTargetCapacitystring

弹性供应组内,抢占式实例的目标容量。取值范围:小于 TotalTargetCapacity 的参数取值。

30
AutoProvisioningGroupNamestring

弹性供应组的名称。长度为 2~128 个英文或中文字符。必须以大小字母或中文开头,不能以 http://和 https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。

apg-test
LaunchTemplateConfigarray<object>

扩展启动模板列表。

object

扩展启动模板列表。

VSwitchIdstring

扩展启动模板中,ECS 实例加入的虚拟交换机的 ID。扩展模板中启动的 ECS 实例的可用区由虚拟交换机决定。

vsw-sn5bsitu4lfzgc5o7****
MaxPricedouble

扩展启动模板中,抢占式实例的价格上限。

3
Priorityinteger

扩展启动模板的优先级,取值为 0 时优先级最高。取值范围:大于 0。

1
InstanceTypestring

扩展启动模板对应的实例规格,N 的取值范围:1~20。取值范围:请参见实例规格族

ecs.g5.large
WeightedCapacitydouble

扩展启动模板中,实例规格的权重。取值越高,单台实例满足计算力需求的能力越大,所需的实例数量越小。取值范围:大于 0。

您可以根据指定实例规格的计算力和集群单节点最低计算力得出权重值。假设单节点最低计算力为 8 vCPU、60 GiB,则:

  • 8 vCPU、60 GiB 的实例规格权重可以设置为 1。
  • 16 vCPU、120 GiB 的实例规格权重可以设置为 2。
2

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

B48A12CD-1295-4A38-A8F0-0E92C937****

示例

正常返回示例

JSON格式

{
  "RequestId": "B48A12CD-1295-4A38-A8F0-0E92C937****"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe specified parameter "AutoProvisioningGroupId" should not be null.-
400MissingParameterThe specified parameter "AutoProvisioningGroupConfig" should not be null.-
400NoPermission%s-
400InvalidLaunchTemplateConfigs.SizeExceedThe size of LaunchTemplateConfigs exceeds limit.-
400QuotaExceed.LaunchTemplateConfigs%s-
400OperationDenied%s拒绝操作。
403Forbidden.RAMUser not authorized to operate on the specified resource, or this API doesn't support RAM.当前用户没有权限对指定资源进行操作
403InvalidName.MalformedThe specified parameter "AutoProvisioningGroupName" is not valid.-
403AutoProvisioningGroup.UnauthorizedUnauthorized to operate current action.-
403AutoProvisioningGroup.IncorrectStatusCurrent status of AutoProvisioningGroup does not support curren action.供应组状态不支持当前操作。
403InvalidParameter.TargetCapacityThe Capacity is illegal, TotalTargetCapacity, PayAsYouGoTargetCapacity, SpotTargetCapacity must be specified, meanwhile, the TargetCapacity must be larger than or equal to the sum of SpotCapacity and OnDemandCapacity.-
404InvalidAutoProvisioningGroupId.NotFoundThe specified AutoProvisioningGroupId does not exist.-
404InvalidParameter.MaxPriceThe specified parameter "MaxSpotPrice" is not valid.-

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