Help Center/ Elastic Volume Service/ API Reference/ OpenStack Cinder API v2/ EVS Snapshot/ Deleting One Piece of Metadata for an EVS Snapshot
Updated on 2022-11-02 GMT+08:00

Deleting One Piece of Metadata for an EVS Snapshot

Function

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

URI

  • URI format

    DELETE /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    snapshot_id

    Yes

    Specifies the snapshot ID.

    key

    Yes

    Specifies the key of the piece of metadata to be deleted.

Request

  • Example request
    DELETE https://{endpoint}/v2/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995/metadata/value1

Response

  • Parameter description

    Parameter

    Type

    Description

    error

    Object

    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

    The error message returned if an error occurs.

    code

    String

    The error code returned if an error occurs.

    For details about the error code, see Error Codes.

  • Example response

    None

    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:

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

Status Codes

  • Normal

    200

Error Codes

For details, see Error Codes.