接口说明
本接口用于批量操作同一可用区下云主机关机,一次最多关机50台云主机(RAM用户一次最多10台),云主机在运行中状态才能做此操作,如果云主机存在状态为创建中、重启中、规格变更中、业务暂停、重装镜像中、密钥对更新中、云硬盘挂载中、云硬盘卸载中等中间状态,不支持此操作。
URL
PUT https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/batch/stop
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
serverBatchReq
|
ServerBatchReq
|
是
|
云主机批量关机请求体。 |
|
serverIds
|
<string> array
|
是
|
主机ID组成的数组,可通过主机列表详情接口获取。 |
请求示例
PUT https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/batch/stop
{
"serverIds":[
"6a67d90c-4dc1-444f-8c18-c1eb97a1536e",
"928eddf3-00eb-4c09-aaea-anld3b513d4f"
]
}
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
ServerBatchActionResp
|
请求成功时返回的数据 |
|
serverBatchResult
|
<ActionResult> array
|
云主机批量操作结果集 |
|
message
|
string
|
操作结果信息,失败时返回错误信息,成功时返回success |
|
result
|
boolean
|
操作是否下发成功 |
|
serverId
|
string
|
云主机ID |
|
errorCode
|
string
|
统一错误码 |
|
errorMessage
|
string
|
页面国际化错误提示 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数 |
|
requestId
|
string
|
每个请求的序列号 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN |
返回示例
返回码:200
OK
{
"requestId":"reqId-****-8e359238-7",
"state":"OK",
"body":{
"serverBatchResult":[
{
"serverId":"fa42141d-eb0d-4915-bef0-****",
"result":true,
"message":"success"
},
{
"serverId":"928eddf3-00eb-4c09-aaea-****",
"result":true,
"message":"success"
}
]
}
}