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

Querying EIP Tags in a Specified Project

Function

This API is used to query all EIP tags of a tenant in a specified region.

URI

GET /v2.0/{project_id}/publicips/tags

Table 1 describes the parameters.

Table 1 Parameter description

Name

Mandatory

Description

project_id

Yes

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

Request Message

  • Request parameter

    None

  • Example request
    GET /v2.0/{project_id}/publicips/tags

Response Message

  • Response parameter
    Table 2 Response parameter

    Parameter

    Type

    Description

    tags

    Array of tag objects

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

    Table 3 Description of the tag field

    Name

    Type

    Description

    key

    String

    Specifies the tag key.

    • Cannot be left blank.
    • Contain up to 128 characters (36 characters on the console).
    • Can contain letters, digits, underscores (_), and hyphens (-).

    values

    Array of strings

    Specifies the tag value list.

    • Contain up to 255 characters (43 characters on the console).
    • Can contain letters, digits, underscores (_), periods (.), and hyphens (-).
  • Example response
    {
        "tags": [
            {
                "key": "key1",
                "values": [
                    "value1",
                    "value2"
                ]
            },
            {
                "key": "key2",
                "values": [
                    "value1",
                    "value2"
                ]
            }
        ]
    }

Status Code

See Status Codes.

Error Code

See Error Codes.