Updating One Piece of Metadata for an EVS Snapshot

Function

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

URI

• URI format

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

Request

• Request parameters

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

• Example request

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

Response

• Response parameters

  Parameter	Type	Description
  meta	Object	A piece of snapshot metadata, which is made up of a key-value pair.
  error	Object	The error message returned if 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

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

  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.