更新云服务器元数据UpdateServerMetadata
功能介绍
更新 云服务器 元数据。
- 如果元数据中没有待更新字段，则自动添加该字段。
- 如果元数据中已存在待更新字段，则直接更新字段值。
- 如果元数据中的字段不在请求参数中，则保持不变
如果元数据中包含了敏感数据，您应当采取适当的措施来保护敏感数据，比如限制访问范围、加密等。
接口约束
云服务 器状态（云服务器的OS-EXT-STS:vm_state属性）必须是active，stopped，paused或者suspended。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/{project_id}/cloudservers/{server_id}/metadata
|
参数 |
是否必选 |
描述 |
|---|---|---|
|
project_id |
是 |
项目ID。 获取方法请参见获取项目ID。 |
|
server_id |
是 |
云服务器ID。 |
请求消息
|
参数 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
metadata |
是 |
Object |
用户自定义metadata键值对。 结构体允许为空，取值为空时不更新数据。 键。 最大长度255个Unicode字符，不能为空。可以为大写字母（A-Z）、小写字母（a-z）、数字（0-9）、中划线（-）、下划线（_）、冒号（:）和小数点（.）。 值。 最大长度为255个Unicode字符。 |
响应消息
|
参数 |
参数类型 |
说明 |
|---|---|---|
|
metadata |
Object |
用户自定义metadata键值对。 |
请求示例
更新云服务器的元数据为自定义的键值对。
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/metadata
{
"metadata": {
"key": "value"
}
}
响应示例
{
"metadata":{
"key":"value"
}
}
返回值
请参考通用请求返回值。
