接口功能介绍
为云主机更新元数据
接口约束
- 当前页面接口为旧版 API，未来根据实际使用情况可能退役，推荐使用新版本接口，新版本接口更加规范，覆盖场景更全。
2. 云主机需处于运行中（running）或关机（stopped）状态
3. 在云主机绑定委托情况下，注意委托对应的元数据键，不要覆盖更新，尤其慎用isForce参数
URI
POST /v4/ecs/metadata-update
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以调用regionID查看最新的天翼云资源池列表。 | 88f8888888dd88ec888888888d888d8b | |
| ID | 是 | String | 云主机ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa | |
| metadata | 是 | Map of String | 元数据信息 | ||
| isForce | 否 | Boolean | 是否覆盖原有的元数据信息，缺省为不覆盖 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误信息 | ||
| description | String | 失败时的错误描述 | ||
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ID | String | 云主机ID | 93366056-b08f-4b9b-8e47-c50d92f2d4fd | |
| metadata | Map of String | 数据信息 | {"ctyun": "hello world"} |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "a6449feab4db11e9a6b40242ac110007",
"ID": "93366056-b08f-4b9b-8e47-c50d92f2d4fd",
"azName": "az2",
"metadata": {"ctyun": "hello world"}
}
响应示例
{
"returnObj": {
"ID": "93366056-b08f-4b9b-8e47-c50d92f2d4fd",
"metadata": {
"ctyun": "hello world"
}
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
