查询云主机组列表或者详情
接口功能介绍
查询云主机组列表或者详情
接口约束
无
URI
POST /v4/ecs/affinity-group/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b | |
affinityGroupID | 否 | String | 云主机组ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
queryContent | 否 | String | 查询内容(可是id或者name)、模糊匹配 | 88cb | |
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 | 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 |
请求示例
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"pageNo":1,
"pageSize":4,
"affinityGroupID": "c4021a5a-4a41-0035-b1f7-a5b8b6da34f9"
}
响应示例
{
"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
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
错误码 | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Openapi.VmGroupWorkOrder.AccessFailed | 云主机组获取失败 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.AffinityGroup.QueryFail | 未找到云主机组信息 |