• Elastic Volume Service

evs
  1. Help Center
  2. Elastic Volume Service
  3. API Reference
  4. OpenStack Cinder API v2
  5. EVS Snapshot
  6. Adding Metadata of an EVS Snapshot

Adding Metadata of an EVS Snapshot

Function

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

URI

  • URI format

    POST /v2/{project_id}/snapshots/{snapshot_id}/metadata

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    snapshot_id

    Yes

    Specifies the snapshot ID.

Request

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    metadata

    map<string, string>

    Yes

    Specifies the metadata information to be added.

  • Parameter in the metadata field

    Parameter

    Type

    Mandatory

    Description

    key_val

    string

    No

    Specifies the metadata information, which is made up of one or multiple key-value pairs.

  • Example request
    {
        "metadata": {
            "key1": "value1", 
            "key2": "value2"
        }
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    metadata

    map<string, string>

    Specifies the disk snapshot metadata, which is made up of key-value pairs.

  • Example response
    {
        "metadata": {
            "key1": "value1", 
            "key2": "value2"
        }
    }

    or

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

    In the preceding example, error indicates a general error, for example, badRequest or itemNotFound. An example is provided as follows:

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

Returned Values

  • Normal

    200

Error Codes

For details, see Error Codes.