更新时间:2025-10-09 GMT+08:00
分享

查询端口资源标签

功能介绍

查询指定端口的标签信息。

该接口在华南-深圳上线。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/ports/{port_id}/tags

表1 路径参数

参数

是否必选

参数类型

描述

port_id

String

功能说明:端口唯一标识

取值范围:合法UUID

约束:ID对应的端口必须存在

project_id

String

项目ID。

获取方式请参见获取项目ID

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

tags

Array of ResourceTag objects

tag对象列表

request_id

String

请求ID

表3 ResourceTag

参数

参数类型

描述

key

String

  • 功能说明:标签键。

  • 约束:同一资源的key值不能重复。

  • 取值范围:1-128个字符。

最小长度:1

最大长度:128

value

String

  • 功能说明:标签值。

  • 取值范围:0-255个字符。

最大长度:255

状态码:400

表4 响应Body参数

参数

参数类型

描述

request_id

String

  • 参数解释:请求ID。

  • 取值范围:无

error_msg

String

  • 参数解释:错误消息。

  • 取值范围:无

error_code

String

  • 参数解释:错误码。

  • 取值范围:无

状态码:401

表5 响应Body参数

参数

参数类型

描述

request_id

String

  • 参数解释:请求ID。

  • 取值范围:无

error_msg

String

  • 参数解释:错误消息。

  • 取值范围:无

error_code

String

  • 参数解释:错误码。

  • 取值范围:无

状态码:403

表6 响应Body参数

参数

参数类型

描述

request_id

String

  • 参数解释:请求ID。

  • 取值范围:无

error_msg

String

  • 参数解释:错误消息。

  • 取值范围:无

error_code

String

  • 参数解释:错误码。

  • 取值范围:无

状态码:404

表7 响应Body参数

参数

参数类型

描述

request_id

String

  • 参数解释:请求ID。

  • 取值范围:无

error_msg

String

  • 参数解释:错误消息。

  • 取值范围:无

error_code

String

  • 参数解释:错误码。

  • 取值范围:无

状态码:500

表8 响应Body参数

参数

参数类型

描述

request_id

String

  • 参数解释:请求ID。

  • 取值范围:无

error_msg

String

  • 参数解释:错误消息。

  • 取值范围:无

error_code

String

  • 参数解释:错误码。

  • 取值范围:无

请求示例

查询端口资源标签。

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

响应示例

状态码:200

GET操作正常返回。

{
  "request_id" : "95cedc2b-4b3d-4e5c-af29-74576daf5513",
  "tags" : [ {
    "key" : "key5",
    "value" : "value5"
  }, {
    "key" : "key1",
    "value" : "value1"
  } ]
}

SDK代码示例

SDK代码示例如下。

 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
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 ShowPortTagsSolution {

    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();
        ShowPortTagsRequest request = new ShowPortTagsRequest();
        request.withPortId("{port_id}");
        try {
            ShowPortTagsResponse response = client.showPortTags(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());
        }
    }
}
 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
# 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 = ShowPortTagsRequest()
        request.port_id = "{port_id}"
        response = client.show_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)
 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
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.ShowPortTagsRequest{}
	request.PortId = "{port_id}"
	response, err := client.ShowPortTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

GET操作正常返回。

400

参数非法。

401

鉴权失败。

403

权限不足。

404

资源未找到。

500

系统异常。

错误码

请参见错误码

相关文档