接口功能介绍
更新物理机的实例名称和描述
URI
POST /v4/ebm/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 您可以调用资源池列表查询获取最新的天翼云资源池列表 |
73f321ea-62ff-11ec-a8bc-005056898fe0 | |
| azName | 是 | String | 可用区名称，您可以查看地域和可用区来了解可用区 您可以调用资源池可用区查询 注：查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空（即为单可用区，本字段填写default） |
default | |
| displayName | 否 | String | 实例名称。displayName和description必须至少存在一个 | test-name | |
| description | 否 | String | 描述。displayName和description必须至少存在一个 | test-desc | |
| instanceUUID | 是 | String | 实例uuid | ss-9d4u1yd1jr0a3xeu59fq9svecxql |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Ebm.Update.NotValid | |
| message | String | 响应结果的描述，一般为英文描述 | error request | |
| description | String | 响应结果的描述，一般为中文描述 | 错误请求 | |
| returnObj | Object | 返回参数，值为空 | {} |
请求示例
请求头header
无
请求体body
{
"regionID":"bb9fdb42056f11eda1610242ac110002",
"azName":"az2",
"instanceUUID": "ss-9d4u1yd1jr0a3xeu59fq9svecxql",
"displayName": "test-name",
"description": "test-desc"
}
响应示例
{
"returnObj": {},
"statusCode": 800,
"errorCode": "",
"message": "SUCCESS",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Ebm.Update.NotValid | 请求参数非法 |
| Ebm.Update.NotFound | 物理机不存在 |
| Ebm.Common.CheckError | 内部错误，请重试 |
| 其他 | 参见公共错误码说明 |
