Adding Tags to a BMS (Native OpenStack API)

Function

This API is used to add tags to a BMS.

You are required to use the HTTP header X-OpenStack-Nova-API-Version: 2.26 to specify the micro version on the client.

Constraints

A BMS can have a maximum of 50 tags.

• It is recommended that you add the __type_baremetal tag to BMSs to distinguish BMSs from ECSs. Otherwise, BMSs will be available only on the ECS console.
• A new tag will overwrite the existing one. If you want to retain the original tag, add it to the list of new tags. You are advised to add __type_baremetal to the added tags list each time you add a tag.

URI

PUT /v2.1/{project_id}/servers/{server_id}/tags

Table 1 lists the parameters.

Request Message

• Request parameters

  Parameter	Mandatory	Type	Description
  tags	Yes	Array of strings	Specifies the tags of a BMS. Each tag can contain a maximum of 80 characters. The tag cannot start with a period (.). A BMS can have a maximum of 50 tags. An empty tag cannot be created.

• Example request

  1	PUT https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags

  1 2 3 4 5 6 7

  { "tags": [ "baz", "foo", "qux" ] }

Response Message

• Response parameters

  Parameter	Type	Description
  tags	Array of strings	Specifies user-defined tags of a BMS.

• Example response

  1 2 3 4 5 6 7

  { "tags": [ "baz", "foo", "qux" ] }

Returned Values

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.