更新多台云主机的部分信息
接口功能介绍
更新多台云主机的部分信息。
接口约束
- 当前页面接口为旧版 API,未来根据实际使用情况可能退役,推荐使用新版本接口,新版本接口更加规范,覆盖场景更全。
- 目标云主机处于运行中、关机或节省关机状态
URI
POST /v4/ecs/batch-update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表。 | 88f8888888dd88ec888888888d888d8b | |
azName | 否 | String | 可用区名称,您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default),多可用区资源池下,必须指定可用区。 | az1 | |
updateInfo | 是 | Array of Objects | 批量更新信息 | updateInfo |
表 updateInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
ID | 是 | String | 云主机ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
displayName | 是 | String | 云主机名称,长度为2~63个字符 | ecs-0003 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
updateInfo | Array of Objects | 被更新云主机信息 | updateInfo |
表 updateInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
ID | 是 | String | 云主机ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
displayName | 是 | String | 云主机名称 | ecs-0003 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"updateInfo": [{
"ID": "f21aa082-ded9-a7de-4588-e0ba5274e0f3",
"displayName": "ecs-0003"
}, {
"ID": "5ae83d07-0389-22fd-def8-995090ee3d5a",
"displayName": "ecm-0001"
}]
}
响应示例
{
"returnObj": {
"updateInfo": [{
"ID": "f21aa082-ded9-a7de-4588-e0ba5274e0f3",
"displayName": "ecs-0003"
}, {
"ID": "5ae83d07-0389-22fd-def8-995090ee3d5a",
"displayName": "ecm-0001"
}]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Ecs.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Ecs.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Ecs.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Ecs.Parameter.InvalidAzName | 资源池中不存在该azName,请确认azName是否有效 |
Ecs.Instance.NotFound | 未找到对应云主机,请确认云主机ID是否正确 |
Ecs.Instance.NameNoChange | 名称没有发生变化,请确认输入的名称信息是否有效 |
Ecs.Instance.NameNotValid | 云主机名称不合法,长度为2~63个字符。请确认输入的名称信息是否有效 |
Ecs.Instance.StatusNotValid | 当前云主机状态不可进行操作,请确认云主机状态 |
Openapi.EcsWorkOrder.AccessFailed | 查询云主机信息失败,请重试。如果多次尝试失败,请提交工单 |