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

Adding the Metadata of an EVS Snapshot

Function

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

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/snapshots/{snapshot_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.

snapshot_id

Yes

String

The snapshot 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

Map<String,String>

The metadata information to be added.

Response Parameters

Status code: 200

Table 4 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 5 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.
Table 6 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}/snapshots/{snapshot_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: Snapshot Metadata Management