Function

This API is used to update BMS metadata.

• If the metadata does not contain the target field, the field is automatically added to the field.
• If the metadata contains the target field, the field value is automatically updated.
• If the field in the metadata is not requested, the field value remains unchanged.

Constraints

The BMS must be in active, stopped, paused, or suspended state, which is specified by attribute OS-EXT-STS:vm_state.

URI

POST /v1/{project_id}/baremetalservers/{server_id}/metadata

Request

• Request parameters

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

  Table 2 metadata field data structure description

  Parameter	Mandatory	Type	Description
  key	Yes	String	Specifies a key-value pair. key: It contains a maximum of 255 Unicode characters which can be letters, digits, hyphens (-), underscores (_), colons (:), and periods (.). key cannot be left blank. value: It contains a maximum of 255 Unicode characters.

• Example request

  1	POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/metadata

  1 2 3 4 5

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

Response

• Response parameters

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

  Table 3 metadata field data structure description

  Parameter	Mandatory	Type	Description
  key	Yes	String	Specifies a key-value pair. key: It contains a maximum of 255 Unicode characters which can be letters, digits, hyphens (-), underscores (_), colons (:), and periods (.). key cannot be left blank. value: It contains a maximum of 255 Unicode 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.