Help Center/ Virtual Private Cloud/ API Reference/ APIs/ VPC Tag Management/ Adding a Tag to a VPC
Updated on 2024-07-17 GMT+08:00
View PDF

Adding a Tag to a VPC

Function

This API is used to add a tag to a VPC.

URI

POST /v2.0/{project_id}/vpcs/{vpc_id}/tags

Table 1 describes the parameters.

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

vpc_id

Yes

Specifies the VPC ID that uniquely identifies the VPC.

Request Parameters

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.
  • Contain up to 128 characters (36 characters on the console).
  • Can contain letters, digits, underscores (_), and hyphens (-).
  • The tag key of a VPC must be unique.

value

String

Yes
  • Specifies the tag value.
  • Contain up to 255 characters (43 characters on the console).
  • Can contain letters, digits, underscores (_), periods (.), and hyphens (-).

Example Request

  • Create a tag for a VPC. The key is key1, and the value is value1. 
    POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags

{
    "tag": {
        "key": "key1",
        "value": "value1"
    }
}

Response Parameters

None

Example Response

None

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent topic: VPC Tag Management