接口功能介绍
查询云主机组列表或者详情
接口约束
- 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
POST /v4/ecs/affinity-group-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 否 | String | 可用区名称。 | az1 | |
| affinityGroupID | 否 | String | 云主机组ID | ce804a6b-5be0-aa29-cc32-d0471321e99d | |
| queryContent | 否 | String | 模糊匹配查询内容，可根据ID或者名称进行过滤 | aa29 | |
| pageNo | 否 | Integer | 页码，取值范围：大于等于1，默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目。 取值范围：[1~50]。 默认值为10。 |
10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| results | Array of Objects | 分页明细 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| affinityGroupID | String | 云主机组ID | c4021a5a-4a41-0035-b1f7-a5b8b6da34f9 | |
| affinityGroupName | String | 云主机组名称 | vmgroup-zzy-1031-1 | |
| affinityGroupPolicy | Object | 云主机组策略 | affinityGroupPolicy | |
| createAt | String | 创建时间 | 2022-10-31T06:11:12Z | |
| updateAt | String | 更新时间 | 2022-10-31T06:11:12Z | |
| deleted | Boolean | 是否删除 | false |
表 affinityGroupPolicy
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Integer | 云主机组策略ID | 2 | |
| name | String | 云主机组策略名称 | soft-anti-affinity |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"azName":"az1",
"pageNo":1,
"pageSize":4,
"affinityGroupID": "c4021a5a-4a41-0035-b1f7-a5b8b6da34f9"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [
{
"affinityGroupPolicy": {
"id": 2,
"name": "soft-anti-affinity"
},
"affinityGroupID": "c4021a5a-4a41-0035-b1f7-a5b8b6da34f9",
"createAt": "2022-10-31T06:11:12Z",
"deleted": false,
"updateAt": "2022-10-31T06:11:12Z",
"affinityGroupName": "vmgroup-zzy-1031-1"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
