zhangyue f3b09e5d2f Elastic Volume Service API V1

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>

2023-02-02 16:28:20 +00:00

9.5 KiB

Raw Permalink Blame History

Querying One Piece of Metadata for an EVS Snapshot

Function

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

URI

URI format
GET /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 piece of metadata to be queried.

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

Request

Example request

GET https://{endpoint}/v3/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995/metadata/value1

Response

Parameter description

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

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

{
    "meta": {
        "key1": "value1"
    }
}

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

Status Codes

Normal
200

Parent topic: EVS Snapshot

9.5 KiB Raw Permalink Blame History