获取东西向防火墙信息
功能介绍
获取东西向防火墙信息
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/firewall/east-west
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
是 |
Integer |
每页显示个数,范围为1-1024 |
offset |
是 |
Integer |
偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
enterprise_project_id |
否 |
String |
企业项目id,用户支持企业项目后,由企业项目生成的id。 |
fw_instance_id |
否 |
String |
防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
获取东西向防火墙列表返回data |
参数 |
参数类型 |
描述 |
---|---|---|
object_id |
String |
防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 |
project_id |
String |
租户project_id |
status |
Integer |
防护状态:0 已开启防护, 1 未开启防护 |
er_associated_subnet |
SubnetInfo object |
ER关联子网信息 |
firewall_associated_subnets |
Array of SubnetInfo objects |
云防火墙关联子网信息 |
er |
ErInstance object |
出方向关联企业路由器信息 |
inspection_vpc |
VpcDetail object |
监控vpc信息 |
protect_infos |
Array of EwProtectResourceInfo objects |
东西向防护资源信息 |
total |
Integer |
防护VPC总数 |
offset |
Integer |
偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
limit |
Integer |
每页显示个数,范围为1-1024 |
mode |
String |
防护模式 |
ew_vpc_route_limit |
Integer |
东西向路由限制 |
参数 |
参数类型 |
描述 |
---|---|---|
availability_zone |
String |
子网id |
cidr |
String |
vpc cidr |
name |
String |
子网名称 |
id |
String |
子网id |
gateway_ip |
String |
子网网关ip |
vpc_id |
String |
vpc id |
status |
String |
子网的状态 |
ipv6_enable |
Boolean |
是否支持ipv6,boolean值为true表示是,false表示否 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
ER实例id |
name |
String |
ER名称 |
state |
String |
ER状态 |
enterprise_project_id |
String |
企业租户id |
project_id |
String |
租户id |
enable_ipv6 |
String |
是否开启ipv6 |
参数 |
参数类型 |
描述 |
---|---|---|
protected_resource_type |
Integer |
防护资源类型:0 VPC,1 VGW |
protected_resource_name |
String |
防护资源名称 |
protected_resource_id |
String |
防护资源id |
protected_resource_nat_name |
String |
防护资源nat网关名称 |
protected_resource_nat_id |
String |
防护资源nat网关id |
protected_resource_project_id |
String |
防护资源租户id |
protected_resource_mode |
String |
防护资源模式 |
status |
Integer |
防护VPC的防护状态,0表示已关联,1表示未关联。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
获取东西向防火墙信息
https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?limit=10&offset=0
响应示例
状态码: 200
东西向防火墙信息响应
{ "data" : { "ew_vpc_route_limit" : 5, "inspection_vpc" : { "cidr" : "10.90.90.0/24", "id" : "4471b50f-811a-4f9b-9575-a491e6c81dd0", "name" : "inspection-vpc" }, "limit" : 50, "mode" : "peer", "object_id" : "5681ed03-ff3f-4dab-9bb1-daf388121ad1", "offset" : 0, "project_id" : "28f403ddd3f141daa6e046e85cb15519", "protect_infos" : [ { "protected_resource_id" : "4c51e814-03b5-4754-87cb-243701f5b4ff", "protected_resource_mode" : "peer", "protected_resource_name" : "vpc-c247", "protected_resource_project_id" : "28f403ddd3f141daa6e046e85cb15519", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "af44c693-a13c-46a7-a6d2-eb2cb2570e57", "protected_resource_mode" : "peer", "protected_resource_name" : "vpc-10.1", "protected_resource_project_id" : "28f403ddd3f141daa6e046e85cb15519", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "2ae53845-64b8-4cd5-bcbe-efb93a7c9207", "protected_resource_mode" : "peer", "protected_resource_name" : "vpc-test", "protected_resource_project_id" : "28f403ddd3f141daa6e046e85cb15519", "protected_resource_type" : 0, "status" : 1 }, { "protected_resource_id" : "8a51174b-376b-40e5-8ccf-89d33703842b", "protected_resource_mode" : "peer", "protected_resource_name" : "vpc-a0c1", "protected_resource_project_id" : "28f403ddd3f141daa6e046e85cb15519", "protected_resource_type" : 0, "status" : 1 }, { "protected_resource_id" : "9cccb096-31be-4d68-a7ee-156f0c947f0b", "protected_resource_mode" : "peer", "protected_resource_name" : "vpc-192.168", "protected_resource_project_id" : "28f403ddd3f141daa6e046e85cb15519", "protected_resource_type" : 0, "status" : 1 } ], "status" : 0, "total" : 5 } }
SDK代码示例
SDK代码示例如下。
Java
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 |
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 ListEastWestFirewallSolution { 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(); ListEastWestFirewallRequest request = new ListEastWestFirewallRequest(); request.withLimit(<limit>); request.withOffset(<offset>); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withFwInstanceId("<fw_instance_id>"); try { ListEastWestFirewallResponse response = client.listEastWestFirewall(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
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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListEastWestFirewallRequest() request.limit = <limit> request.offset = <offset> request.enterprise_project_id = "<enterprise_project_id>" request.fw_instance_id = "<fw_instance_id>" response = client.list_east_west_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
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.ListEastWestFirewallRequest{} request.Limit = int32(<limit>) request.Offset = int32(<offset>) enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest fwInstanceIdRequest:= "<fw_instance_id>" request.FwInstanceId = &fwInstanceIdRequest response, err := client.ListEastWestFirewall(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
东西向防火墙信息响应 |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。