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

Adding a Tag to an EIP

Function

This API is used to add a tag to an EIP.

URI

POST /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
    Table 2 Request parameter

    Parameter

    Type

    Mandatory

    Description

    tag

    tag object

    Yes

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

    Table 3 tag objects

    Attribute

    Type

    Mandatory

    Description

    key

    String

    Yes

    • Specifies the tag key.
    • Cannot be left blank.
    • Can contain a maximum of 36 characters.
    • Can contain letters, digits, underscores (_), and hyphens (-).
    • The tag key of a VPC must be unique.

    value

    String

    Yes

    • Specifies the tag value.
    • Can contain a maximum of 43 characters.
    • Can contain letters, digits, underscores (_), periods (.), and hyphens (-).
  • Example request
    POST https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags
    
    {
        "tag": {
            "key": "key1",
            "value": "value1"
        }
    }

Response Message

  • Response parameter

    None

  • Example response

    None

    Or

    {
           "code":"xxx",
           "message":"xxxxx"
    }

Status Code

See Status Codes.

Error Code

See Error Codes.