Updating BMS Metadata (Native OpenStack API)

Function

This API is used to update BMS metadata.

Constraints

The BMS OS-EXT-STS:vm_state attribute (BMS status) must be active, stopped, paused, or suspended.

URI

POST /v2.1/{project_id}/servers/{server_id}/metadata

Table 1 lists the parameters.

Request Message

• Request parameters

  Parameter	Mandatory	Type	Description
  metadata	Yes	Object	Specifies the user-defined metadata key and value pair. For details, see Table 2.

  Table 2 metadata field data structure description

  Parameter	Mandatory	Type	Description
  User-defined field key and value pair	Yes	String	Specifies the user-defined metadata key and value pair. The maximum size for each metadata key and value pair is 255 bytes. The key does not support the following special characters: :`~!@#$%^&*()=+<,>?/'";{[]}|\ The value does not support the following special characters: \"

• Example request

  1	POST https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata

  1 2 3 4 5

  { "metadata": { "key": "value" } }

Response Message

• Response parameters

  Parameter	Type	Description
  metadata	Object	Specifies the user-defined metadata key and value pair. For details, see Table 3.

  Table 3 metadata field data structure description

  Parameter	Type	Description
  User-defined field key and value pair	String	Specifies the key and value pair of the metadata. The maximum size for each metadata key and value pair is 255 bytes. The value does not support the following special characters: \"

• Example response

  1 2 3 4 5

  { "metadata": { "key": "value" } }

Returned Values

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.