list firewall list
Function
list firewall list
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/firewalls/list
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
key_word |
No |
String |
key |
tags |
No |
Array of TagInfo objects |
tags |
limit |
Yes |
Integer |
Number of records displayed on each page, in the range 1-1024 |
offset |
Yes |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
user_support_eps |
Boolean |
Whether to enable eps. The options are true (yes) and false (no). |
has_ndr |
Boolean |
Whether NDR exists |
is_support_postpaid |
Boolean |
Whether postpaid is supported |
is_support_basic_version |
Boolean |
Whether basic version is supported |
is_support_buy_professional |
Boolean |
Whether professional version firewall is supported to buy |
data |
query firewall instance list response |
Parameter |
Type |
Description |
---|---|---|
limit |
Integer |
Number of records displayed on each page, in the range 1-1024 |
offset |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. |
project_id |
String |
project ID |
total |
Integer |
total |
records |
Array of FirewallInstanceVO objects |
query firewall isntance list |
Parameter |
Type |
Description |
---|---|---|
fw_instance_id |
String |
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
resource_id |
String |
resource id |
name |
String |
name |
fw_instance_name |
String |
firewall instance name |
enterprise_project_id |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
ha_type |
Integer |
ha type |
charge_mode |
Integer |
Billing mode 0: Yearly/monthly subscription 1: On-demand |
service_type |
Integer |
service type |
engine_type |
Integer |
|
flavor |
Flavor object |
flavor |
status |
Integer |
Firewall status list. The options are as follows: -1: waiting for payment; 0: creating; 1: deleting; 2: running; 3: upgrading; 4: deletion completed; 5: freezing; 6: creation failed; 7: deletion failed; 8: freezing failed; 9: storage in progress; 10: storage failed; 11: upgrade failed |
tags |
String |
tags |
Parameter |
Type |
Description |
---|---|---|
version |
Integer |
Firewall version. The value can be 0 (standard edition), 1 (professional edition), 2 (platinum edition), or 3 (basic edition). Enumeration values:
|
eip_count |
Integer |
Number of EIPs Minimum: 1 |
vpc_count |
Integer |
Number of VPCs Minimum: 1 |
bandwidth |
Integer |
Bandwidth Minimum: 1 |
log_storage |
Integer |
Log storage |
default_bandwidth |
Integer |
default bandwidth |
default_eip_count |
Integer |
default eip count |
default_log_storage |
Integer |
default log storage |
default_vpc_count |
Integer |
default vpc count |
Example Requests
Query the firewall list on the first page of the enterprise project whose ID is all_granted_eps and project ID is 14181c1245cf4fd786824efe1e2b9388.
https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/firewalls/list?enterprise_project_id=all_granted_eps { "limit" : 10, "offset" : 0 }
Example Responses
Status code: 200
Get Firewall Instance Response
{ "data" : { "limit" : 1, "offset" : 0, "project_id" : "14181c1245cf4fd786824efe1e2b9388", "records" : [ { "fw_instance_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", "resource_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", "name" : "1709176078374", "fw_instance_name" : "test", "enterprise_project_id" : "default", "tags" : "{\"key_test3\":\"value_test3\"}", "ha_type" : 0, "charge_mode" : 0, "service_type" : 0, "engine_type" : 1, "flavor" : { "version" : 1, "eip_count" : 50, "vpc_count" : 6, "bandwidth" : 50, "log_storage" : 0, "default_eip_count" : 50, "default_vpc_count" : 2, "default_bandwidth" : 50, "default_log_storage" : 0 }, "status" : 2 } ], "total" : 18 }, "has_ndr" : false, "is_support_basic_version" : true, "is_support_buy_professional" : false, "is_support_postpaid" : true, "user_support_eps" : false }
SDK Sample Code
The SDK sample code is as follows.
Java
Query the firewall list on the first page of the enterprise project whose ID is all_granted_eps and project ID is 14181c1245cf4fd786824efe1e2b9388.
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 |
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 ListFirewallListSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); ListFirewallListRequest request = new ListFirewallListRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); QueryFireWallInstanceDto body = new QueryFireWallInstanceDto(); body.withOffset(0); body.withLimit(10); request.withBody(body); try { ListFirewallListResponse response = client.listFirewallList(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
Query the firewall list on the first page of the enterprise project whose ID is all_granted_eps and project ID is 14181c1245cf4fd786824efe1e2b9388.
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 |
# 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"] credentials = BasicCredentials(ak, sk) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListFirewallListRequest() request.enterprise_project_id = "<enterprise_project_id>" request.body = QueryFireWallInstanceDto( offset=0, limit=10 ) response = client.list_firewall_list(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
Query the firewall list on the first page of the enterprise project whose ID is all_granted_eps and project ID is 14181c1245cf4fd786824efe1e2b9388.
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListFirewallListRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest request.Body = &model.QueryFireWallInstanceDto{ Offset: int32(0), Limit: int32(10), } response, err := client.ListFirewallList(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Get Firewall Instance Response |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot