• Native OpenStack API

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

Querying Metadata of an EVS Snapshot

Function

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

URI

  • URI format

    GET /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

None

Response

  • Parameter description

    Parameter

    Type

    Description

    metadata

    map<string, string>

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

    If metadata contains the __system__enableActive field, the snapshot is automatically created during the backup of a server.

    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
    {
        "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.