創建伸縮組
更新時間 2025-03-12 10:34:42
最近更新時間: 2025-03-12 10:34:42
分享文章
創建一個伸縮組
接口功能介紹
創建一個彈性伸縮組。
接口約束
伸縮組名稱不能重復。
URI
POST /v4/scaling/group/create
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數名 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| securityGroupIDList | 是 | Array of Strings | 安全組ID列表，非多可用區資源池不使用該參數，其安全組參數在彈性伸縮配置中填寫 | ['sg-nd1h63d2j8'] | |
| recoveryMode | 是 | Integer | 實例回收模式。取值范圍：1：釋放模式。 | 1 | |
| name | 是 | String | 伸縮組名稱 | as-group-901f | |
| healthMode | 是 | Integer | 健康檢查方式。取值范圍： 1：云主機健康檢查。2：彈性負載均衡健康檢查。 | 1 | |
| mazInfo | 否 | Array of Objects | 【Deprecated】多可用區資源池的實例可用區及子網信息。mazInfo和subnetIDList參數互斥，如果資源池為多可用區時使用mazInfo則不傳subnetIDList參數 | mazInfo | |
| subnetIDList | 否 | Array of Strings | 子網ID列表。支持一主多輔，最大支持輸入5個網卡信息，順序第一個網卡信息默認主網卡。mazInfo和subnetIDList參數互斥。 | ['a8ffac57-354b-41af-b853-53b5cded4957'] | |
| moveOutStrategy | 是 | Integer | 實例移出策略。取值范圍：1：較早創建的配置較早創建的云主機。2：較晚創建的配置較晚創建的云主機。3：較早創建的云主機。4：較晚創建的云主機。 | 1 | |
| useLb | 是 | Integer | 是否使用負載均衡。取值范圍： 1：是 。 2：否。 | 2 | |
| vpcID | 是 | String | 虛擬私有云ID | vpc-0wvmt7gh02 | |
| minCount | 是 | Integer | 最小云主機數，取值范圍：[0,50] | 0 | |
| maxCount | 是 | Integer | 最大云主機數，取值范圍：[minCount,2147483647] | 50 | |
| expectedCount | 否 | Integer | 期望云主機數，取值范圍：[minCount,maxCount]，非多可用區資源池不支持該參數 | 0 | |
| healthPeriod | 是 | Integer | 健康檢查時間間隔（周期），單位：秒，取值范圍：[300,10080] | 300 | |
| lbList | 否 | Array of Objects | 負載均衡列表，useLb=1時必填 | lbList | |
| projectID | 否 | String | 企業項目ID | 0 | |
| configID | 否 | Integer | 【Deprecated】伸縮配置ID | 375 | |
| configList | 否 | Array of Integers | 伸縮配置ID列表，最大支持傳入10個伸縮配置。按輸入伸縮配置的順序，決定伸縮配置優先級。注意：該參數與configID不可同時傳入，請盡量選擇本參數。 | [375] | |
| azStrategy | 否 | Integer | 擴容策略類型，僅多可用區資源池支持，多可用區資源池必填。取值范圍：1：均衡分布。 2：優先級分布。 | 1 |
表 mazInfo
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| masterId | 是 | String | 主網卡，子網可跨可用區 | subnet-9fr7iesyyp | |
| azName | 是 | String | 可用區名稱 | az1 | |
| optionId | 否 | Array of Strings | 擴展網卡列表 |
表 lbList
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| port | 是 | Integer | 端口號 | 2235 | |
| lbID | 是 | String | 負載均衡ID | lb-la9ik6vb5y | |
| weight | 是 | Integer | 權重 | 1 | |
| hostGroupID | 是 | String | 后端主機組ID | tg-j36kny3khn |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回碼：800表示成功，900表示失敗 | 800 | |
| errorCode | String | 業務細分碼，為product.module.code三段式碼 | Scaling.Group.NotFound | 錯誤碼 |
| message | String | 失敗時的錯誤描述，一般為英文描述 | scaling group info not found | |
| description | String | 失敗時的錯誤描述，一般為中文描述 | 未找到彈性伸縮組信息 | |
| returnObj | Object | 成功時返回的數據，參見表returnObj | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| groupID | Integer | 伸縮組ID | 489 |
請求示例
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"securityGroupIDList": [
"sg-nsgrzc3j8o"
],
"recoveryMode": 1,
"name": "as-group-3f2b1",
"healthMode": 1,
"moveOutStrategy": 1,
"useLb": 2,
"vpcID": "vpc-d9m7zwykvs",
"minCount": 0,
"maxCount": 100,
"healthPeriod": 300,
"subnetIDList":["subnet-mm1z4zbkfv","subnet-16szf88gta"],
"configList": [3881,3880],
"azStrategy": 1
}
響應示例
{
"returnObj": {
"groupID": 493
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
錯誤碼
| errorCode | 描述 |
|---|---|
| Scaling.Group.HealthModeNotSupported | 不支持該健康檢查方式 |
| Scaling.Group.RecoveryModeNotSupported | 不支持該云主機回收模式 |
| Scaling.Group.UseLbNotSupported | 不支持該方式 |
| Scaling.Group.GroupNumberMoreThanLimit | 彈性伸縮組數量超過限制 |
| Scaling.Group.GroupNameExists | 伸縮組名重復 |
| Scaling.OrderCheck.SubnetNotExists | 子網不存在 |
| Scaling.OrderCheck.VpcNotExists | 虛擬私有云不存在 |
| Openapi.Workorder.AccessFailed | 系統錯誤 |
