查询云主机所在云主机组
接口功能介绍
可以根据用户给定的云主机,查询云主机所在的云主机组信息
接口约束
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
URI
POST /v4/ecs/affinity-group-get
请求参数
请求头header参数
无
请求体body参数
参数 | 类型 | 是否必填 | 描述 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | String | 是 | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b | |
azName | String | 否 | 可用区名称。您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default)。 | az1 | |
ID | String | 是 | 云主机ID | 9a1fdc59-b6a2-32bb-780f-3b00653c56f7 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败)。默认值 800。 | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明。 | ||
message | String | 失败时的错误描述,一般为英文描述。 | Param is null | |
description | String | 失败时的错误描述,一般为中文描述。 | 请求为空 | |
returnObj | Object | 返回参数。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
policy | String | 云主机组策略 | soft-anti-affinity | |
name | String | 云主机组名称 | vmgroup-zzy-905 | |
id | String | 云主机组ID | 1d9de965-3d77-25f1-f521-8d6703280406 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"ID": "9a1fdc59-b6a2-32bb-780f-3b00653c56f7"
}
响应示例
{
"returnObj": {
"policy": "soft-anti-affinity",
"name": "vmgroup-zzy-905",
"id": "1d9de965-3d77-25f1-f521-8d6703280406"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
Ecs.Instance.NotFound | 未找到对应云主机,请确认云主机ID是否正确 |
Openapi.PatternCheck.NotValid | 请求参数无效。 |
Ecs.Parameter.InvalidAzName | 请求参数错误: 资源池中不存在该azName。 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Openapi.EcsWorkorder.AccessFailed | 查询云主机所在主机组的信息失败,请重试。如果多次尝试失败,请提交工单 |