查詢伸縮組
更新時間 2024-03-21 17:18:32
最近更新時間: 2024-03-21 17:18:32
分享文章
查詢伸縮組列表
接口功能介紹
查詢伸縮組列表
接口約束
無
URI
POST /v4/scaling/group/list
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| groupID | 否 | Integer | 伸縮組ID | 468 | |
| projectID | 否 | String | 企業項目ID | 0 | |
| pageNo | 否 | Integer | 頁碼 | 1 | |
| page | 否 | Integer | 【Deprecated】頁碼 | 5 | |
| pageSize | 否 | Integer | 分頁查詢時設置的每頁行數,取值范圍:[1~100],默認值為10 | 1 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| numberOfAll | Integer | 伸縮組總數量 | 18 | |
| totalCount | Integer | 【Deprecated】本次查詢返回的伸縮組數量 | 1 | |
| scalingGroups | Array of Objects | 伸縮組信息列表 | scalingGroups |
表 scalingGroups
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| configID | Integer | 【Deprecated】伸縮組配置ID,僅伸縮配置數目為1時有值 | 375 | |
| configList | Array of Integer | 伸縮組配置ID列表 | [375, 263] | |
| recoveryMode | Integer | 實例回收模式。取值范圍:1: 釋放模式。 2: 停機回收模式。 | 1 | |
| regionID | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| healthPeriod | Integer | 健康檢查時間間隔(周期),單位:秒,取值范圍:[300,10080] | 300 | |
| maxCount | Integer | 最大云主機數,取值范圍:[minCount,2147483647] | 20 | |
| minCount | Integer | 最小云主機數,取值范圍:[0,50] | 1 | |
| expectedCount | Integer | 期望云主機數,取值范圍:[minCount,maxCount],非多可用區資源池不支持該參數 | 1 | |
| moveOutStrategy | Integer | 實例移出策略。取值范圍:1: 較早創建的配置較早創建的云主機。 2: 較晚創建的配置較晚創建的云主機。 3: 較早創建的云主機。 4: 較晚創建的云主機。 | 1 | |
| createDate | String | 創建時間 | 2022-10-08 22:25:54 | |
| groupID | Integer | 伸縮組ID | 468 | |
| updateDate | String | 更新時間 | 2022-10-08 22:25:54 | |
| healthMode | Integer | 健康檢查方式。取值范圍:1: 云服務器健康檢查。 2: 彈性負載均衡健康檢查。 | 1 | |
| useLb | Integer | 是否使用負載均衡,1:是 2:否 | 1 | |
| zabbixName | String | 【Deprecated】監控設備ID | scal_ca04095d2f19427095f52ba6a30b25a3_468 | |
| subnetList | Map of String | 【Deprecated】子網ID與可用區信息列表,非多可用區該值為空數組。 | [{"az1": ["subnet-7q4b66v5h5"]},{"az2": ["subnet-7q4b66v5h5"]}] | |
| subnetIDList | Array of Strings | 子網ID列表 | ["subnet-7q4b66v5h5","subnet-7q4b66v5h5"] | |
| vpcCidr | String | 虛擬私有云網段 | 192.168.0.0/16 | |
| status | Integer | 伸縮組狀態。取值范圍:1: 啟用。 2: 停用。 | 1 | |
| vpcName | String | 虛擬私有云名稱 | vpc-21a4 | |
| instanceCount | Integer | 伸縮組包含云主機數量 | 20 | |
| projectIDEcs | String | 企業項目ID | 0 | |
| configName | String | 【Deprecated】伸縮配置名稱,僅伸縮配置數目為1時有值 | as-config-e928 | |
| name | String | 伸縮組名稱 | as-group-a1ac | |
| securityGroupIDList | Array of Strings | 多可用區資源池安全組ID列表。非多可用區資源池該值為空數組,可在查詢彈性伸縮配置接口查詢。 | ["4b793e4c-0d67-5978-b23f-06e966fc45db"] | |
| vpcID | String | 虛擬私有云ID | fda71b1d-e4de-5860-81eb-77388b965da1 | |
| azStrategy | Integer | 擴容策略類型,僅多可用區資源池支持。非多可用區資源池該值為空。取值范圍:1:均衡分布。 2:優先級分布。 | 1 | |
| deleteProtection | Boolean | 是否開啟伸縮組保護。取值范圍:true:開啟伸縮組保護,此時不能刪除該伸縮組。false:關閉伸縮組保護,可刪除該伸縮組。 | true |
請求示例
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"page": 1,
"pageSize": 1
}
響應示例
{
"returnObj": {
"scalingGroups": [
{
"vpcName": "vpc-8fd8",
"zabbixName": "scal_bac_faa34bbc5d574da7aeb2db096d106bf8_540",
"subnetList": [
{
"az1": [
"subnet-9fr7iesyyp"
]
}
],
"subnetIDList":["subnet-9fr7iesyyp"],
"minCount": 0,
"expectedCount":1,
"configName": "qyj-config-test-005",
"healthPeriod": 600,
"createDate": "2022-10-14 16:32:30",
"regionID": "81f7728662dd11ec810800155d307d5b",
"configID": 459,
"projectIDEcs": "0",
"healthMode": 1,
"status": 2,
"instanceCount": 0,
"moveOutStrategy": 1,
"recoveryMode": 2,
"securityGroupIDList": [
"sg-q7v82a1m48"
],
"vpcID": "vpc-a06t51wr1h",
"maxCount": 50,
"name": "as-group-3bfc",
"useLb": 2,
"vpcCidr": "192.168.0.0/16",
"updateDate": "2022-10-24 15:35:06",
"groupID": 540,
"configList": [459],
"azStrategy": 1,
"deleteProtection": false
}
],
"numberOfAll": 19,
"totalCount": 1
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
錯誤碼
| 錯誤碼 | 描述 |
|---|---|
| Openapi.Workorder.AccessFailed | 獲取伸縮組失敗 |