查询伸缩组列表
接口功能介绍
查询伸缩组列表
接口约束
无
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 | 获取伸缩组失败 |
