接口说明
本接口用于云主机批量改名,支持不同可用区云主机批量改名,最多支持10台云主机修改名称
云主机名称,名称为5-59位数字、字母、“-”组合,且“-”不可在名称的开头或结尾
1.name不可为空
2.自动排序命名: 批量修改数量大于1时,自动加上三位数字的后缀,如:输入ECS-test,则命名为ECS-test-001、ECS-test-002
3.自定义规则命名: 按照name_prefix[begin_number,bits]name_suffix格式给实例命名,name_prefix为名称前缀,name_suffix为名称后缀,[begin_number,bits]定义名称中间的数字部分,其中begin_number的取值范围为[1,999],bits的取值范围为[1,3],'['、']'、','均为英文字符。如:实例名称输入ECS[88,3]vm,则2台的实例名称依次为ECS-088-vm、ECS-089-vm
云主机没有正在执行的任务,并且状态为ACTIVE的实例才可以进行此操作。
URL
PUT https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/batch/name
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
serverBatchNameReq
|
ServerBatchNameReq
|
是
|
批量改名请求体。 |
|
name
|
string
|
是
|
云主机名称,云主机名称应为5-60个字符,可包含英文、数字、'-','-'不能在名称的开头或末尾。 |
|
serverIds
|
<string> array
|
是
|
主机ID数组。 |
请求示例
PUT https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/batch/name
{
"serverIds":[
"000037f9-2bda-420f-b0e9-bf5514a5762d",
"00014ed8-7e91-42c3-8b6d-8878720431a9"
],
"name":"new-vm"
}
返回参数
|
参数名称
|
类型
|
描述
|
|
body
|
ServerBatchActionResp
|
请求成功时返回的数据 |
|
serverBatchResult
|
<ActionResult> array
|
云主机批量操作结果集 |
|
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 |
返回示例
{
"body":{
"serverBatchResult":[
{
"serverId":"000037f9-2bda-420f-b0e9-bf5514a5762d",
"result":true
},
{
"serverId":"00014ed8-7e91-42c3-8b6d-8878720431a9",
"result":true
}
]
},
"requestId":"req-Id-bb15dfdf-f7eb-4303-895a-cfffb13269d5",
"state":"OK"
}