# 查询防火墙配额信息 - ShowConfigQuota #### 功能介绍 查询防火墙配额信息 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cfw/cfw_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cfw/cfw_02_0018.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v2/{project_id}/cfw/{fw_instance_id}/quota 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html) **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | | fw_instance_id | 是 | String | **参数解释**： 防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过[防火墙ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0028.html)获取 **约束限制**： 不涉及 **取值范围**： 36位UUID **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | config_type | 是 | String | **参数解释**： 防火墙配额类型 **约束限制**： 不涉及 **取值范围**： ACL：ACL规则配额 DNS_DOMAIN_SET：网络域名组配额 DOMAIN：域名组域名成员配额 DOMAIN_DEVICE：域名设备配额 DNS_DOMAIN_SET_PARSE_IP：网络域名组解析IP配额 APPLICATION_DOMAIN_SET：应用域名组配额 APPLICATION_DOMAIN_SET_ITEM：应用域名组域名成员配额 APPLICATION_DOMAIN_SET_ITEM_DEVICE：应用域名组设备配额 ADDR_SET：地址组配额 ADDR_SET_ITEM：地址组IP地址成员配额 ADDR_SET_ITEM_DEVICE：地址组IP地址设备配额 SERV_SET：服务组配额 SERV_SET_ITEM：服务组服务成员配额 SERV_SET_ITEM_DEVICE：服务组服务设备配额 BLACKLIST：黑名单配额 WHITELIST：白名单配额 PRIVATE_NETWORK_SEGMENT：私网网段配额 **默认取值**： 不涉及 | | set_id | 否 | String | **参数解释**： 组Id，查询IP地址组地址成员配额，域名组域名成员配额，服务组服务成员配额时必传，地址组id，可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得，域名组id，可通过查询域名组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得，服务组id，可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [ShowConfigQuotaDto] object | | 表4ShowConfigQuotaDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | item_info | [ItemInfo] object | **参数解释**： 防火墙配额信息 **取值范围**： 不涉及 | | max_quota | Integer | **参数解释**： 防火墙成员最大配额 **取值范围**： 不涉及 | | quota_type | String | **参数解释**： 防火墙成员配额类型 **取值范围**： 不涉及 | | used_quota | Integer | **参数解释**： 已使用配额 **取值范围**： 不涉及 | 表5ItemInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | max_quota | Integer | **参数解释**： 最大配额 **取值范围**： 不涉及 | | used_quota | Integer | **参数解释**： 已使用配额 **取值范围**： 不涉及 | | extras_info | Map\ | **参数解释**： 额外参数，ACL和网络域名使用 **取值范围**： 不涉及 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码 **取值范围**： 不涉及 | | error_msg | String | **参数解释**： 错误描述 **取值范围**： 不涉及 | #### 请求示例 查询项目ID为eb7accd78ea845078275b2ad5280a109防火墙ID为8a996d43-75bd-48b4-b1b8-de0706b72b8f的防火墙配额信息，类型为ACL ``` https://{Endpoint}/v2/5de88e3e18124fa99675fb51ceceaa31/cfw/8a996d43-75bd-48b4-b1b8-de0706b72b8f/quota?config_type=ACL ``` #### 响应示例 **状态码：200** OK ``` { "data" : { "max_quota" : 3801, "used_quota" : 4, "quota_type" : "ACL", "item_info" : { "max_quota" : 30001, "used_quota" : 97 } } } ``` **状态码：400** Bad Request ``` { "error_code" : "CFW.00200003", "error_msg" : "参数错误" } ``` #### 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.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class ShowConfigQuotaSolution { 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); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("")) .build(); ShowConfigQuotaRequest request = new ShowConfigQuotaRequest(); request.withFwInstanceId("{fw_instance_id}"); try { ShowConfigQuotaResponse response = client.showConfigQuota(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 huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 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 = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("")) \ .build() try: request = ShowConfigQuotaRequest() request.fw_instance_id = "{fw_instance_id}" response = client.show_config_quota(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" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/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 := cfw.CfwClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cfw.NewCfwClient(hcClient) request := &model.ShowConfigQuotaRequest{} request.FwInstanceId = "{fw_instance_id}" response, err := client.ShowConfigQuota(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CFW/sdk?api=ShowConfigQuota)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cfw/ErrorCode.html)。