接口功能介绍
该接口提供用户更新云主机组的部分信息的功能
当前支持更新云主机组的信息：云主机组名称（affinityGroupName）
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
1. 确保当前请求资源池下，该云主机组存在（即affinityGroupID真实存在且与regionID相对应）
2. 云主机组修改前后其affinityGroupName须不一致
URI
POST /v4/ecs/affinity-group-update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
| affinityGroupID | 是 | String | 云主机组ID，获取： 查 查询云主机组列表或者详情 查 查询云主机组列表或详情（旧版） 创 创建云主机组 创 创建云主机组（旧版） |
8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| affinityGroupName | 是 | String | 云主机组名称，长度在1-64个字符，只能由中文、英文字母、数字、下划线_、中划线-、点.组成 | update-02 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| affinityGroupID | String | 云主机组ID，获取： 查 查询云主机组列表或者详情 查 查询云主机组列表或详情（旧版） 创 创建云主机组 创 创建云主机组（旧版） |
ce804a6b-5be0-aa29-cc32-d0471321e99d |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"affinityGroupID": "d0bfd23a-xxxxx-34570f30072e",
"affinityGroupName": "name"
}
响应示例
{
"returnObj": {
"affinityGroupID": "d0bfd23a-xxxxx-34570f30072e"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
