更新时间:2025-08-19 GMT+08:00

查询ACL资源实例列表

功能介绍

使用标签过滤查询ACL实例。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

功能说明:查询记录数

取值范围:1-1000

约束:默认为1000

缺省值:1000

offset

Integer

功能说明:索引位置, 从第一条数据偏移offset条数据后开始查询

约束:默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数

缺省值:0

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

matches

Array of Match objects

功能说明:搜索字段,key为要匹配的字段,value为匹配的值

约束:key为固定字典值,不能包含重复的key或不支持的key,当前key仅支持resource_name

tags

Array of ListTag objects

包含标签,最多包含50个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失 。

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

结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。

表4 Match

参数

是否必选

参数类型

描述

key

String

键。当前仅限定为resource_name

最小长度:1

最大长度:128

value

String

值。每个值最大长度255个unicode字符.

最小长度:0

最大长度:255

表5 ListTag

参数

是否必选

参数类型

描述

key

String

功能说明:标签键

约束:key不能为空

最小长度:1

最大长度:128

values

Array of strings

功能描述:标签值列表。

如果values为空列表,则表示any_value(查询任意value)。value之间为或的关系。

最大长度:255

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

resources

Array of ListResourceResp objects

资源列表

total_count

Integer

资源数量

request_id

String

请求ID

表7 ListResourceResp

参数

参数类型

描述

resource_id

String

资源ID

resource_detail

Object

资源详情。 资源对象,用于扩展。默认为空

resource_name

String

资源名称,资源没有名称时默认为空字符串.

tags

Array of ResourceTag objects

标签列表,没有标签默认为空数组

表8 ResourceTag

参数

参数类型

描述

key

String

  • 功能说明:标签键。

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

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

最小长度:1

最大长度:128

value

String

  • 功能说明:标签值。

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

最大长度:255

请求示例

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

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

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

响应示例

状态码:200

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

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

SDK代码示例

SDK代码示例如下。

过滤查询ACL资源实例列表,用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 ListFirewallsByTagsSolution {

    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();
        ListFirewallsByTagsRequest request = new ListFirewallsByTagsRequest();
        ListFirewallsByTagsRequestBody body = new ListFirewallsByTagsRequestBody();
        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("network_aclv3_test")
        );
        body.withTags(listbodyTags);
        body.withMatches(listbodyMatches);
        request.withBody(body);
        try {
            ListFirewallsByTagsResponse response = client.listFirewallsByTags(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());
        }
    }
}

过滤查询ACL资源实例列表,用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 = ListFirewallsByTagsRequest()
        listValuesTags = [
            "value1"
        ]
        listTagsbody = [
            ListTag(
                key="key1",
                values=listValuesTags
            )
        ]
        listMatchesbody = [
            Match(
                key="resource_name",
                value="network_aclv3_test"
            )
        ]
        request.body = ListFirewallsByTagsRequestBody(
            tags=listTagsbody,
            matches=listMatchesbody
        )
        response = client.list_firewalls_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)

过滤查询ACL资源实例列表,用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
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.ListFirewallsByTagsRequest{}
	var listValuesTags = []string{
        "value1",
    }
	var listTagsbody = []model.ListTag{
        {
            Key: "key1",
            Values: listValuesTags,
        },
    }
	var listMatchesbody = []model.Match{
        {
            Key: "resource_name",
            Value: "network_aclv3_test",
        },
    }
	request.Body = &model.ListFirewallsByTagsRequestBody{
		Tags: &listTagsbody,
		Matches: &listMatchesbody,
	}
	response, err := client.ListFirewallsByTags(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

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

错误码

请参见错误码