Updated on 2024-05-17 GMT+08:00

Checking for Tags of a BMS (Native OpenStack API)

Function

This API is used to check whether a BMS has a specified tag.

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

URI

GET /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 key of the tag to be queried.

Constraints:

  • URL encoding is required for special characters.
  • If no tag key is specified, all tags of the BMS are displayed.

Request Parameters

None

Example Request

Checking whether a BMS (ID: 2d85af7c-cbfe-40c5-a378-4d03b42fb0e2) has a specified tag
1
GET https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/2d85af7c-cbfe-40c5-a378-4d03b42fb0e2/tags/{tag}

Example Response

If the specified tag exists, no response is returned.

If the specified tag does not exist, the response is as follows:

1
2
3
4
5
6
{
    "itemNotFound": {
        "message": "Server 2d85af7c-cbfe-40c5-a378-4d03b42fb0e2 has no tag 'abc'",
        "code": 404
    }
}

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.