接口功能介绍
为云主机更新元数据：
如果元数据中没有待更新字段，则自动添加该字段
如果元数据中已存在待更新字段，则直接更新字段值
如果元数据中的字段不在请求参数中，则保持不变
如果isForce为true则覆盖原有的元数据信息
元数据的使用参考云主机自定义元数据
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项
在云主机绑定委托情况下，注意委托对应的元数据键，不要覆盖更新，尤其慎用isForce参数
接口约束
1. 确保当前请求资源池下，该云主机存在（即instanceID真实存在且与regionID相对应）
2. 云主机只有在运行（running）、关机（stopped）才可执行该操作，您可以调用查询一台云主机详细信息或获取多台云主机的状态信息查询结果中的instanceStatus字段来确认当前云主机状态
3. 云主机存在元数据才能进行更新
URI
POST /v4/ecs/metadata/update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| instanceID | 是 | String | 云主机ID，您可以查看弹性云主机了解云主机的相关信息 获取： 查 查询云主机列表 创 创建一台按量付费或包年包月的云主机 创 批量创建按量付费或包年包月云主机 |
8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| metadata | 是 | Map of String | 元数据信息，用户自定义metadata键值对。 | ||
| isForce | 否 | Boolean | 是否覆盖原有的元数据信息。缺省为不覆盖，新增元数据信息 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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 | b67b7f1f-095b-1249-b379-8dd5cc542a05 | |
| metadata | Map of String | 元数据信息 | {"ctyun": "123"} |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：更新一条云主机元数据，其中键名为"ctyun"，键值为"123"
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"instanceID": "93366056-b08f-4b9b-8e47-c50d92f2d4fd",
"azName": "cn-huadong1-jsnj1A-public-ctcloud",
"metadata": {"ctyun": "123"}
}
响应示例
{
"returnObj": {
"instanceID": "93366056-b08f-4b9b-8e47-c50d92f2d4fd",
"metadata": {
"ctyun": "123"
}
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
