云主机组批量移除云主机
接口功能介绍
此接口提供用户实现云主机组中移除多台云主机的功能
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1. 云主机须都存在(即instanceIDs中逗号分隔的ID真实存在且与regionID相对应)
2. 云主机组须存在(即affinityGroupID真实存在且与regionID相对应)
3. 所删除的云主机须在当前云主机组中(即instanceIDs中逗号分隔的ID与affinityGroupID相关联)
4. 云主机只有在运行(running)、关机(stopped)才可执行该操作,您可以调用查询云主机列表或获取多台云主机的状态信息查询结果中的instanceStatus字段来确认当前云主机状态
URI
POST /v4/ecs/affinity-group/unbind-instances
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
instanceIDs | 是 | String | 云主机ID列表,多台使用英文逗号分割,您可以查看弹性云主机了解云主机的相关信息 获取: 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
"d5673536-6c77-8ac8-5b73-19a96fd41dca,191881cf-e766-6909-31a9-c4086b17c1dd" | |
affinityGroupID | 是 | String | 云主机组ID,获取: 查 查询云主机组列表或者详情 创 创建云主机组 |
1d9de965-3d77-25f1-f521-8d6703280406 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | ||
description | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | Object | 空值 | {} |
请求示例
请求头header
无
请求体body
{
"regionID":"81f7728662dd11ec810800155d307d5b",
"instanceIDs":"d5673536-6c77-8ac8-5b73-19a96fd41dca,191881cf-e766-6909-31a9-c4086b17c1dd",
"affinityGroupID":"3bf0de43-ef92-899f-f7a9-67d0fdf44ac2"
}
响应示例
{
"returnObj": {},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.AffinityGroup.OperateFail | 主机组删除失败 |
Ecs.Instance.NotFound | 未找到对应云主机,请确认云主机ID是否正确 |
Ecs.Instance.StatusNotValid | 云主机状态无效,请确认云主机状态是否符合操作条件 |
Ecs.AffinityGroup.NotFound | 云主机组不存在 |
Ecs.AffinityGroup.NotBound | 云主机未绑定云主机组 |
Ecs.AffinityGroup.EcsUnbind | 云主机并未处于指定的云主机组 |