查询防护规则
功能介绍
查询防护规则
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/acl-rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
object_id |
是 |
String |
防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 |
type |
否 |
Integer |
规则Type0:互联网规则,1:vpc规则, 2:nat规则 枚举值:
|
ip |
否 |
String |
ip地址 |
name |
否 |
String |
名称 |
direction |
否 |
Integer |
方向0:外到内1:内到外 |
status |
否 |
Integer |
规则下发状态 0:禁用,1:启用 枚举值:
|
action_type |
否 |
Integer |
动作0:permit,1:deny 枚举值:
|
address_type |
否 |
Integer |
地址类型0 ipv4 枚举值:
|
limit |
是 |
Integer |
每页显示个数,范围为1-1024 |
offset |
是 |
Integer |
偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
enterprise_project_id |
否 |
String |
企业项目id,用户支持企业项目后,由企业项目生成的id。 |
fw_instance_id |
否 |
String |
防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 |
tags_id |
否 |
String |
标签id |
source |
否 |
String |
源地址 |
destination |
否 |
String |
目的地址 |
service |
否 |
String |
服务端口 |
application |
否 |
String |
应用 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
data |
参数 |
参数类型 |
描述 |
---|---|---|
offset |
Integer |
偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
limit |
Integer |
每页显示个数,范围为1-1024 |
total |
Integer |
查询总条数 |
object_id |
String |
防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 |
records |
Array of records objects |
records |
参数 |
参数类型 |
描述 |
---|---|---|
rule_id |
String |
规则id |
address_type |
Integer |
地址类型0 ipv4,1 ipv6 |
name |
String |
规则名称 |
direction |
Integer |
规则方向0:外到内1:内到外 枚举值:
|
action_type |
Integer |
动作0:permit,1:deny |
status |
Integer |
规则下发状态 0:禁用,1:启用 |
description |
String |
描述 |
long_connect_time |
Long |
长连接时长 |
long_connect_enable |
Integer |
长连接支持 |
long_connect_time_hour |
Long |
长连接时长小时 |
long_connect_time_minute |
Long |
长连接时长分钟 |
long_connect_time_second |
Long |
长连接时长秒 |
source |
RuleAddressDtoForResponse object |
源地址传输对象 |
destination |
RuleAddressDtoForResponse object |
destination |
service |
RuleServiceDtoForResponse object |
service |
type |
Integer |
规则type,0:互联网规则,1:vpc规则,2:nat规则 枚举值:
|
created_date |
String |
创建时间 |
last_open_time |
String |
最后开启时间 |
tag |
TagsVO object |
标签显示信息 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
Integer |
源类型0手工输入,1关联IP地址组,2域名,3地理位置,4域名组,5多对象,6域名组-DNS解析,7域名组-URL过滤。 |
address_type |
Integer |
源类型0 ipv4,1 ipv6 |
address |
String |
源IP,手动类型不能为空,自动及domain类型为空 |
address_set_id |
String |
关联IP地址组ID,自动类型不能为空,手动类型合domain类型为空 |
address_set_name |
String |
地址组名称 |
domain_address_name |
String |
域名地址名称,域名类型时不能为空,手动类型及自动类型时为空 |
region_list_json |
String |
规则region列表json值 |
region_list |
Array of IpRegionDto objects |
规则region列表 |
domain_set_id |
String |
域名组id |
domain_set_name |
String |
域名组名称 |
ip_address |
Array of strings |
IP地址列表 |
address_group |
Array of strings |
地址组列表 |
address_group_names |
Array of AddressGroupVO objects |
地址组名称列表 |
address_set_type |
Integer |
地址组类型,0表示自定义地址组,1表示WAF回源IP地址组,2表示DDoS回源IP地址组,3表示NAT64转换地址组 |
参数 |
参数类型 |
描述 |
---|---|---|
region_id |
String |
区域id |
description_cn |
String |
中文描述 |
description_en |
String |
英文描述 |
region_type |
Integer |
区域类型,0表示国家,1表示省份,2表示大洲 |
参数 |
参数类型 |
描述 |
---|---|---|
address_set_type |
Integer |
地址组类型,0表示自定义地址组,1表示WAF回源IP地址组,2表示DDoS回源IP地址组,3表示NAT64转换地址组 |
name |
String |
地址组名称 |
set_id |
String |
地址组id |
参数 |
参数类型 |
描述 |
---|---|---|
type |
Integer |
服务输入类型,0为手动输入类型,1为自动输入类型 |
protocol |
Integer |
协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空 |
protocols |
Array of integers |
协议列表,协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空 |
source_port |
String |
源端口 |
dest_port |
String |
目的端口 |
service_set_id |
String |
服务组id,手动类型为空,自动类型为非空 |
service_set_name |
String |
服务组名称 |
custom_service |
Array of ServiceItem objects |
自定义服务 |
service_group |
Array of strings |
服务组列表 |
service_group_names |
Array of ServiceGroupVO objects |
服务组名称列表 |
service_set_type |
Integer |
服务组类型,0表示自定义服务组,1表示常用WEB服务,2表示常用远程登录和PING,3表示常用数据库 |
参数 |
参数类型 |
描述 |
---|---|---|
protocol |
Integer |
协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空 |
source_port |
String |
源端口 |
dest_port |
String |
目的端口 |
description |
String |
服务成员描述 |
name |
String |
服务成员名称 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
服务组名称 |
protocols |
Array of integers |
协议列表 |
service_set_type |
Integer |
服务组类型,0表示自定义服务组,1表示常用WEB服务,2表示常用远程登录和PING,3表示常用数据库 |
set_id |
String |
服务组ID |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:8 最大长度:36 |
error_msg |
String |
错误描述 最小长度:2 最大长度:512 |
请求示例
查询项目id为9d80d070b6d44942af73c9c3d38e0429,防护对象id为e12bd2cd-ebfc-4af7-ad6f-ebe6da398029的第一页,size为10的数据
https://{Endpoint}/cfw/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rules?object_id=e12bd2cd-ebfc-4af7-ad6f-ebe6da398029&limit=10&offset=0
响应示例
状态码: 200
OK
{ "data" : { "limit" : 10, "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", "offset" : 0, "records" : [ { "action_type" : 0, "address_type" : 0, "destination" : { "address" : "0.0.0.0/0", "address_type" : 0, "type" : 0 }, "direction" : 1, "long_connect_enable" : 0, "created_date" : "2024-02-27 04:01:17", "last_open_time" : "2024-02-27 04:01:17", "description" : "description", "name" : "eip_ipv4_n_w_allow", "rule_id" : "ffe9af47-d893-483b-86e3-ee5242e8cb15", "service" : { "dest_port" : "0", "protocol" : -1, "source_port" : "0", "type" : 0 }, "source" : { "address_set_id" : "48bfb09b-6f3a-4371-8ddb-05d5d7148bcc", "address_set_name" : "ip_group", "address_type" : 0, "type" : 1 }, "status" : 1, "type" : "0" } ], "total" : 1 } }
状态码: 400
Bad Request
{ "error_code" : "CFW.0020016", "error_msg" : "实例状态错误" }
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 50 51 52 53 54 55 56 57 58 59 60 61 62 |
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 ListAclRulesSolution { 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(); ListAclRulesRequest request = new ListAclRulesRequest(); request.withObjectId("<object_id>"); request.withType(ListAclRulesRequest.TypeEnum.NUMBER_<type>); request.withIp("<ip>"); request.withName("<name>"); request.withDirection(<direction>); request.withStatus(ListAclRulesRequest.StatusEnum.NUMBER_<status>); request.withActionType(ListAclRulesRequest.ActionTypeEnum.NUMBER_<action_type>); request.withAddressType(ListAclRulesRequest.AddressTypeEnum.NUMBER_<address_type>); request.withLimit(<limit>); request.withOffset(<offset>); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withFwInstanceId("<fw_instance_id>"); request.withTagsId("<tags_id>"); request.withSource("<source>"); request.withDestination("<destination>"); request.withService("<service>"); request.withApplication("<application>"); try { ListAclRulesResponse response = client.listAclRules(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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
# 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 = ListAclRulesRequest() request.object_id = "<object_id>" request.type = <type> request.ip = "<ip>" request.name = "<name>" request.direction = <direction> request.status = <status> request.action_type = <action_type> request.address_type = <address_type> request.limit = <limit> request.offset = <offset> request.enterprise_project_id = "<enterprise_project_id>" request.fw_instance_id = "<fw_instance_id>" request.tags_id = "<tags_id>" request.source = "<source>" request.destination = "<destination>" request.service = "<service>" request.application = "<application>" response = client.list_acl_rules(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 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
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.ListAclRulesRequest{} request.ObjectId = "<object_id>" typeRequest:= model.GetListAclRulesRequestTypeEnum().<TYPE> request.Type = &typeRequest ipRequest:= "<ip>" request.Ip = &ipRequest nameRequest:= "<name>" request.Name = &nameRequest directionRequest:= int32(<direction>) request.Direction = &directionRequest statusRequest:= model.GetListAclRulesRequestStatusEnum().<STATUS> request.Status = &statusRequest actionTypeRequest:= model.GetListAclRulesRequestActionTypeEnum().<ACTION_TYPE> request.ActionType = &actionTypeRequest addressTypeRequest:= model.GetListAclRulesRequestAddressTypeEnum().<ADDRESS_TYPE> request.AddressType = &addressTypeRequest request.Limit = int32(<limit>) request.Offset = int32(<offset>) enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest fwInstanceIdRequest:= "<fw_instance_id>" request.FwInstanceId = &fwInstanceIdRequest tagsIdRequest:= "<tags_id>" request.TagsId = &tagsIdRequest sourceRequest:= "<source>" request.Source = &sourceRequest destinationRequest:= "<destination>" request.Destination = &destinationRequest serviceRequest:= "<service>" request.Service = &serviceRequest applicationRequest:= "<application>" request.Application = &applicationRequest response, err := client.ListAclRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。