查询防火墙列表
功能介绍
查询防火墙列表
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/firewalls/list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目id,用户支持企业项目后,由企业项目生成的id。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目id,用户支持企业项目后,由企业项目生成的id |
key_word |
否 |
String |
查询关键字 |
tags |
否 |
Array of TagInfo objects |
标签列表 |
limit |
是 |
Integer |
每页显示个数,范围为1-1024 |
offset |
是 |
Integer |
偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
user_support_eps |
Boolean |
是否支持eps |
has_ndr |
Boolean |
是否存在ndr |
is_support_postpaid |
Boolean |
是否支持按需购买 |
is_support_basic_version |
Boolean |
是否支持基础版 |
is_support_buy_professional |
Boolean |
是否支持购买专业版 |
data |
查询防火墙列表返回值data信息 |
参数 |
参数类型 |
描述 |
---|---|---|
limit |
Integer |
每页显示个数,范围为1-1024 |
offset |
Integer |
偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
project_id |
String |
租户项目ID |
total |
Integer |
总数 |
records |
Array of FirewallInstanceVO objects |
查询防火墙列表记录 |
参数 |
参数类型 |
描述 |
---|---|---|
fw_instance_id |
String |
防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 |
resource_id |
String |
资源id |
name |
String |
防火墙创建时间戳 |
fw_instance_name |
String |
防火墙名称 |
enterprise_project_id |
String |
企业项目id,用户支持企业项目后,由企业项目生成的id。 |
ha_type |
Integer |
集群类型 |
charge_mode |
Integer |
计费模式 0:包年/包月 1:按需 |
service_type |
Integer |
服务类型 |
engine_type |
Integer |
引擎类型 |
flavor |
Flavor object |
防火墙规格信息 |
status |
Integer |
防火墙状态列表,包括-1:等待支付,0:创建中,1,删除中,2:运行中,3:升级中,4:删除完成:5:冻结中,6:创建失败,7:删除失败,8:冻结失败,9:存储中,10:存储失败,11:升级失败 |
tags |
String |
标签列表 |
参数 |
参数类型 |
描述 |
---|---|---|
version |
Integer |
防火墙版本,0:标准版,1:专业版,2:铂金版,3:基础版,购买时,当防火墙“charge_mode”为“postPaid”时,仅支持专业版。“charge_mode”为“prePaid”时,支持标准版、专业版。 枚举值:
|
eip_count |
Integer |
eip数量 最小值:1 |
vpc_count |
Integer |
vpc数量 最小值:1 |
bandwidth |
Integer |
带宽 最小值:1 |
log_storage |
Integer |
日志存储 |
default_bandwidth |
Integer |
默认防火墙带宽 |
default_eip_count |
Integer |
默认eip数 |
default_log_storage |
Integer |
默认日志存储 |
default_vpc_count |
Integer |
默认vpc数 |
请求示例
查询项目id为14181c1245cf4fd786824efe1e2b9388,企业项目id为all_granted_eps的第一页的防火墙列表
https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/firewalls/list?enterprise_project_id=all_granted_eps { "limit" : 10, "offset" : 0 }
响应示例
状态码: 200
查询防火墙列表返回值
{ "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代码示例
SDK代码示例如下。
Java
查询项目id为14181c1245cf4fd786824efe1e2b9388,企业项目id为all_granted_eps的第一页的防火墙列表
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
查询项目id为14181c1245cf4fd786824efe1e2b9388,企业项目id为all_granted_eps的第一页的防火墙列表
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
查询项目id为14181c1245cf4fd786824efe1e2b9388,企业项目id为all_granted_eps的第一页的防火墙列表
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) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询防火墙列表返回值 |
错误码
请参见错误码。