• Bare Metal Server

bms
  1. Help Center
  2. Bare Metal Server
  3. API Reference
  4. API
  5. BMS 1D Tag Management (Native OpenStack APIs)
  6. Adding Tags to a BMS (Native OpenStack API)

Adding Tags to a BMS (Native OpenStack API)

Function

This interface 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.
NOTE:
  • 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.

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

server_id

Yes

Specifies the BMS ID.

Request Message

  • Request parameters

    Parameter

    Type

    Mandatory

    Description

    tags

    list <string>

    Yes

    • 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
    {
        "tags": [
            "baz",
            "foo",
            "qux"
        ]
    }

Response Message

  • Response parameters

    Parameter

    Type

    Description

    tags

    list <String>

    Specifies user-defined tags of a BMS.

  • Example response
    {
        "tags": [
            "baz",
            "foo",
            "qux"
        ]
    }

Returned Values

See section Common Returned Values.