• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. OpenStack Cinder API v2
  5. EVS Snapshot
  6. Updating a Piece of Metadata for an EVS Snapshot

Updating a Piece of Metadata for an EVS Snapshot

Function

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

URI

  • URI format

    PUT /v2/{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 piece of metadata to be updated.

Request

  • Parameter description

    Parameter

    Type

    Mandatory

    Description

    meta

    map<string,string>

    Yes

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

  • Parameter in the metadata field

    Parameter

    Type

    Mandatory

    Description

    key_val

    string

    No

    Specifies a 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 a piece of snapshot metadata, which is made up of a key-value pair.

    error

    string

    Specifies the error message returned when an error occurs. For details, see Parameters in the error field.

  • Parameters in the error field

    Parameter

    Type

    Description

    message

    string

    Specifies the error message returned when an error occurs.

    code

    string

    Specifies the error code returned when an error occurs.

    For details about the error code, see Error Codes.

  • 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.