如果您需要根據(jù)業(yè)務(wù)變動(dòng)需求與策略自動(dòng)增加或減少指定類(lèi)型的實(shí)例數(shù)量,則可以通過(guò)配置伸縮組來(lái)自動(dòng)調(diào)整您的業(yè)務(wù)計(jì)算能力(即實(shí)例數(shù)量)。如果當(dāng)前伸縮組屬性不再滿(mǎn)足業(yè)務(wù)需求,則您可以調(diào)用API ModifyScalingGroup修改伸縮組屬性(例如最大實(shí)例數(shù)、最小實(shí)例數(shù)或期望實(shí)例數(shù)等屬性),避免重新創(chuàng)建伸縮組并重新配置相關(guān)屬性,節(jié)省了時(shí)間和資源成本。
接口說(shuō)明
-
不支持修改以下參數(shù):
-
RegionId
-
LoadBalancerId
說(shuō)明 如果需要修改負(fù)載均衡實(shí)例,請(qǐng)使用 AttachLoadBalancers 和 DetachLoadBalancers 接口。-
DBInstanceId
說(shuō)明 如果需要修改 RDS 實(shí)例,請(qǐng)使用 AttachDBInstances 和 DetachDBInstances 接口。 -
-
當(dāng)伸縮組的狀態(tài)為
Active
或Inactive
時(shí)才能調(diào)用該接口。 -
啟用新的伸縮配置不會(huì)影響通過(guò)早前伸縮配置創(chuàng)建并正在運(yùn)行的 ECS 實(shí)例或 ECI 實(shí)例。
-
如果修改了 MaxSize,導(dǎo)致當(dāng)前伸縮組的 ECS 或 ECI 實(shí)例數(shù)超過(guò) MaxSize,則伸縮組會(huì)自動(dòng)移出 ECS 實(shí)例或 ECI 實(shí)例,使得伸縮組的 ECS 或 ECI 實(shí)例數(shù)等于 MaxSize。
-
如果伸縮組修改了 MinSize,導(dǎo)致當(dāng)前伸縮組的 ECS 或 ECI 實(shí)例數(shù)低于 MinSize,則伸縮組會(huì)自動(dòng)加入 ECS 實(shí)例或 ECI 實(shí)例,使得伸縮組的 ECS 或 ECI 實(shí)例數(shù)等于 MinSize。
-
如果伸縮組設(shè)置了 DesiredCapacity 時(shí),修改了 DesiredCapacity,導(dǎo)致當(dāng)前伸縮組的 ECS 或 ECI 實(shí)例數(shù)與 DesiredCapacity 不一致,則伸縮組會(huì)自動(dòng)加入或移除 ECS 實(shí)例或 ECI 實(shí)例,使得伸縮組的 ECS 或 ECI 實(shí)例數(shù)等于 DesiredCapacity。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
請(qǐng)求參數(shù)
名稱(chēng) | 類(lèi)型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ScalingGroupId | string | 是 | 待修改伸縮組的 ID。 | asg-bp1ffogfdauy0jw0**** |
ScalingGroupName | string | 否 | 伸縮組的名稱(chēng),同一地域下伸縮組名稱(chēng)唯一。長(zhǎng)度為 2~64 個(gè)字符,以數(shù)字、大小英文字母或中文開(kāi)頭,可以包含數(shù)字、下劃線(_)、短劃線(-)和半角句號(hào)(.)。 | scalinggroup**** |
MinSize | integer | 否 | 伸縮組內(nèi) ECS 實(shí)例或 ECI 實(shí)例臺(tái)數(shù)的最小值,當(dāng)伸縮組內(nèi) ECS 或 ECI 實(shí)例數(shù)小于 MinSize 時(shí),彈性伸縮會(huì)自動(dòng)創(chuàng)建 ECS 實(shí)例或 ECI 實(shí)例。 說(shuō)明
MinSize 的值必須小于或等于 MaxSize 的值。
| 1 |
MaxSize | integer | 否 | 伸縮組內(nèi) ECS 實(shí)例或 ECI 實(shí)例臺(tái)數(shù)的最大值,當(dāng)伸縮組內(nèi) ECS 或 ECI 實(shí)例數(shù)大于 MaxSize 時(shí),彈性伸縮會(huì)自動(dòng)移出 ECS 實(shí)例或 ECI 實(shí)例。 MaxSize 的取值范圍和彈性伸縮使用情況有關(guān),請(qǐng)前往配額中心查看單個(gè)伸縮組可以設(shè)置的組內(nèi)最大實(shí)例數(shù)對(duì)應(yīng)的配額值。 例如,如果單個(gè)伸縮組可以設(shè)置的組內(nèi)最大實(shí)例數(shù)對(duì)應(yīng)的配額值為 2000,則 MaxSize 的取值范圍為 0~2000。 | 99 |
DefaultCooldown | integer | 否 | 伸縮組默認(rèn)的冷卻時(shí)間,僅適用于簡(jiǎn)單規(guī)則。取值范圍:0~86400,單位:秒。 冷卻時(shí)間內(nèi),該伸縮組不執(zhí)行其他的伸縮活動(dòng),僅針對(duì)云監(jiān)控報(bào)警任務(wù)觸發(fā)的伸縮活動(dòng)有效。 | 600 |
RemovalPolicies | array | 否 | 指定移出 ECS 實(shí)例的伸縮組策略。取值范圍:
| |
string | 否 | 指定移出 ECS 實(shí)例的伸縮組策略。取值范圍:
| NewestInstance | |
ActiveScalingConfigurationId | string | 否 | 伸縮組內(nèi)生效的伸縮配置的 ID。 | asc-bp17pelvl720x5ub**** |
HealthCheckType | string | 否 | 伸縮組的健康檢查方式。取值范圍:
說(shuō)明
如果需要同時(shí)開(kāi)啟實(shí)例健康檢查和負(fù)載均衡健康檢查,請(qǐng)使用 HealthCheckTypes 參數(shù)。
| ECS |
LaunchTemplateId | string | 否 | 實(shí)例啟動(dòng)模板 ID,用于指定伸縮組從實(shí)例啟動(dòng)模板獲取啟動(dòng)配置信息。 | lt-m5e3ofjr1zn1aw7**** |
LaunchTemplateVersion | string | 否 | 實(shí)例啟動(dòng)模板的版本。取值范圍:
| Default |
OnDemandBaseCapacity | integer | 否 | 伸縮組所需要按量實(shí)例個(gè)數(shù)的最小值,取值范圍:0~1000。當(dāng)按量實(shí)例個(gè)數(shù)少于該值時(shí),將優(yōu)先創(chuàng)建按量實(shí)例。 當(dāng) | 30 |
OnDemandPercentageAboveBaseCapacity | integer | 否 | 伸縮組滿(mǎn)足最小按量實(shí)例數(shù)(OnDemandBaseCapacity)要求后,超出的實(shí)例中按量實(shí)例應(yīng)占的比例,取值范圍:0~100。 當(dāng) | 20 |
SpotInstanceRemedy | boolean | 否 | 是否開(kāi)啟補(bǔ)齊搶占式實(shí)例。開(kāi)啟后,當(dāng)收到搶占式實(shí)例將被回收的系統(tǒng)消息時(shí),伸縮組將嘗試創(chuàng)建新的實(shí)例,替換掉將被回收的搶占式實(shí)例。 | true |
CompensateWithOnDemand | boolean | 否 | 當(dāng)
| true |
SpotInstancePools | integer | 否 | 指定可用實(shí)例規(guī)格的個(gè)數(shù),伸縮組將按成本最低的多個(gè)規(guī)格均衡創(chuàng)建搶占式實(shí)例。取值范圍:0~10。 當(dāng) | 5 |
DesiredCapacity | integer | 否 | 伸縮組內(nèi) ECS 實(shí)例或 ECI 實(shí)例的期望數(shù)量,伸縮組會(huì)自動(dòng)將 ECS 實(shí)例或 ECI 實(shí)例數(shù)量維持在期望實(shí)例數(shù)。取值范圍:MaxSize≥期望實(shí)例數(shù)量≥MinSize。 說(shuō)明
如果期望實(shí)例數(shù)功能關(guān)閉后又重新開(kāi)啟,則您需要重新設(shè)置 DesiredCapacity 值。
| 5 |
GroupDeletionProtection | boolean | 否 | 是否開(kāi)啟伸縮組刪除保護(hù)。取值范圍:
| true |
MultiAZPolicy | string | 否 | 多可用區(qū)伸縮組 ECS 實(shí)例擴(kuò)縮容策略。取值范圍:
說(shuō)明
COST_OPTIMIZED 僅在伸縮配置設(shè)置了多實(shí)例規(guī)格或者選用了搶占式實(shí)例的情況下生效。
| PRIORITY |
VSwitchIds | array | 否 | 一臺(tái)或多臺(tái)虛擬交換機(jī)的 ID。 只有當(dāng)伸縮組網(wǎng)絡(luò)類(lèi)型為 VPC 時(shí),當(dāng)前參數(shù)才生效。指定虛擬交換機(jī)所屬的 VPC 必須和伸縮組所屬的 VPC 相同。 虛擬交換機(jī)可以來(lái)自多個(gè)可用區(qū)。虛擬交換機(jī)的優(yōu)先級(jí)按照數(shù)字升序排序,1 表示最高優(yōu)先級(jí)。當(dāng)優(yōu)先級(jí)較高的虛擬交換機(jī)所在可用區(qū)無(wú)法創(chuàng)建 ECS 實(shí)例時(shí),自動(dòng)選擇下一優(yōu)先級(jí)的虛擬交換機(jī)創(chuàng)建 ECS 實(shí)例。 | |
string | 否 | 一臺(tái)或多臺(tái)虛擬交換機(jī)的 ID。 只有當(dāng)伸縮組網(wǎng)絡(luò)類(lèi)型為 VPC 時(shí),當(dāng)前參數(shù)才生效。指定虛擬交換機(jī)所屬的 VPC 必須和伸縮組所屬的 VPC 相同。 虛擬交換機(jī)可以來(lái)自多個(gè)可用區(qū)。虛擬交換機(jī)的優(yōu)先級(jí)按照數(shù)字升序排序,1 表示最高優(yōu)先級(jí)。當(dāng)優(yōu)先級(jí)較高的虛擬交換機(jī)所在可用區(qū)無(wú)法創(chuàng)建 ECS 實(shí)例時(shí),自動(dòng)選擇下一優(yōu)先級(jí)的虛擬交換機(jī)創(chuàng)建 ECS 實(shí)例。 | vsw-bp1oo2a7isyrb8igf**** | |
LaunchTemplateOverrides | array<object> | 否 | 擴(kuò)展啟動(dòng)模板的實(shí)例規(guī)格信息。 | |
object | 否 | 擴(kuò)展啟動(dòng)模板的實(shí)例規(guī)格信息。 | ||
InstanceType | string | 否 | 當(dāng)您需要伸縮組按照實(shí)例規(guī)格容量進(jìn)行伸縮時(shí),請(qǐng)同時(shí)指定本參數(shù)和 LaunchTemplateOverrides.WeightedCapacity。 本參數(shù)用于指定實(shí)例規(guī)格,會(huì)覆蓋啟動(dòng)模板中的實(shí)例規(guī)格。 說(shuō)明
僅當(dāng) LaunchTemplateId 參數(shù)指定了啟動(dòng)模板時(shí),本參數(shù)生效。
InstanceType 的取值范圍:在售的 ECS 實(shí)例規(guī)格。 | ecs.c5.xlarge |
WeightedCapacity | integer | 否 | 當(dāng)您需要伸縮組按照實(shí)例規(guī)格容量進(jìn)行伸縮時(shí),在指定 LaunchTemplateOverrides.InstanceType 后,再指定本參數(shù)。兩個(gè)參數(shù)一一對(duì)應(yīng)。 本參數(shù)用于指定實(shí)例規(guī)格的權(quán)重,即實(shí)例規(guī)格的單臺(tái)實(shí)例在伸縮組中表示的容量大小。 權(quán)重越大,滿(mǎn)足期望容量所需的本實(shí)例規(guī)格的實(shí)例數(shù)量越少。 由于每個(gè)實(shí)例規(guī)格的 vCPU 個(gè)數(shù)、內(nèi)存大小等性能指標(biāo)會(huì)有差異,您可以根據(jù)自身需求,給不同的實(shí)例規(guī)格配置不同的權(quán)重。 例如:
為滿(mǎn)足期望容量,伸縮組將為用戶(hù)擴(kuò)容 2 臺(tái) ecs.c5.xlarge 實(shí)例。 說(shuō)明
擴(kuò)容時(shí)伸縮組的容量不得超過(guò)最大容量(MaxSize)與實(shí)例規(guī)格的最大權(quán)重之和。
WeightedCapacity 的取值范圍:1~500。 | 4 |
SpotPriceLimit | float | 否 | 本參數(shù)用于指定實(shí)例啟動(dòng)模板覆蓋規(guī)格(即 說(shuō)明
僅當(dāng) LaunchTemplateId 參數(shù)指定了啟動(dòng)模板時(shí),該參數(shù)才生效。
| 0.025 |
MaxInstanceLifetime | integer | 否 | 實(shí)例在伸縮組中存活的最大時(shí)間。單位為秒。 取值范圍:0 或 默認(rèn)值:null。 說(shuō)明
ECI 類(lèi)型的伸縮組或停機(jī)不收費(fèi)的伸縮組不支持設(shè)置該參數(shù)。
| null |
AzBalance | boolean | 否 | 伸縮組的容量是否在多個(gè)可用區(qū)間均衡分布(僅當(dāng)
默認(rèn)值:false。 | false |
AllocationStrategy | string | 否 | 容量分配策略,決定了伸縮組如何選擇可用的實(shí)例規(guī)格類(lèi)型滿(mǎn)足容量。容量分布策略同時(shí)對(duì)按量和搶占式容量生效(僅當(dāng) MultiAZPolicy 參數(shù)取值為 COMPOSABLE 策略時(shí)生效)。取值范圍:
默認(rèn)值:priority。 | priority |
SpotAllocationStrategy | string | 否 | 搶占式容量分布策略。您可以通過(guò)該參數(shù)單獨(dú)指定搶占式容量的分布策略(僅當(dāng)
默認(rèn)值:priority。 | lowestPrice |
CustomPolicyARN | string | 否 | 自定義縮容策略 Function 函數(shù) ARN。僅當(dāng) RemovalPolicies 配置第一個(gè)移除策略未 CustomPolicy 時(shí)生效。 | acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name |
DisableDesiredCapacity | boolean | 否 | 伸縮組是否關(guān)閉期望實(shí)例數(shù)功能。取值范圍:
說(shuō)明
只有伸縮組當(dāng)前無(wú)伸縮活動(dòng)時(shí),才能將該參數(shù)設(shè)置為 true(即關(guān)閉伸縮組的期望實(shí)例數(shù)功能),關(guān)閉伸縮組的期望實(shí)例數(shù)功能時(shí)伸縮組當(dāng)前的 DesiredCapacity 屬性也會(huì)被清空,但伸縮組中當(dāng)前的實(shí)例數(shù)量不發(fā)生變化。
| false |
ScalingPolicy | string | 否 | 指定伸縮組的回收模式。取值范圍:
ScalingPolicy 指定伸縮組的回收模式,但實(shí)例被移出伸縮組時(shí)的具體動(dòng)作,由 RemoveInstances 的 RemovePolicy 參數(shù)決定,更多信息,請(qǐng)參見(jiàn) RemoveInstances 。 | recycle |
HealthCheckTypes | array | 否 | 伸縮組的健康檢查方式。 說(shuō)明
使用此參數(shù)可以設(shè)置多個(gè)值,開(kāi)啟多個(gè)健康檢查選項(xiàng)。如果設(shè)置了 HealthCheckType 參數(shù),則本參數(shù)將被忽略。
| |
string | 否 | 伸縮組的健康檢查方式列表。取值范圍:
默認(rèn)值:ECS。 | ECS | |
StopInstanceTimeout | integer | 否 | 縮容流程中等待 ECS 實(shí)例停機(jī)成功的超時(shí)時(shí)間,單位為秒。 取值范圍:30~240。 說(shuō)明
| 60 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-10-16 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-02-22 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-02-01 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-10-18 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2022-12-22 | API 內(nèi)部配置變更,不影響調(diào)用 | 查看變更詳情 |