接口功能介绍
该接口提供用户更新云主机的部分信息的功能
目前支持更新云主机的信息为：云主机显示名称（displayName）、云主机名称（instanceName）、云主机描述信息（instanceDescription）
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
1. 确保当前请求资源池下，该云主机存在（即instanceID真实存在且与regionID相对应）
2. 云主机必须修改云主机名称（instanceName）、云主机显示名称（displayName）、云主机描述信息（instanceDescription）中的一项信息，不填任意一项或填写内容与云主机原信息完全一致时，则报错
3. 云主机只有在运行（running）才可执行该操作，您可以调用查询一台云主机详细信息或获取多台云主机的状态信息查询结果中的instanceStatus字段来确认当前云主机状态
URI
POST /v4/ecs/update-instance
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
88f8888888dd88ec888888888d888d8b | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| displayName | 否 | String | 云主机显示名称，长度为2~63个字符。 注：displayName、instanceName、instanceDescription不可全为空。 |
ecs-0003 | |
| instanceName | 否 | String | 云主机名称。不同操作系统下，云主机名称规则有差异。 Windows：长度为2-15个字符（当创建两台及两台以上的云主机时名称长度为2-10个字符），允许使用大小写字母、数字或连字符（-）。不能以连字符（-）开头或结尾，不能连续使用连字符（-），也不能仅使用数字； 其他操作系统：长度为2-64字符（当创建两台及两台以上的云主机时名称长度为2-59个字符），允许使用点（.）分隔字符成多段，每段允许使用大小写字母、数字或连字符（-），但不能连续使用点号（.）或连字符（-），不能以点号（.）或连字符（-）开头或结尾，也不能仅使用数字。 注：displayName、instanceName、instanceDescription不可全为空。 |
ecm-3300 | |
| instanceDescription | 否 | String | 云主机描述信息，限制长度为0~255个字符。 注：displayName、instanceName、instanceDescription不可全为空。 |
ecm-3300 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Openapi.PatternCheck.NotValid | |
| error | String | 错误码，为product.module.code三段式码，详见错误码说明 | Openapi.PatternCheck.NotValid | |
| message | String | 失败时的错误描述，一般为英文描述 | SUCCESS | |
| description | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| instanceID | String | 被更新名称的云主机ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| displayName | String | 更新后的云主机名称 | ecs-0003 | |
| instanceName | String | 更新后的云主机名称 | ecm-3300 | |
| instanceDescription | String | 更新后的云主机描述信息 | This is an updated description |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"instanceID": "f21aa082-ded9-a7de-4588-e0ba5274e0f3",
"displayName": "ecs-0003",
"instanceName": "ecm-3300",
"instanceDescription": "This is an updated description"
}
响应示例
{
"returnObj": {
"instanceID": "f21aa082-ded9-a7de-4588-e0ba5274e0f3",
"displayName": "ecs-0003",
"instanceName": "ecm-3300",
"instanceDescription": "This is an updated description"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
