接口功能介绍
可以根据用户给定的云主机与云主机组，校验当前情况下是否可以将云主机加入主机组。如果可以则返回值中needMigrate字段为0，反之则需要将云主机迁移。
接口约束
- 使用限制，本接口只支持在华东1、上海32、上海33、上海36、南宁23、南昌19、青岛20、青岛21、武汉41资源池进行公测
2. 云主机需处于运行中（running）或关机（stopped）状态
3. 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
POST /v4/ecs/affinity-group/bind-check
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 否 | String | 可用区名称。 | cn-huadong1-jsnj1A-public-ctcloud | |
| ID | 是 | String | 云主机ID | 9a1fdc59-b6a2-32bb-780f-3b00653c56f7 | |
| affinityGroupID | 是 | String | 云主机组ID | 1d9de965-3d77-25f1-f521-8d6703280406 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 成功时返回的数据 | {} | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| needMigrate | Integer | 需要迁移的次数 | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"ID": "9a1fdc59-b6a2-32bb-780f-3b00653c56f7",
"affinityGroupID": "1d9de965-3d77-25f1-f521-8d6703280406"
}
响应示例
{
"returnObj": {
"needMigrate": 0
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
