Querying Metadata of an EVS Snapshot
Function
This API is used to query the metadata of an EVS snapshot.
URI
- URI format
- 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.
Request
- Example request
GET https://{endpoint}/v2/{project_id}/snapshots/f9faf7df-fdc1-4093-9ef3-5cba06eef995/metadata
Response
- Parameter description
Parameter
Type
Description
metadata
Object
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
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
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" } }
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot