doc-exports/docs/evs/api-ref/evs_04_3065.html

Updating Metadata of an EVS Snapshot

Function

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

URI

• URI format

  PUT /v3/{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

• Parameter description

  Parameter	Type	Mandatory	Description
  metadata	Object	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 the metadata information, which is made up of one or multiple key-value pairs.

• Example request

  {
      "metadata": {
          "key1": "value1", 
          "key2": "value2"
      }
  }

Response

• Parameter description

  Parameter	Type	Description
  metadata	Object	Specifies the snapshot metadata, which is made up of key-value pairs.
  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"
      }
  }

Status Codes

• Normal

  200

Error Codes

For details, see Error Codes.

Parent topic: EVS Snapshot