Creating a Tag for an EIP
Function
This API is used to create a tag for an EIP.
URI
POST /v2.0/{project_id}/publicips/{publicip_id}/tags
Table 1 describes the parameters.
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 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.
Table 3 Request parameter Parameter
Type
Mandatory
Description
tag
tag object
Yes
Specifies the tag objects. For details, see Table 4.
Table 4 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 only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- 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 only the following character types:
- Uppercase letters
- Lowercase letters
- Digits
- Special characters, including hyphens (-) and underscores (_)
- Example request
POST https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags { "tag": { "key": "key1", "value": "value1" } }
Response Message
Status Code
See Status Codes.
Error Code
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.