接口功能介绍
创建云主机组
接口约束
- 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
URI
POST /v4/ecs/affinity-group-create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以调用regionID查看最新的天翼云资源池列表 | 81f7728662dd11ec810800155d307d5b | |
| azName | 否 | String | 可用区名称。您可以调用获取资源池信息，查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空(即为单可用区，本字段填写default)。 | cn-huadong1-jsnj1A-public-ctcloud | |
| affinityGroupName | 是 | String | 云主机组名称，满足以下规则：长度在1-64个字符，只能由中文、英文字母、数字、下划线_、中划线-、点.组成 | vmgroup-01 | |
| policyID | 是 | Integer | 云主机亲组策略ID。 取值范围： 0：反亲和（ANTI-AFFINITY）。 1：亲和（AFFINITY）。 2：软反亲和（SOFT-ANTI-AFFINITY）。 3：软亲和（SOFT-AFFINITY)。 |
2 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Array of Objects | 云主机组列表 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| affinityGroupID | String | 云主机组ID | e0d96324-4b03-aa95-aec4-e21959bcd2e2 | |
| affinityGroupName | String | 云主机组名称 | ag-test01 | |
| affinityGroupPolicy | Object | 云主机组策略 | affinityGroupPolicy |
表 affinityGroupPolicy
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Integer | 云主机组策略ID， 范围： 0：反亲和。 1：亲和。 2：软反亲和。 3：软亲和 |
2 | |
| name | String | 云主机组策略名称 | soft-anti-affinity |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"affinityGroupName": "ag-test01",
"policyID": 2
}
响应示例
{
"returnObj": {
"results": [{
"affinityGroupPolicy": {
"id": 2,
"name": "soft-anti-affinity"
},
"affinityGroupID": "e0d96324-4b03-aa95-aec4-e21959bcd2e2",
"affinityGroupName": "ag-test01"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
