Help Center> Elastic IP > API Reference> APIs> EIP Tag Management> Querying EIP Tags in a Specified Project
Updated on 2023-03-17 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
    Table 2 Request header parameter

    Parameter

    Mandatory

    Type

    Description

    X-Auth-Token

    Yes

    String

    Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

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

Response Message

  • Response parameter
    Table 3 Response parameter

    Parameter

    Type

    Description

    tags

    Array of tag objects

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

    Table 4 Description of the tag field

    Name

    Type

    Description

    key

    String

    Specifies the tag key.

    • Cannot be left blank.
    • Can contain a maximum of 36 characters.
    • Can contain only the following character types:
      • Uppercase letters
      • Lowercase letters
      • Digits
      • Special characters, including hyphens (-) and underscores (_)

    values

    Array of strings

    Specifies the tag value list.

    • Can contain a maximum of 43 characters.
    • Can contain only the following character types:
      • Uppercase letters
      • Lowercase letters
      • Digits
      • Special characters, including hyphens (-) and underscores (_)
  • Example response
    {
        "tags": [
            {
                "key": "key1",
                "values": [
                    "value1",
                    "value2"
                ]
            },
            {
                "key": "key2",
                "values": [
                    "value1",
                    "value2"
                ]
            }
        ]
    }

Status Code

See Status Codes.

Error Code

See Error Codes.