Modifying Specified BMS Metadata (Native OpenStack API)

Function

This API is used to modify specified BMS metadata.

Constraints

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

URI

PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key}

Table 1 lists the parameters.

Request Message

• Request parameters

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

  Table 2 meta 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	PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd/metadata/{key}

  1 2 3 4 5

  { "meta": { "key": "value" } }

Response Message

• Response parameters

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

  Table 3 meta field data structure description

  Parameter	Type	Description
  User-defined field key and value pair	String	Specifies the user-defined metadata key and value pair. The maximum size for each metadata key and value pair is 255 bytes.

• Example response

  1 2 3 4 5

  { "meta": { "key": "value" } }

Returned Values

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.