Help Center/ Bare Metal Server/ API Reference/ Native OpenStack Nova V2.1 APIs/ BMS 1D Tag Management/ Adding a Tag for a BMS (Native OpenStack API)
Updated on 2024-05-17 GMT+08:00
View PDF

Adding a Tag for a BMS (Native OpenStack API)

Function

This API is used to add a tag for 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.
  • The tag contains a maximum of 80 characters.
  • The tag cannot start with a period (.).
  • An empty tag cannot be created.

It is recommended that you add the __type_baremetal tag to BMSs to distinguish BMSs from ECSs.

URI

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

Table 1 lists the parameters.

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

server_id

Yes

Specifies the BMS ID.

You can obtain the BMS ID from the BMS console or by calling the Querying BMSs (Native OpenStack API).

tag

Yes

Specifies the tag information.

Constraints:

  • The tag contains a maximum of 80 characters.
  • The tag cannot start with a period (.).
  • An empty tag cannot be created.
  • URL encoding is required for special characters.

Request Parameters

None

Example Request

Adding a tag for a BMS (ID: 53206ed0-56de-4d6b-b7ee-ffc62ca26f43) 
1
 
PUT https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/53206ed0-56de-4d6b-b7ee-ffc62ca26f43/tags/{tag}

Response

N/A

Returned Values

Normal values

Returned Values

Description

204

The server has processed the request but did not return any content.

For details about other returned values, see Status Codes.

Error Codes

See Error Codes.

Parent topic: BMS 1D Tag Management