Help Center/ Elastic Volume Service/ API Reference/ Out-of-Date APIs/ Cinder API/ Disk Metadata Management/ Adding Metadata of an EVS Disk
Updated on 2024-02-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Adding Metadata of an EVS Disk

Function

This API is used to add the metadata of an EVS disk.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

volume_id

Yes

String

The disk ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

metadata

Yes

Metadata object

The metadata to be updated. For details, see Parameter in the metadata field.

key or value under metadata can contain no more than 255 bytes.
Table 4 Metadata

Parameter

Mandatory

Type

Description

__system__encrypted

No

String

The encryption field in metadata. 0: no encryption 1: encryption If this parameter does not appear, the disk is not encrypted.

__system__cmkid

No

String

The encryption CMK ID in metadata. This parameter is used together with __system__encrypted for encryption. The length of cmkid is fixed at 36 bytes.

hw:passthrough

No

String

The parameter that describes the disk device type in metadata.

  • If this parameter value is true, the disk device type is SCSI, which allows ECS OSs to directly access the underlying storage media and supports SCSI reservation commands.

  • If this parameter value is false, the disk device type is VBD, which supports only simple SCSI read/write commands.

  • If this parameter does not appear, the disk device type is VBD.

full_clone

No

String

The clone method. When the disk is created from a snapshot, value 0 indicates the linked cloning method.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

metadata

Map<String,String>

The snapshot metadata, which is made up of key-value pairs.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.
Table 7 Error

Parameter

Type

Description

code

String

The error code returned if an error occurs.

For details about error codes and their meanings, see Error Codes.

message

String

The error message returned if an error occurs.

Example Requests

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

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

Example Responses

Status code: 200

OK

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

Status code: 400

Bad Request

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: Disk Metadata Management