• Elastic Volume Service

evs
  1. Help Center
  2. Elastic Volume Service
  3. API Reference
  4. OpenStack Cinder API v3
  5. EVS Snapshot
  6. Updating One Piece of Metadata for an EVS Snapshot

Updating One Piece of Metadata for an EVS Snapshot

Function

This API is used to update one piece of the EVS snapshot metadata.

URI

  • URI format

    PUT /v3/{project_id}/snapshots/{snapshot_id}/metadata/{key}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    snapshot_id

    Yes

    Specifies the snapshot ID.

    key

    Yes

    Specifies the key of the metadata that requires the update.

Request

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    meta

    map<string,string>

    Yes

    Specifies the piece of metadata that requires the update.

  • Parameter in the metadata field

    Parameter

    Type

    Mandatory

    Description

    key_val

    string

    No

    Specifies the piece of metadata, which is made up of a key-value pair.

  • Example request
    {
        "meta": {
            "key1": "value1"
        }
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    meta

    map<string, string>

    Specifies the piece of the disk snapshot metadata, which is made up of a key-value pair.

  • Example response
    {
        "meta": {
            "key1": "value1"
        }
    }

    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.