# 查询网络ACL列表 - ListFirewall #### 功能介绍 当您的网络ACL创建成功后，您可以通过调用该接口查询所有网络ACL信息，包括网络ACL的名称、状态等。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-vpc/vpc_api00_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpc/vpc_permission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpc:firewalls:list | List | firewall \* | - | - | - | | vpc:firewalls:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v3/{project_id}/vpc/firewalls 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 网络ACL所属的项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html)。 **取值范围**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**： 每页返回的资源个数。 **取值范围**： 0\~2000。 | | marker | 否 | String | **参数解释**： 分页查询起始的资源ID，为空时查询第一页。 **取值范围**： 网络ACL的资源ID。 | | id | 否 | Array of strings | **参数解释**： 网络ACL的资源ID，填写后按照ID进行过滤，支持传入多个ID过滤。 **取值范围**： 不涉及。 | | name | 否 | Array of strings | **参数解释**： 网络ACL的名称，填写后按照名称进行过滤，支持传入多个名称过滤。 **取值范围**： 不涉及。 | | status | 否 | String | **参数解释**： 网络ACL的状态，表示是否已绑定至子网，填写后按照状态进行过滤。 **取值范围**： - ACTIVE：过滤出已绑定子网的网络ACL。 - INACTIVE：过滤出未绑定子网的网络ACL。 | | admin_state_up | 否 | Boolean | **参数解释**： 网络ACL的管理状态，表示网络ACL处于启用还是停用状态，填写后按照管理状态进行过滤。 **取值范围**： - true：过滤出开启状态的网络ACL。 - false：过滤出关闭状态的网络ACL。 | | enterprise_project_id | 否 | Array of strings | **参数解释**： 网络ACL所属的企业项目ID，可以使用该字段过滤某个企业项目下的网络ACL。 **约束限制**: 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。 **取值范围**： - 0：表示默认企业项目。 - all_granted_eps：查询当前用户所有企业项目绑定的网络ACL。 - 某个具体的企业项目ID：表示查询的指定企业项目下的网络ACL。 | | type | 否 | String | **参数解释**： 网络ACL支持关联的子网类型，填写后按照支持关联子网类型进行过滤。 **取值范围**： - normal：过滤出支持关联普通子网的网络ACL。 - CloudDCN：过滤出支持关联CloudDCN子网的网络ACL。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | firewalls | Array of [ListFirewallDetail] objects | **参数解释**： 查询网络ACL列表的响应体、 **取值范围**： 不涉及。 | | page_info | [PageInfo] object | **参数解释**： 分页信息。 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。 | 表4ListFirewallDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 网络ACL的资源ID。网络ACL创建成功后，会生成一个网络ACL ID，是网络ACL对应的唯一标识。 **取值范围**： 带"-"的标准UUID格式。 | | name | String | **参数解释**： 网络ACL的名称。 **取值范围**： 1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。 | | description | String | **参数解释**： 网络ACL的描述信息。 **取值范围**： 0-255个字符，不能包含"\<"和"\>"。 | | project_id | String | **参数解释**： 网络ACL所属的项目ID。 **取值范围**： 不涉及。 | | created_at | String | **参数解释**： 网络ACL的创建时间，系统自动生成。 **取值范围**： UTC时间格式，yyyy-MM-ddTHH:mm:ssZ。 | | updated_at | String | **参数解释**： 网络ACL的最近一次更新的时间，系统自动生成。 **取值范围**： UTC时间格式，yyyy-MM-ddTHH:mm:ssZ。 | | admin_state_up | Boolean | **参数解释**： 网络ACL的管理状态。 **取值范围**： - true：表示网络ACL处于开启状态。 - false：表示网络ACL处于关闭状态。 | | status | String | **参数解释**： 网络ACL的状态。 **取值范围**： - ACTIVE：表示网络ACL已绑定子网。 - INACTIVE：表示网络ACL未绑定子网。 | | enterprise_project_id | String | **参数解释**： 网络ACL所属的企业项目ID。 **取值范围**： 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 | | tags | Array of [ResponseTag] objects | **参数解释**： 网络ACL的标签信息，包括标签键和标签值，可用来分类和标识资源。详情请参见Tag对象。 **取值范围**： 不涉及。 | | associations | Array of [FirewallAssociation] objects | **参数解释**： 网络ACL绑定的子网列表。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 网络ACL支持绑定的子网类型。 **取值范围**： - normal：默认值，表示网络ACL支持绑定普通子网。 - CloudDCN：表示网络ACL支持绑定CloudDCN子网。 | 表5ResponseTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签键。 **取值范围**： - 最大长度128个unicode字符， key不能为空。 - 同一资源的key不能重复。 - 可以包含的字符范围： - 英文字母 - 数字 - 特殊字符：下划线（_）、点（.）、冒号（:）、加号（+）、中划线（-）、等号（=） - 中文字符 | | value | String | **参数解释**： 标签值。 **取值范围**： - 每个值最大长度255个unicode字符，value可以为空。 - 可以包含的字符范围： - 英文字母 - 数字 - 特殊字符：下划线（_）、点（.）、冒号（:）、加号（+）、中划线（-）、等号（=） - 中文字符 | 表6FirewallAssociation | 参数 | 参数类型 | 描述 | |:---|:---|:---| | virsubnet_id | String | **参数解释**： 网络ACL绑定的子网ID。 **取值范围**： - 网络ACL的type为normal时，只支持绑定普通子网； - 网络ACL的type为CloudDCN时，只支持绑定CloudDCN子网。 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | **参数解释**： 当前页的第一条记录。 **取值范围**： 不涉及。 | | current_count | Integer | **参数解释**： 当前页的资源总数。 **取值范围**： 不涉及。 | | next_marker | String | **参数解释**： 当前页的最后一条记录，最后一页时无next_marker字段。 **取值范围**： 不涉及。 | #### 请求示例 查询网络ACL列表。 ``` GET https://{Endpoint}/v3/{project_id}/vpc/firewalls ``` #### 响应示例 **状态码：200** GET操作正常返回，更多状态码请参见[状态码](https://support.huaweicloud.com/api-vpc/vpc_api_0002.html)。 ``` { "request_id" : "3cd93a6a027838846e21475084ed9562", "firewalls" : [ { "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_test1", "description" : "network_acl_test1", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "created_at" : "2022-04-07T07:30:46Z", "updated_at" : "2022-04-07T07:30:46Z", "admin_state_up" : true, "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9", "status" : "ACTIVE", "tags" : [ ], "type" : "normal", "associations" : [ { "virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143" } ] } ], "page_info" : { "previous_marker" : "e9a7731d-5bd9-4250-a524-b9a076fd5629", "current_count" : 1 } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ListFirewallSolution { 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("")) .build(); ListFirewallRequest request = new ListFirewallRequest(); try { ListFirewallResponse response = client.listFirewall(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ListFirewallRequest() response = client.list_firewall(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := vpc.NewVpcClient(hcClient) request := &model.ListFirewallRequest{} response, err := client.ListFirewall(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/VPC/sdk?api=ListFirewall&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | GET操作正常返回，更多状态码请参见[状态码](https://support.huaweicloud.com/api-vpc/vpc_api_0002.html)。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-vpc/vpc_api_0003.html)。