功能介紹
修改一個指定 彈性伸縮 組中的信息。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
PUT /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID |
|
scaling_group_id |
是 |
String |
伸縮組ID |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
scaling_group_name |
否 |
String |
伸縮組名稱(1-64個字符)，只能包含中文、字母、數(shù)字、下劃線或中劃線。 |
|
desire_instance_number |
否 |
Integer |
期望實例數(shù)量。 最小實例數(shù)≤期望實例數(shù)≤最大實例數(shù)。 |
|
min_instance_number |
否 |
Integer |
最小實例數(shù)量。 |
|
max_instance_number |
否 |
Integer |
最大實例數(shù)量，大于等于最小實例數(shù)。 |
|
cool_down_time |
否 |
Integer |
冷卻時間，取值范圍0-86400，默認(rèn)為300，單位是秒。 |
|
available_zones |
否 |
Array of strings |
可用區(qū)信息。彈性伸縮活動中自動添加的云服務(wù)器會被創(chuàng)建在指定的可用區(qū)中。如果沒有指定可用區(qū)，會由系統(tǒng)自動指定可用區(qū)。 詳情請參考地區(qū)和終端節(jié)點。 僅當(dāng)伸縮組中無伸縮活動時，才可以修改可用區(qū)配置。 |
|
networks |
否 |
Array of networks objects |
網(wǎng)絡(luò)信息，最多支持選擇5個子網(wǎng)，傳入的第一個子網(wǎng)默認(rèn)作為云服務(wù)器的主網(wǎng)卡。獲取子網(wǎng)信息請參考查詢子網(wǎng)列表。數(shù)據(jù)結(jié)構(gòu)信息請參考表4。 僅當(dāng)同時滿足以下條件時，才可以修改：
|
|
security_groups |
否 |
安全組信息，僅支持選擇1個安全組。獲取安全組信息請參考查詢安全組列表。數(shù)據(jù)結(jié)構(gòu)信息請參考表7。 當(dāng)伸縮配置和伸縮組同時指定安全組時，將以伸縮配置中的安全組為準(zhǔn)；當(dāng)伸縮配置和伸縮組都沒有指定安全組時，增加的彈性云服務(wù)器將使用默認(rèn)安全組。為了使用靈活性更高，推薦在伸縮配置中指定安全組。僅當(dāng)同時滿足以下條件時，才可以修改：
|
|
|
lb_listener_id |
否 |
String |
彈性負(fù)載均衡 監(jiān)聽器ID，最多支持綁定6個負(fù)載均衡監(jiān)聽器，多個負(fù)載均衡監(jiān)聽器ID以逗號分隔。獲取監(jiān)聽器ID的方法請參考查詢負(fù)載均衡器列表。 僅當(dāng)同時滿足以下條件時，才可以修改：
|
|
lbaas_listeners |
否 |
彈性負(fù)載均衡器信息，最多支持綁定6個負(fù)載均衡。列表數(shù)據(jù)結(jié)構(gòu)請參考表3。獲取負(fù)載均衡器的信息請參考查詢后端云服務(wù)器組。 |
|
|
health_periodic_audit_method |
否 |
String |
伸縮組實例健康檢查方式：ELB_AUDIT和NOVA_AUDIT。當(dāng)伸縮組設(shè)置負(fù)載均衡時，默認(rèn)為ELB_AUDIT；否則默認(rèn)為NOVA_AUDIT。
|
|
health_periodic_audit_time |
否 |
Integer |
伸縮組實例健康檢查周期（分鐘）：1、5、15、60、180。 若設(shè)置為0，可以實現(xiàn)10秒級健康檢查。 |
|
instance_terminate_policy |
否 |
String |
伸縮組實例移除策略：
|
|
health_periodic_audit_grace_period |
否 |
Integer |
伸縮組實例健康狀況檢查寬限期，取值范圍0-86400，單位是秒，默認(rèn)為600。 當(dāng)實例加入伸縮組并且進(jìn)入已啟用狀態(tài)后，健康狀況檢查寬限期才會啟動，伸縮組會等健康狀況檢查寬限期結(jié)束后才檢查實例的運行狀況。 當(dāng)伸縮組實例健康檢查方式為ELB_AUDIT時，該參數(shù)生效。 |
|
scaling_configuration_id |
否 |
String |
伸縮配置ID，通過查詢彈性伸縮配置列表接口獲取，請參考查詢彈性伸縮配置列表。 |
|
notifications |
否 |
Array of strings |
通知方式： EMAIL為發(fā)送郵件通知。 該通知方式已經(jīng)被廢除，建議給彈性伸縮組配置通知功能。請參考通知。 |
|
delete_publicip |
否 |
Boolean |
配置刪除云服務(wù)器是否刪除云服務(wù)器綁定的彈性IP。如果選擇不刪除，則系統(tǒng)僅做解綁定操作，保留彈性IP資源。
|
|
delete_volume |
否 |
Boolean |
配置刪除云服務(wù)器時是否刪除云服務(wù)器綁定的數(shù)據(jù)盤。取值為true或false，默認(rèn)為false。
|
|
enterprise_project_id |
否 |
String |
企業(yè)項目ID，用于指定伸縮組歸屬的企業(yè)項目。
當(dāng)伸縮組配置企業(yè)項目時，由該伸縮組創(chuàng)建的彈性云服務(wù)器將歸屬于該企業(yè)項目。否則將使用默認(rèn)企業(yè)項目。 說明：
關(guān)于企業(yè)項目特性的詳細(xì)信息，請參見企業(yè)項目管理。 |
|
multi_az_priority_policy |
否 |
String |
伸縮組擴縮容時目標(biāo)AZ選擇的優(yōu)先級策略：
|
|
description |
否 |
String |
伸縮組描述（1-256個字符）。 |
|
iam_agency_name |
否 |
String |
委托（1-64個字符）。
|
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
pool_id |
是 |
String |
后端云服務(wù)器組ID。 僅當(dāng)同時滿足以下條件時，才可以修改：
|
|
protocol_port |
是 |
Integer |
后端協(xié)議號，指后端云服務(wù)器監(jiān)聽的端口，取值范圍[1, 65535]。 |
|
weight |
是 |
Integer |
權(quán)重，指后端云服務(wù)器經(jīng)分發(fā)得到的請求數(shù)量的比例，取值范圍[0, 100]。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
子網(wǎng)的網(wǎng)絡(luò)ID。 |
|
ipv6_enable |
否 |
Boolean |
是否啟用IPv6。 true：標(biāo)識此網(wǎng)卡已啟用ipv6。 false：標(biāo)識此網(wǎng)卡未啟用ipv6。默認(rèn)取值為false。 |
|
ipv6_bandwidth |
否 |
ipv6_bandwidth object |
綁定的IPv6共享帶寬。默認(rèn)為空，表示未綁定IPv6的共享帶寬。 |
|
allowed_address_pairs |
否 |
Array of allowed_address_pairs objects |
是否開啟源/目的檢查開關(guān)。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
IPv6共享帶寬的ID |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
ip_address |
String |
是否開啟源/目的檢查開關(guān)。 默認(rèn)是開啟，不允許置空。
|
請求示例
PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1
{
"scaling_group_name": "group_1",
"scaling_configuration_id": "f8327883-6a07-4497-9a61-68c03e8e72a2",
"enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
"desire_instance_number": 1,
"min_instance_number": 1,
"max_instance_number": 3,
"cool_down_time": 200,
"multi_az_priority_policy": "PICK_FIRST",
"iam_agency_name":"test"
}
響應(yīng)參數(shù)
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
scaling_group_id |
String |
伸縮組ID。 |
響應(yīng)示例
{
"scaling_group_id": "a8327883-6b07-4497-9c61-68d03ee193a1"
}
返回值
- 正常
- 異常
返回值
說明
400 Bad Request
服務(wù)器未能處理請求。
401 Unauthorized
被請求的頁面需要用戶名和密碼。
403 Forbidden
對被請求的頁面訪問禁止。
404 Not Found
服務(wù)器無法找到被請求的頁面。
405 Method Not Allowed
請求中指定的方法不被允許。
406 Not Acceptable
服務(wù)器生成的響應(yīng)無法被客戶端所接受。
407 Proxy Authentication Required
用戶必須首先使用代理服務(wù)器進(jìn)行驗證，這樣請求才會被處理。
408 Request Timeout
請求超出了服務(wù)器的等待時間。
409 Conflict
由于沖突，請求無法被完成。
500 Internal Server Error
請求未完成。服務(wù)異常。
501 Not Implemented
請求未完成。服務(wù)器不支持所請求的功能。
502 Bad Gateway
請求未完成。服務(wù)器從上游服務(wù)器收到一個無效的響應(yīng)。
503 Service Unavailable
請求未完成。系統(tǒng)暫時異常。
504 Gateway Timeout
網(wǎng)關(guān)超時。
錯誤碼
請參考錯誤碼。
