Updated on 2022-01-25 GMT+08:00

Querying EIP Tags

Function

This API is used to query tags of a specified EIP.

URI

GET /v2.0/{project_id}/publicips/{publicip_id}/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.

publicip_id

Yes

Specifies the unique identifier of an EIP.

Request Message

  • Request parameter

    None

  • Example request
    GET https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/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 tag objects

    Attribute

    Type

    Description

    key

    String

    • Specifies the tag key.
    • Cannot be left blank.
    • Can contain a maximum of 36 characters.
    • The tag key of a VPC must be unique.

    value

    String

    • Specifies the tag value.
    • Can contain a maximum of 43 characters.
  • Example response
    {
        "tags": [
            {
                "key": "key1",
                "value": "value1"
            },
            {
                "key": "key2",
                "value": "value3"
            }
        ]
    }

Status Code

See Status Codes.

Error Code

See Error Codes.