查询云主机所在云主机组
接口功能介绍
可以根据用户给定的云主机,查询云主机所在的云主机组信息
接口约束
无
URI
GET /v4/ecs/affinity-group/details
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b | |
instanceID | 是 | String | 云主机ID | adc614e0-e838-d73f-0618-a6d51d09070a |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Param is null | |
description | String | 失败时的错误描述,一般为中文描述 | 请求为空 | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
policyTypeName | String | 云主机组策略类型名称 | affinity | |
affinityGroupName | String | 云主机组名称 | test | |
affinityGroupID | String | 云主机组ID | 8c66ee54-f922-75a8-1e13-af1f682f15dc |
请求示例
请求url
GET '.../v4/affinity-group/details?regionID=81f7728662dd11ec810800155d307d5bd&instanceID=69aac66c-78e8-e704-e6e1-311b3f40a278'
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"affinityGroupID": "8c66ee54-f922-75a8-1e13-af1f682f15dc",
"policyTypeName": "affinity",
"affinityGroupName": "test"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
错误码 | 描述 |
---|---|
Ecs.EcsCheck.NotFound | 云主机不存在 |
Openapi.PatternCheck.NotValid | 参数错误 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.Parameter.InvalidazName | 资源池中不存在该azName,请确认azName是否有效 |
Ecs.AffinityGroup.NotBound | 该云主机未绑定主机组 |