创建云主机群组

接口说明

本接口用于创建云主机群组。实例群组相关信息可参考:云主机群组管理查看。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/serverGroup/create

请求参数

Body

参数名称
类型
必填
描述
serverGroupCreateReq
主机组创建请求参数
是

创建云主机群组请求体。

groupName
string
是

云主机群组名,名称为5~26位英文、‘-’、数字的组合,‘-’不能在名称开头和末尾。

policy
enum(anti-affinity,affinity,soft-anti-affinity,soft-affinity)
否

云主机群组策略,目前只支持强反亲和策略anti-affinity和弱反亲和策略soft-anti-affinity。
策略说明: 强反亲和策略anti-affinity:强反亲和策略强制将一组云主机分布在不同物理服务器上,确保业务的高可用性。 弱反亲和策略soft-anti-affinity:弱反亲和策略将一组云主机尽量分散创建在不同物理服务器上,以提升业务的高可用性。

region
string
是

可用区。

请求示例

POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/serverGroup/create
{
	"groupName":"grouptest",
	"policy":"anti-affinity",
	"region":"region-one"
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
创建主机组详情

请求成功时返回的数据。

createdBy
string

创建人用户ID。

createdTime
string(date-time)

群组创建时间。

customerId
string

客户ID。

customized
boolean

云主机群组是否为客户自创。

groupId
string

群组ID。

groupName
string

群组名称。

region
string

可用区。

errorCode
string

统一错误码。

errorMessage
string

页面国际化错误提示。

errorParams
<string> array

统一错误码的自定义参数。

requestId
string

每个请求的序列号。

state
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)

返回状态码。

返回示例

返回码:200
OK
{
	"requestId":"reqId-***",
	"state":"OK",
	"body":{
		"groupId":"d36aaa1c-***",
		"groupName":"test-api",
		"customerId":"CIDC-A-***",
		"createdBy":"CIDC-U-***",
		"createdTime":"2024-10-17 15:54:19",
		"region":"region-one",
		"customized":true
	}
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。