Help Center> Elastic IP> API Reference> APIs> EIP Tag Management> Creating a Tag for an EIP
View PDF

Creating a Tag for an EIP

Function

This API is used to create a tag for an EIP.

Currently, this type of API is available only in regions CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, and CN Southwest-Guiyang1.

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

    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.

Parent topic: EIP Tag Management