文档首页/ 虚拟私有云 VPC/ API参考/ API V3/ 端口资源标签管理/ 查询端口资源实例列表 - ListPortsByTags
更新时间:2026-07-15 GMT+08:00
分享

查询端口资源实例列表 - ListPortsByTags

功能介绍

使用标签过滤查询端口。

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

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    vpc:ports:listTags

    List

    port *

    -

    vpc:portTags:get

    -

URI

POST /v3/{project_id}/ports/resource-instances/filter

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

查询记录数。

约束限制

不涉及。

取值范围

1-1000

默认取值

1000

offset

Integer

参数解释

索引位置,从第一条数据偏移offset条数据后开始查询。

约束限制

必须为数字,不能为负数。

取值范围

不涉及。

默认取值

默认为0(偏移0条数据,表示从第一条数据开始查询)。

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

matches

Array of Match objects

参数解释

搜索字段,key为要匹配的字段,value为匹配的值。

约束限制

  • key为字典值,取值范围固定有限。

  • 不能包含重复的key或不支持的key。

  • 当前key仅支持取resource_name这个值。

取值范围

不涉及。

默认取值

不涉及。

tags

Array of ListTag objects

参数解释

包含标签。结果返回包含所有标签的资源列表,无tag过滤条件时返回全量数据。

约束限制

  • key之间是与的关系,key-value结构中value是或的关系。

  • 最多包含50个key,每个key下面的value最多10个。

  • 每个key对应的value可以为空数组但结构体不能缺失。

  • Key不能重复,同一个key中values不能重复。

取值范围

不涉及。

默认取值

不涉及。

表4 Match

参数

是否必选

参数类型

描述

key

String

参数解释

标签键。

约束限制

当前仅支持取resource_name这个值。

取值范围

  • 最大长度128个unicode字符, key不能为空。

  • 同一资源的key不能重复。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

    • 中文字符

默认取值

不涉及。

value

String

参数解释

标签值。

约束限制

不涉及。

取值范围

  • 每个值最大长度255个unicode字符,value可以为空。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

    • 中文字符

默认取值

不涉及。

表5 ListTag

参数

是否必选

参数类型

描述

key

String

参数解释

标签键。

约束限制

不涉及。

取值范围

  • 最大长度128个unicode字符, key不能为空。

  • 同一资源的key不能重复。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

    • 中文字符

默认取值

不涉及。

values

Array of strings

参数解释

标签值列表。

约束限制

value之间为或的关系。

取值范围

如果values为空列表,则表示any_value(查询任意value)。

默认取值

不涉及。

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

resources

Array of ListResourceResp objects

参数解释

资源列表。

取值范围

不涉及。

total_count

Integer

参数解释

资源数量。

取值范围

不涉及。

request_id

String

参数解释

请求ID。

取值范围

不涉及。

表7 ListResourceResp

参数

参数类型

描述

resource_id

String

资源ID

resource_detail

String

参数解释

资源详情。

取值范围

不涉及。

resource_name

String

参数解释

资源名称。

取值范围

不涉及。

tags

Array of ResourceTag objects

参数解释

标签列表。

取值范围

不涉及。

表8 ResourceTag

参数

参数类型

描述

key

String

参数解释

标签键。

约束限制

  • 最大长度128个unicode字符, key不能为空。

  • 同一资源的key不能重复。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

    • 中文字符

取值范围

不涉及。

默认取值

不涉及。

value

String

参数解释

标签值。

约束限制

  • 每个值最大长度255个unicode字符,value可以为空。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

    • 中文字符

取值范围

不涉及。

默认取值

不涉及。

请求示例

过滤查询端口资源实例列表,用tags和matches过滤,限制返回100条数据,从第1条数据开始查询。

https://{Endpoint}/v3/{project_id}/ports/resource-instances/filter?limit=100&offset=0

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1" ]
  } ],
  "matches" : [ {
    "key" : "resource_name",
    "value" : "portv3_test"
  } ]
}

响应示例

状态码:200

请求正常返回,更多状态码请参见状态码

{
  "resources" : [ {
    "resource_id" : "55046c0b-f38e-4bc4-988a-06529b34a7db",
    "resource_detail" : "",
    "resource_name" : "portv3_test",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value2"
    } ]
  }, {
    "resource_id" : "1828c600-793d-4570-987b-ac59f3ef0734",
    "resource_detail" : "",
    "resource_name" : "portv3_test",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key5",
      "value" : "value5"
    } ]
  } ],
  "request_id" : "2d9cef8c-4e17-40bc-9111-f3fc97b97294",
  "total_count" : 2
}

SDK代码示例

SDK代码示例如下。

过滤查询端口资源实例列表,用tags和matches过滤,限制返回100条数据,从第1条数据开始查询。

 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
65
66
67
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 ListPortsByTagsSolution {

    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();
        ListPortsByTagsRequest request = new ListPortsByTagsRequest();
        ListPortsByTagsRequestBody body = new ListPortsByTagsRequestBody();
        List<String> listTagsValues = new ArrayList<>();
        listTagsValues.add("value1");
        List<ListTag> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new ListTag()
                .withKey("key1")
                .withValues(listTagsValues)
        );
        List<Match> listbodyMatches = new ArrayList<>();
        listbodyMatches.add(
            new Match()
                .withKey("resource_name")
                .withValue("portv3_test")
        );
        body.withTags(listbodyTags);
        body.withMatches(listbodyMatches);
        request.withBody(body);
        try {
            ListPortsByTagsResponse response = client.listPortsByTags(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());
        }
    }
}

过滤查询端口资源实例列表,用tags和matches过滤,限制返回100条数据,从第1条数据开始查询。

 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
# 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 = ListPortsByTagsRequest()
        listValuesTags = [
            "value1"
        ]
        listTagsbody = [
            ListTag(
                key="key1",
                values=listValuesTags
            )
        ]
        listMatchesbody = [
            Match(
                key="resource_name",
                value="portv3_test"
            )
        ]
        request.body = ListPortsByTagsRequestBody(
            tags=listTagsbody,
            matches=listMatchesbody
        )
        response = client.list_ports_by_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)

过滤查询端口资源实例列表,用tags和matches过滤,限制返回100条数据,从第1条数据开始查询。

 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
65
66
67
68
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.ListPortsByTagsRequest{}
	var listValuesTags = []string{
        "value1",
    }
	var listTagsbody = []model.ListTag{
        {
            Key: "key1",
            Values: listValuesTags,
        },
    }
	var listMatchesbody = []model.Match{
        {
            Key: "resource_name",
            Value: "portv3_test",
        },
    }
	request.Body = &model.ListPortsByTagsRequestBody{
		Tags: &listTagsbody,
		Matches: &listMatchesbody,
	}
	response, err := client.ListPortsByTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求正常返回,更多状态码请参见状态码

错误码

请参见错误码

相关文档