接口功能介绍
查询云主机组列表或者详情
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
分页查询：当前查询结果以分页形式进行展示，单次查询最多显示50条数据
匹配查找：可以通过部分字段进行匹配筛选数据，无符合条件的为空。
接口约束
无
URI
POST /v4/ecs/affinity-group/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
| affinityGroupID | 否 | String | 云主机组ID，获取： 查 查询云主机组列表或者详情 查 查询云主机组列表或详情（旧版） 创 创建云主机组 创 创建云主机组（旧版） |
8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| queryContent | 否 | String | 模糊匹配查询内容（匹配字段：affinityGroupID、affinityGroupName） | 88cb | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| 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，获取： 查 查询云主机组列表或者详情 查 查询云主机组列表或详情（旧版） 创 创建云主机组 创 创建云主机组（旧版） |
8c66ee54-f922-75a8-1e13-af1f682f15dc | |
| affinityGroupName | String | 云主机组名称 | test | |
| affinityGroupPolicy | Object | 云主机组策略 | affinityGroupPolicy | |
| createdTime | String | 创建时间 | 2023-03-07T02:33:18Z | |
| updatedTime | String | 更新时间 | 2023-03-09T01:09:08Z | |
| deleted | Boolean | 是否删除 | false |
表 affinityGroupPolicy
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| policyType | Integer | 云主机组策略类型。 取值范围： 0（反亲和ANTI-AFFINITY）， 1（亲和AFFINITY）， 2（软反亲和SOFT-ANTI-AFFINITY）， 3（软亲和SOFT-AFFINITY) |
1 | |
| policyTypeName | String | 云主机组策略类型名称 | affinity |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1：指定每页记录数目，查询指定页云主机组列表或详情
华东1指定每页记录数目为3，查看第2页云主机组列表或详情
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"pageNo": 2,
"pageSize": 3
}
示例2：查看指定ID的云主机组详情
在华东1资源池查询某云主机组的详情
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"affinityGroupID": "c4021a5a-4a41-0035-b1f7-a5b8b6da34f9"
}
示例3：通过关键字模糊查询
查找在华东1资源池下关键字为test的云主机组信息
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"queryContent": "test"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [{
"affinityGroupID": "8c66ee54-f922-75a8-1e13-af1f682f15dc",
"affinityGroupName": "test",
"deleted": false,
"affinityGroupPolicy": {
"policyType": 1,
"policyTypeName": "affinity"
},
"createdTime": "2023-03-07T02:33:18Z",
"updatedTime": "2023-03-09T01:09:08Z"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
