接口功能介绍
更新云主机的部分信息
接口约束
- 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
2. 目标云主机处于运行中、关机或节省关机状态
URI
POST /v4/ecs/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID。 | 88f8888888dd88ec888888888d888d8b | |
| azName | 否 | String | 可用区名称。您可以调用资源池可用区查询，查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空(即为单可用区，本字段填写default),多可用区资源池下，必须指定可用区。 | az1 | |
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ID | String | 被更新名称的云主机ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| displayName | String | 更新后的云主机名称 | ecs-0003 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"ID": "f21aa082-ded9-a7de-4588-e0ba5274e0f3",
"displayName": "ecs-0003"
}
响应示例
{
"returnObj": {
"ID": "f21aa082-ded9-a7de-4588-e0ba5274e0f3",
"displayName": "ecs-0003"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
