添加云主机到群组

接口说明

本接口用于添加云主机到群组中。


推荐使用API Explorer调试

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

URL

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

请求参数

Body

参数名称
类型
必填
描述
serverGroupMoveReq
主机组移动请求参数
是

serverGroupMoveReq

dryRun
boolean
否

dryrun:添加资源到群组预检参数。
true:发送检查请求,不会进行添加操作。如果检查不通过,则返回对应错误。如果检查通过,则返回预检通过。
false(默认): 发送正常请求,通过检查后直接添加资源到群组。

groupId
string
是

云主机群组ID。

region
string
是

可用区。

serverId
string
是

主机ID。

请求示例

POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/serverGroup/add
{
	"body":{
		"groupId":"4ed219c8-4ef6-4d41-8711-d04651cafdf0",
		"region":"S0592-FJ-XMTA01",
		"serverId":"7aacfc06-31b8-4273-8277-7aadd63e60f1"
	}
}

返回参数

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

请求成功时返回的数据。

createdBy
string

创建人用户ID。

createdTime
string(date-time)

群组创建时间。

customed
boolean

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

customerId
string

客户ID。

groupId
string

群组ID。

groupName
string

云主机群组名称。

modifiedBy
string

修改人用户ID。

modifiedTime
string(date-time)

群组修改时间。

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

云主机组策略。anti-affinity:反亲和,affinity:亲和,soft-anti-affinity:弱反亲和,soft-affinity:弱亲和。

quotaQuantity
integer

最大配额数量。

region
string

可用区。

serverCount
integer(int64)

云主机数量。

errorCode
string

统一错误码。

errorMessage
string

页面国际化错误提示。

errorParams
<string> array

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

requestId
string

每个请求的序列号。

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

返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。

返回示例

返回码:200
OK
{
	"body":{
		"createdBy":"userId",
		"createdTime":"",
		"customed":"false",
		"customerId":"customerId",
		"groupId":"groupId",
		"groupName":"groupName",
		"modifiedBy":"userId",
		"modifiedTime":"",
		"policy":"anti-affinity",
		"quotaQuantity":"10",
		"region":"region",
		"serverCount":"1"
	},
	"requestId":"requestId",
	"state":"OK"
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。