文档首页/ 云硬盘 EVS/ API参考/ 历史API/ Cinder API/ 云硬盘元数据管理/ 添加云硬盘的元数据
更新时间：2024-09-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

添加云硬盘的元数据

功能介绍

添加云硬盘的元数据。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/volumes/{volume_id}/metadata

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。 获取方法请参见"获取项目ID"。

volume_id

是

String

云硬盘ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

metadata

是

Metadata object

需要更新的元数据信息，请参见metadata参数说明。

metadata中的key和value长度不大于255个字节。
表4 Metadata

参数

是否必选

参数类型

描述

__system__encrypted

否

String

metadata中的表示加密功能的字段。 0代表不加密。 1代表加密。 该字段不存在时，云硬盘默认为不加密

__system__cmkid

否

String

metadata中的加密cmkid字段，与__system__encrypted配合表示需要加密，cmkid长度固定为36个字节。

hw:passthrough

否

String

metadata中的表示云硬盘设备类型的字段。 true表示云硬盘的设备类型为SCSI类型，即允许ECS操作系统直接访问底层存储介质。支持SCSI锁命令。 false表示云硬盘的设备类型为VBD类型，即为默认类型，VBD只能支持简单的SCSI读写命令。 该字段不存在时，云硬盘默认为VBD类型

full_clone

否

String

从快照创建云硬盘时，字段的值为0表示使用link克隆方式

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

metadata

Map<String,String>

键值对，云硬盘快照的元数据信息。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error

Error object

出现错误时，返回的错误信息。
表7 Error

参数

参数类型

描述

code

String

出现错误时，返回的错误码。

错误码和其对应的含义请参考错误码说明。

message

String

出现错误时，返回的错误消息。

请求示例

POST https://{endpoint}/v3/{project_id}/volumes/{volume_id}/metadata

{
  "metadata" : {
    "key1" : "value1",
    "key2" : "value2"
  }
}

响应示例

状态码： 200

OK

{
  "metadata" : {
    "key1" : "value1",
    "key2" : "value2"
  }
}

状态码： 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 云硬盘元数据管理

相关文档