功能介紹
伸縮組是具有相同應(yīng)用場(chǎng)景的實(shí)例的集合,是啟停伸縮策略和進(jìn)行伸縮活動(dòng)的基本單位。伸縮組內(nèi)定義了最大實(shí)例數(shù)、期望實(shí)例數(shù)、最小實(shí)例數(shù)、 虛擬私有云 、子網(wǎng)、 負(fù)載均衡 等信息。
- 默認(rèn)最多可以創(chuàng)建10個(gè)伸縮組。
- 如果伸縮組配置了負(fù)載均衡,在添加或移除實(shí)例時(shí),會(huì)自動(dòng)為實(shí)例綁定或解綁負(fù)載均衡監(jiān)聽(tīng)器。
- 如果伸縮組使用負(fù)載均衡健康檢查方式,伸縮組中的實(shí)例需要啟用負(fù)載均衡器的監(jiān)聽(tīng)端口才能通過(guò)健康檢查。端口啟用可在安全組中進(jìn)行配置,可參考添加安全組規(guī)則進(jìn)行操作。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
POST /autoscaling-api/v1/{project_id}/scaling_group
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
項(xiàng)目ID |
請(qǐng)求參數(shù)
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
---|---|---|---|
scaling_group_name |
是 |
String |
伸縮組名稱(chēng)(1-64個(gè)字符),只能包含中文、字母、數(shù)字、下劃線(xiàn)或中劃線(xiàn)。 |
scaling_configuration_id |
是 |
String |
伸縮配置ID,通過(guò)查詢(xún) 彈性伸縮 配置列表接口獲取,請(qǐng)參考查詢(xún)彈性伸縮配置列表。 |
desire_instance_number |
否 |
Integer |
期望實(shí)例數(shù)量,默認(rèn)值為最小實(shí)例數(shù)。 最小實(shí)例數(shù)≤期望實(shí)例數(shù)≤最大實(shí)例數(shù)。 |
min_instance_number |
否 |
Integer |
最小實(shí)例數(shù)量,默認(rèn)值為0。 |
max_instance_number |
否 |
Integer |
最大實(shí)例數(shù)量,默認(rèn)值為0。 |
cool_down_time |
否 |
Integer |
冷卻時(shí)間,取值范圍0-86400,默認(rèn)為300,單位是秒。 在每次伸縮活動(dòng)完成之后,系統(tǒng)開(kāi)始計(jì)算冷卻時(shí)間。伸縮組在冷卻時(shí)間內(nèi),會(huì)拒絕由告警策略觸發(fā)的伸縮活動(dòng),其他類(lèi)型的伸縮策略(如定時(shí)策略和周期策略)及手動(dòng)觸發(fā)的伸縮活動(dòng)不受限制。 |
lb_listener_id |
否 |
String |
彈性負(fù)載均衡 監(jiān)聽(tīng)器ID,最多支持綁定6個(gè)負(fù)載均衡監(jiān)聽(tīng)器,多個(gè)負(fù)載均衡監(jiān)聽(tīng)器ID以逗號(hào)分隔。獲取監(jiān)聽(tīng)器ID的方法請(qǐng)參考查詢(xún)負(fù)載均衡器列表。 該字段與lbaas_listeners互斥。 |
lbaas_listeners |
否 |
彈性負(fù)載均衡器信息,最多支持綁定6個(gè)負(fù)載均衡。列表數(shù)據(jù)結(jié)構(gòu)請(qǐng)參考表3。獲取負(fù)載均衡器的信息請(qǐng)參考查詢(xún)后端 云服務(wù)器 組。 該字段與lb_listener_id互斥。 |
|
available_zones |
否 |
Array of strings |
可用區(qū)信息。彈性伸縮活動(dòng)中自動(dòng)添加的云服務(wù)器會(huì)被創(chuàng)建在指定的可用區(qū)中。如果沒(méi)有指定可用區(qū),會(huì)由系統(tǒng)自動(dòng)指定可用區(qū)。詳情請(qǐng)參考地區(qū)和終端節(jié)點(diǎn)。 |
networks |
是 |
網(wǎng)絡(luò)信息,最多支持選擇5個(gè)子網(wǎng),傳入的第一個(gè)子網(wǎng)默認(rèn)作為云服務(wù)器的主網(wǎng)卡。獲取子網(wǎng)信息請(qǐng)參考查詢(xún)子網(wǎng)列表。數(shù)據(jù)結(jié)構(gòu)信息請(qǐng)參考表4。 |
|
security_groups |
否 |
安全組信息,僅支持選擇1個(gè)安全組。獲取安全組信息請(qǐng)參考查詢(xún)安全組列表。數(shù)據(jù)結(jié)構(gòu)信息請(qǐng)參考表7。 當(dāng)伸縮配置和伸縮組同時(shí)指定安全組時(shí),將以伸縮配置中的安全組為準(zhǔn);當(dāng)伸縮配置和伸縮組都沒(méi)有指定安全組時(shí),增加的彈性云服務(wù)器將使用默認(rèn)安全組。為了使用靈活性更高,推薦在伸縮配置中指定安全組。 |
|
vpc_id |
是 |
String |
虛擬 私有云 (VPC)信息,獲取VPC信息具體操作請(qǐng)參考查詢(xún)VPC列表。 |
health_periodic_audit_method |
否 |
String |
伸縮組實(shí)例健康檢查方式:ELB_AUDIT和NOVA_AUDIT。當(dāng)伸縮組設(shè)置負(fù)載均衡時(shí),默認(rèn)為ELB_AUDIT;否則默認(rèn)為NOVA_AUDIT。
|
health_periodic_audit_time |
否 |
Integer |
伸縮組實(shí)例的健康檢查周期,可設(shè)置為1、5、15、60、180(分鐘),若不設(shè)置該參數(shù),默認(rèn)為5。 若設(shè)置為0,可以實(shí)現(xiàn)10秒級(jí)健康檢查。 |
health_periodic_audit_grace_period |
否 |
Integer |
伸縮組實(shí)例健康狀況檢查寬限期,取值范圍0-86400,單位是秒,默認(rèn)為600。 當(dāng)實(shí)例加入伸縮組并且進(jìn)入已啟用狀態(tài)后,健康狀況檢查寬限期才會(huì)啟動(dòng),伸縮組會(huì)等健康狀況檢查寬限期結(jié)束后才檢查實(shí)例的運(yùn)行狀況。 當(dāng)伸縮組實(shí)例健康檢查方式為ELB_AUDIT時(shí),該參數(shù)生效。 |
instance_terminate_policy |
否 |
String |
伸縮組實(shí)例移除策略:
|
notifications |
否 |
Array of strings |
通知方式: EMAIL為發(fā)送郵件通知。 該通知方式已經(jīng)被廢除,建議給彈性伸縮組配置通知功能。請(qǐng)參考通知。 |
delete_publicip |
否 |
Boolean |
配置刪除云服務(wù)器時(shí)是否刪除云服務(wù)器綁定的彈性IP。取值為true或false,默認(rèn)為false。
|
delete_volume |
否 |
Boolean |
配置刪除云服務(wù)器時(shí)是否刪除云服務(wù)器綁定的數(shù)據(jù)盤(pán)。取值為true或false,默認(rèn)為false。
|
enterprise_project_id |
否 |
String |
企業(yè)項(xiàng)目ID,用于指定伸縮組歸屬的企業(yè)項(xiàng)目。
當(dāng)伸縮組配置企業(yè)項(xiàng)目時(shí),由該伸縮組創(chuàng)建的彈性云服務(wù)器將歸屬于該企業(yè)項(xiàng)目。否則將使用默認(rèn)企業(yè)項(xiàng)目。 說(shuō)明:
關(guān)于企業(yè)項(xiàng)目特性的詳細(xì)信息,請(qǐng)參見(jiàn)企業(yè)項(xiàng)目管理。 |
multi_az_priority_policy |
否 |
String |
伸縮組擴(kuò)縮容時(shí)目標(biāo)AZ選擇的優(yōu)先級(jí)策略:
|
description |
否 |
String |
伸縮組描述(1-256個(gè)字符)。 |
iam_agency_name |
否 |
String |
委托(1-64個(gè)字符)。
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
---|---|---|---|
pool_id |
是 |
String |
后端云服務(wù)器組ID |
protocol_port |
是 |
Integer |
后端協(xié)議號(hào),指后端云服務(wù)器監(jiān)聽(tīng)的端口,取值范圍[1, 65535]。 |
weight |
是 |
Integer |
權(quán)重,指后端云服務(wù)器經(jīng)分發(fā)得到的請(qǐng)求數(shù)量的比例,取值范圍[0, 100]。 |
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
---|---|---|---|
id |
是 |
String |
子網(wǎng)的網(wǎng)絡(luò)ID。 |
ipv6_enable |
否 |
Boolean |
是否啟用IPv6。 true:標(biāo)識(shí)此網(wǎng)卡已啟用ipv6。 false:標(biāo)識(shí)此網(wǎng)卡未啟用ipv6。默認(rèn)取值為false。 |
ipv6_bandwidth |
否 |
綁定的IPv6共享帶寬。默認(rèn)為空,表示未綁定IPv6的共享帶寬。 |
|
allowed_address_pairs |
否 |
是否開(kāi)啟源/目的檢查開(kāi)關(guān)。 |
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
---|---|---|---|
id |
是 |
String |
IPv6共享帶寬的ID |
請(qǐng)求示例
創(chuàng)建一個(gè)伸縮組,伸縮組名稱(chēng)為GroupNameTest,伸縮配置ID為47683a91-93ee-462a-a7d7-484c006f4440,虛擬私有云ID為a8327883-6b07-4497-9c61-68d03ee193a,網(wǎng)卡ID為3cd35bca-5a10-416f-8994-f79169559870,最大實(shí)例數(shù)為10,期望實(shí)例數(shù)為0,最小實(shí)例數(shù)為0,健康檢查方式為云服務(wù)器健康檢查,設(shè)置具體企業(yè)項(xiàng)目,伸縮組擴(kuò)縮容時(shí)目標(biāo)AZ選擇的優(yōu)先級(jí)策略為PICK_FIRST(選擇優(yōu)先)。
{ "scaling_group_name": "GroupNameTest", "scaling_configuration_id": "47683a91-93ee-462a-a7d7-484c006f4440", "desire_instance_number": 0, "min_instance_number": 0, "max_instance_number": 10, "health_periodic_audit_method": "NOVA_AUDIT", "vpc_id": "a8327883-6b07-4497-9c61-68d03ee193a", "available_zones": ["XXXa","XXXb"], "networks": [ { "id": "3cd35bca-5a10-416f-8994-f79169559870" } ], "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", "multi_az_priority_policy": "PICK_FIRST", "iam_agency_name":"test" }
響應(yīng)參數(shù)
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
---|---|---|
scaling_group_id |
String |
伸縮組ID。 |
響應(yīng)示例
{ "scaling_group_id": "a8327883-6b07-4497-9c61-68d03ee193a1" }
返回值
- 正常
- 異常
返回值
說(shuō)明
400 Bad Request
服務(wù)器未能處理請(qǐng)求。
401 Unauthorized
被請(qǐng)求的頁(yè)面需要用戶(hù)名和密碼。
403 Forbidden
對(duì)被請(qǐng)求的頁(yè)面訪問(wèn)禁止。
404 Not Found
服務(wù)器無(wú)法找到被請(qǐng)求的頁(yè)面。
405 Method Not Allowed
請(qǐng)求中指定的方法不被允許。
406 Not Acceptable
服務(wù)器生成的響應(yīng)無(wú)法被客戶(hù)端所接受。
407 Proxy Authentication Required
用戶(hù)必須首先使用代理服務(wù)器進(jìn)行驗(yàn)證,這樣請(qǐng)求才會(huì)被處理。
408 Request Timeout
請(qǐng)求超出了服務(wù)器的等待時(shí)間。
409 Conflict
由于沖突,請(qǐng)求無(wú)法被完成。
500 Internal Server Error
請(qǐng)求未完成。服務(wù)異常。
501 Not Implemented
請(qǐng)求未完成。服務(wù)器不支持所請(qǐng)求的功能。
502 Bad Gateway
請(qǐng)求未完成。服務(wù)器從上游服務(wù)器收到一個(gè)無(wú)效的響應(yīng)。
503 Service Unavailable
請(qǐng)求未完成。系統(tǒng)暫時(shí)異常。
504 Gateway Timeout
網(wǎng)關(guān)超時(shí)。
錯(cuò)誤碼
請(qǐng)參考錯(cuò)誤碼。
- 彈性公網(wǎng)EIP有什么優(yōu)勢(shì)_彈性公網(wǎng)IP是什么_彈性公網(wǎng)應(yīng)用場(chǎng)景
- 如何創(chuàng)建用戶(hù)并授權(quán)使用應(yīng)用運(yùn)維管理服務(wù)_AOM_用戶(hù)權(quán)限_創(chuàng)建用戶(hù)_權(quán)限
- 云服務(wù)器免費(fèi)一年_免費(fèi)好用的云服務(wù)器_免費(fèi)領(lǐng)服務(wù)器試用一年
- 彈性負(fù)載均衡ELB有什么優(yōu)勢(shì)_彈性負(fù)載均衡的工作原理_彈性負(fù)載均衡有哪些功能
- 彈性負(fù)載均衡ELB購(gòu)買(mǎi)指南_彈性負(fù)載均衡操作指南_彈性負(fù)載均衡簡(jiǎn)介