Updated on 2026-07-29 GMT+08:00

Adding Tags to a Port in Batches

Function

This API is used to add tags to a specified port in batches. This is an idempotent API. When you add tags, if there are duplicate keys in the request body, an error is reported. Duplicate keys are not allowed. If a key already exists, its value will be overwritten by the new value.

This API is available only in the CN South-Shenzhen region.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    vpc:ports:createTags

    Tagging

    port *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    • vpc:PortId

    • vpc:SubnetId

    • vpc:VpcId

    vpc:portTags:create

    -

    -

    • g:RequestTag/<tag-key>

    • g:TagKeys

URI

POST /v3/{project_id}/ports/{port_id}/tags/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

port_id

Yes

String

Definition

Port ID.

Constraints

The port with a given ID must exist.

Range

The value must be a valid UUID.

Default Value

N/A

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of ResourceTag objects

Definition

Tag list.

Constraints

A maximum of 20 tag key-value pairs are supported.

Range

N/A

Default Value

N/A

Table 3 ResourceTag

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Tag key.

Constraints

  • A tag key can contain a maximum of 128 Unicode characters and cannot be left blank.

  • Each tag key of a resource must be unique.

  • It can contain:

    • Digits

    • Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=)

    • Chinese characters

- Letters

Range

N/A

Default Value

N/A

value

Yes

String

Definition

Tag value.

Constraints

  • Each value can contain a maximum of 255 Unicode characters and can be left blank.

  • It can contain:

    • Digits

    • Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), and equal signs (=)

    • Chinese characters

- Letters

Range

N/A

Default Value

N/A

Response Parameters

Status code: 204

The response to the request is normal. For more status codes, see Status Codes.

None

Example Requests

Add two tags to a port. For one tag, the key is keyxxx and the value is value1. The key of the other tag is keyyyy, and the value is value2.

POST https://{Endpoint}/v3/{project_id}/ports/{port_id}/tags/create

{
  "tags" : [ {
    "key" : "keyxxx",
    "value" : "value1"
  }, {
    "key" : "keyyyy",
    "value" : "value2"
  } ]
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Add two tags to a port. For one tag, the key is keyxxx and the value is value1. The key of the other tag is keyyyy, and the value is value2.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.vpc.v3.region.VpcRegion;
import com.huaweicloud.sdk.vpc.v3.*;
import com.huaweicloud.sdk.vpc.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchCreatePortTagsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        VpcClient client = VpcClient.newBuilder()
                .withCredential(auth)
                .withRegion(VpcRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchCreatePortTagsRequest request = new BatchCreatePortTagsRequest();
        request.withPortId("{port_id}");
        BatchCreatePortTagsRequestBody body = new BatchCreatePortTagsRequestBody();
        List<ResourceTag> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new ResourceTag()
                .withKey("keyxxx")
                .withValue("value1")
        );
        listbodyTags.add(
            new ResourceTag()
                .withKey("keyyyy")
                .withValue("value2")
        );
        body.withTags(listbodyTags);
        request.withBody(body);
        try {
            BatchCreatePortTagsResponse response = client.batchCreatePortTags(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Add two tags to a port. For one tag, the key is keyxxx and the value is value1. The key of the other tag is keyyyy, and the value is value2.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkvpc.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = VpcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(VpcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchCreatePortTagsRequest()
        request.port_id = "{port_id}"
        listTagsbody = [
            ResourceTag(
                key="keyxxx",
                value="value1"
            ),
            ResourceTag(
                key="keyyyy",
                value="value2"
            )
        ]
        request.body = BatchCreatePortTagsRequestBody(
            tags=listTagsbody
        )
        response = client.batch_create_port_tags(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Add two tags to a port. For one tag, the key is keyxxx and the value is value1. The key of the other tag is keyyyy, and the value is value2.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := vpc.VpcClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := vpc.NewVpcClient(hcClient)

    request := &model.BatchCreatePortTagsRequest{}
	request.PortId = "{port_id}"
	var listTagsbody = []model.ResourceTag{
        {
            Key: "keyxxx",
            Value: "value1",
        },
        {
            Key: "keyyyy",
            Value: "value2",
        },
    }
	request.Body = &model.BatchCreatePortTagsRequestBody{
		Tags: listTagsbody,
	}
	response, err := client.BatchCreatePortTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

204

The response to the request is normal. For more status codes, see Status Codes.

Error Codes

See Error Codes.