Updated on 2024-04-15 GMT+08:00

Querying Project Tags

Function

Projects are used to group and isolate OpenStack resources, which include computing, storage, and network resources. A project can be a department or a team. Multiple projects can be created for the same account.

This API is used to query all tags used by a user in a specified project.

URI

GET /v1/{project_id}/cloudservers/tags

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

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

Request

None

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

tags

Array of objects

Specifies the tag list. For details, see Table 3.

Table 3 tag field description

Parameter

Type

Description

key

String

Specifies the tag key.

  • Contains a maximum of 36 Unicode characters.

values

Array of strings

Specifies the tag value.

  • Contains a maximum of 43 Unicode characters.
  • Can be left blank.

Example Request

Query all tags used in a specified project.

GET https://{endpoint}/v1/{project_id}/cloudservers/tags

Example Response

{
      "tags": [
        {
            "key": "key1",
            "values": [
                "value1",
                "value2"
            ]
        },
        {
            "key": "key2",
            "values": [
                "value1",
                "value2"
            ]
        }
    ]
}

Error Codes

See Error Codes.