接口功能介绍
该接口提供用户创建云主机组的功能
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
用户配额：确认个人在不同资源池下资源配额，可以通过用户配额查询接口进行查询
接口约束
无
URI
POST /v4/ecs/affinity-group/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
81f7728662dd11ec810800155d307d5b | |
| affinityGroupName | 是 | String | 云主机组名称，满足以下规则：长度在1-64个字符，只能由中文、英文字母、数字、下划线_、中划线-、点.组成 | agtest-01 | |
| policyType | 否 | Integer | 云主机组策略类型。 取值范围： 0：强制反亲和性， 1：强制亲和性， 2：反亲和性， 3：亲和性， 4：电力反亲和性 注：默认值2 |
2 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| message | String | 英文描述信息 | SUCCESS | |
| description | String | 中文描述信息 | 成功 | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| affinityGroupID | String | 云主机组ID | 1d9de965-3d77-25f1-f521-8d6703280406 | |
| affinityGroupName | String | 云主机组名称 | agtest-01 | |
| affinityGroupPolicy | Object | 云主机组策略 | affinityGroupPolicy |
表 affinityGroupPolicy
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| policyType | Integer | 云主机组策略类型。 取值范围： 0：强制反亲和性， 1：强制亲和性， 2：反亲和性， 3：亲和性， 4：电力反亲和性 |
2 | |
| policyTypeName | String | 云主机组策略类型名称 取值范围： anti-affinity：强制反亲和性， affinity：强制亲和性， soft-anti-affinity：反亲和性， soft-affinity：亲和性， power-anti-affinity：电力反亲和性 |
affinity |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"affinityGroupName": "agtest-01",
"policyType": 2
}
响应示例
{
"returnObj": {
"affinityGroupID": "2c03488f-ad0d-8233-6841-ba3824119555",
"affinityGroupName": "agtest-01",
"affinityGroupPolicy": {
"policyType": 2,
"policyTypeName": "affinity"
}
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
