1)接口功能介绍
修改虚机名字。
2)接口约束
nodeCode边缘池id需要正确,可通过查看区域集群编码列表接口获取。
3)URI
POST /v1/updateCustomName。
Query参数
4)请求参数
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 否 | String | 边缘池id,可通过查看区域集群编码列表接口获取。 | cn-guangzhou3 | |
id | 是 | String | 虚拟机id | evm-xxxxxxx | |
customName | 是 | String | 新实例名,支持字母、数字、中文、下划线、中划线、点 | evm-abcd |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | Object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | 虚拟机id | evm-xxxxx |
6)请求示例
请求体body
{
"nodeCode": "yn-lincang-1",
"id": "evm-cak5246i15hsf1l75o0g",
"customName": "evm-czy-test-001"
}
7)响应示例
{
"data": {
"id": "evm-*******"
},
"requestId": "fee43733-4607-4eed-b9aa-0ef23b3593f8",
"status": {
"code": "Success",
"message": "Success"
}
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |