Updated on 2025-11-10 GMT+08:00

Adding a Tag to a Port

Function

This API is used to add a tag to a specified port. 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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

port_id

Yes

String

The unique ID of a port. The value is a string in UUID format. The port with a given ID must exist.

project_id

Yes

String

Project ID.

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

tag

Yes

ResourceTag object

Request body for adding tags to a network ACL.

Table 3 ResourceTag

Parameter

Mandatory

Type

Description

key

Yes

String

  • Tag key

  • Tag keys must be unique for each resource.

  • The value can contain 1 to 128 characters.

Minimum: 1

Maximum: 128

value

Yes

String

  • Tag value.

  • The value can contain no more than 255 characters

Maximum: 255

Response Parameters

Status code: 204

Normal request response.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

  • Definition: Request ID.

  • Range: None

error_msg

String

  • Definition: Error message.

  • Range: None

error_code

String

  • Definition: Error code.

  • Range: None

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

  • Definition: Request ID.

  • Range: None

error_msg

String

  • Definition: Error message.

  • Range: None

error_code

String

  • Definition: Error code.

  • Range: None

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

request_id

String

  • Definition: Request ID.

  • Range: None

error_msg

String

  • Definition: Error message.

  • Range: None

error_code

String

  • Definition: Error code.

  • Range: None

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

request_id

String

  • Definition: Request ID.

  • Range: None

error_msg

String

  • Definition: Error message.

  • Range: None

error_code

String

  • Definition: Error code.

  • Range: None

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

request_id

String

  • Definition: Request ID.

  • Range: None

error_msg

String

  • Definition: Error message.

  • Range: None

error_code

String

  • Definition: Error code.

  • Range: None

Example Requests

Add a tag to a port. Set the tag key to key4 and tag value to value4.

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

{
  "tag" : {
    "key" : "key4",
    "value" : "value4"
  }
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Add a tag to a port. Set the tag key to key4 and tag value to value4.

 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
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.*;


public class CreatePortTagSolution {

    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();
        CreatePortTagRequest request = new CreatePortTagRequest();
        request.withPortId("{port_id}");
        CreatePortTagRequestBody body = new CreatePortTagRequestBody();
        ResourceTag tagbody = new ResourceTag();
        tagbody.withKey("key4")
            .withValue("value4");
        body.withTag(tagbody);
        request.withBody(body);
        try {
            CreatePortTagResponse response = client.createPortTag(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 a tag to a port. Set the tag key to key4 and tag value to value4.

 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
# 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 = CreatePortTagRequest()
        request.port_id = "{port_id}"
        tagbody = ResourceTag(
            key="key4",
            value="value4"
        )
        request.body = CreatePortTagRequestBody(
            tag=tagbody
        )
        response = client.create_port_tag(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 a tag to a port. Set the tag key to key4 and tag value to value4.

 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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := vpc.NewVpcClient(
        vpc.VpcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreatePortTagRequest{}
	request.PortId = "{port_id}"
	tagbody := &model.ResourceTag{
		Key: "key4",
		Value: "value4",
	}
	request.Body = &model.CreatePortTagRequestBody{
		Tag: tagbody,
	}
	response, err := client.CreatePortTag(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

Normal request response.

400

Invalid parameter.

401

Authentication failure.

403

Insufficient permissions.

404

Not found.

500

System exception.

Error Codes

See Error Codes.