调用ScaleoutApplicationWithNewInstances接口在EDAS中代购ECS实例,并将代购的实例扩容到指定的应用分组。

限制说明

若应用配置并开启了弹性伸缩规则,在触发自动缩容时将优先移除此接口代购的实例。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /pop/v5/scaling/scale_out HTTPS|HTTP

请求参数

名称 类型 位置 是否必选 示例值 描述
AppId String Query e370c17f-*****-3df0721a327

扩容的目标应用ID,可通过调用ListApplication接口来获取,详情请参见ListApplication

GroupId String Query e37**********-33df0721a327

扩容应用的目标分组ID,可通过调用ListDeployGroup接口来获取,详情请参见ListDeployGroup

ScalingNum Integer Query 2

此次扩容的实例数量

TemplateId String Query lt-****hy9s2

ECS启动模板ID,可通过调用DescribeLaunchTemplates接口获取,详情请参见DescribeLaunchTemplates

TemplateVersion String Query -1

ECS启动模板版本,可通过调用DescribeLaunchTemplateVersions接口获取,详情请参见DescribeLaunchTemplateVersions

说明 设置为-1代表使用默认的启动模板版本。
ScalingPolicy String Query release

指定伸缩组的回收模式,取值范围:

  • recycle:伸缩组的回收模式为停机回收模式
  • release:伸缩组的回收模式为释放模式

从一个伸缩组删除实例,详情请参见RemoveInstances

TemplateInstanceId String Query i-28wt4****

扩容时使用的现有ECS实例ID,若填写此项,将以指定的ECS实例的规格和配置为模板来购买新的ECS实例。

ClusterId String Query e37**********-33df0721a327

扩容的集群ID,若指定了应用和分组进行扩容,此参数将被忽略。

InstanceChargeType String Query PrePaid

实例的付费方式。取值范围:

  • PrePaid:包年包月
  • PostPaid(默认):按量付费
InstanceChargePeriodUnit String Query Month

包年包月计费方式的时长单位。取值范围:

  • Week
  • Month(默认)
InstanceChargePeriod Integer Query 1

购买资源的时长,单位由InstanceChargePeriodUnit指定。当参数InstanceChargeType取值为PrePaid时才生效。

  • InstanceChargePeriodUnit=Week时,Period取值:{“1”, “2”, “3”, “4”}。
  • InstanceChargePeriodUnit=Month时,Period取值:{“1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “12”, “24”, “36”, ”48”, ”60”}。
AutoRenew Boolean Query true

是否要自动续费。当参数InstanceChargeType取值PrePaid时才生效。取值范围:

  • true:自动续费
  • false(默认):不自动续费
AutoRenewPeriod Integer Query 1

单次自动续费的续费时长。取值范围:

  • InstanceChargePeriodUnit=Week时:{“1”, “2”, “3”}。
  • InstanceChargePeriodUnit=Month时:{“1”, “2”, “3”, “6”, “12”, "24", "36", "48", "60"}。

默认值:1

返回数据

名称 类型 示例值 描述
ChangeOrderId String e370c17f-*****-3df0721a327

应用扩容的变更记录ID

Code Integer 200

接口状态或POP错误码

InstanceIds List ["i-28wt4****","i-28wt4****"]

代购产生的ECS实例列表

Message String success

附加消息

RequestId String e370c17f-*****-3df0721a327

请求ID

示例

请求示例

POST /pop/v5/scaling/scale_out HTTP/1.1
公共请求头
{
"AppId": "e370c17f-*****-3df0721a327",
"GroupId": "e37**********-33df0721a327",
"ScalingNum": "2",
"TemplateInstanceId": "i-28wt4****"
}

正常返回示例

XML 格式

<Message>success</Message>
<RequestId>e370c17f-*****-3df0721a327</RequestId>
<ChangeOrderId>e370c17f-*****-3df0721a327</ChangeOrderId>
<InstanceIds>i-28wt4****</InstanceIds>
<InstanceIds>i-28wt4****</InstanceIds>
<Code>200</Code>

JSON 格式

{"Message":"success","RequestId":"e370c17f-*****-3df0721a327","ChangeOrderId":"e370c17f-*****-3df0721a327","InstanceIds":["i-28wt4****","i-28wt4****"],"Code":"200"}

错误码

HttpCode 错误码 错误信息 描述
500 Edas.errorcode.PermissionDenied.message You are not authorized to perform the operation. 无权限操作

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