接口功能介绍
该接口提供用户查询云主机所在云主机组的功能，可以根据用户给定的云主机，查询云主机所在的云主机组信息
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
确保当前请求资源池下, 云主机须存在（即instanceID真实存在且与regionID相对应））
URI
GET /v4/ecs/affinity-group/details
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
adc614e0-e838-d73f-0618-a6d51d09070a |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| 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
}
状态码
请参考 状态码
错误码
请参考 错误码
