调用DescribeControlPolicy接口获取所有访问控制策略的信息。

使用说明

本接口一般用于分页查询访问控制策略的信息。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeControlPolicy

需要执行的操作。

取值:DescribeControlPolicy

CurrentPage String 1

分页查询时,显示的当前页的页码。

默认值为1。

Direction String in

访问控制策略控制的流量方向。取值:

  • in:外对内方向的流量访问控制。
  • out:内对外方向的流量访问控制。
PageSize String 10

分页查询时,显示的每页数据的最大条数。

可设置值最大为50。

SourceIp String 192.0.XX.XX

访问源的IP地址。

Lang String zh

请求和接收消息的语言类型。取值:

  • zh(默认):中文
  • en:英文
Source String 192.0.XX.XX

访问控制策略中的访问源地址。支持使用模糊查询的方式进行查询。SourceType(源类型)不同,访问源地址的取值也不同。

  • 当SourceType为net时,访问源为IP/CIDR地址。例如:10.0.1.0/24。
  • 当SourceType为group时,访问源为源地址簿名称。例如:db_group为空(表示查询所有访问控制源)。
  • 当SourceType为location时,访问源为源区域。例如:北京或beijing(支持使用中文或英文进行查询)。
说明 不设置该参数表示查询所有类型的访问源。
Destination String 192.0.XX.XX

访问控制策略中的目的地址。支持模糊查询。DestinationType(目的类型)不同,目的地址的取值也不同。

  • 当DestinationType为net时,目的地址为IP/CIDR地址。例如:10.0.3.0/24。
  • 当DestinationType为domain时,目的地址为域名。例如:aliyun。
  • 当DestinationType为group时,目的地址为地址簿的名称。例如:db_group。
  • 当DestinationType为location时,目的地址为目的区域。例如:北京或beijing(支持使用中文或英文进行查询)。
说明 不设置该参数表示查询所有类型的目的地址。
Description String test

访问控制策略的描述信息。支持模糊查询。

说明 不设置该参数表示查询所有策略的描述信息。
Proto String TCP

访问控制策略中访问流量的协议类型。取值:

  • TCP
  • UDP
  • ICMP
  • ANY(表示所有协议类型)
    说明 不设置该参数表示查询所有协议类型。
AclAction String accept

访问控制策略中设置的流量通过云防火墙的方式(动作)。取值:

  • accept:放行
  • drop:拒绝
  • log:观察
说明 不设置该参数表示查询所有的动作类型。
Release String true

访问控制策略的启用状态。策略创建后默认启用该策略。取值:

  • true:启用访问控制策略
  • false:不启用访问控制策略
AclUuid String 00281255-d220-4db1-8f4f-c4df221ad84c

访问控制策略的唯一标识ID。

IpVersion String 6

支持的IP地址版本。取值:

  • 4(默认):代表IPv4地址
  • 6:代表IPv6地址

返回数据

名称 类型 示例值 描述
PageNo String 1

分页查询时,显示的当前页的页码。

PageSize String 10

分页查询时,显示的每页数据的最大条数。

Policys Array of DataItem

访问控制策略的信息。

AclAction String accept

访问控制策略中设置的流量通过云防火墙的方式(动作)。取值:

  • accept:放行
  • drop:拒绝
  • log:观察
AclUuid String 00281255-d220-4db1-8f4f-c4df221ad84c

访问控制策略的唯一标识ID。

ApplicationId String 10***

访问控制策略中设置访问流量的应用ID。

ApplicationName String HTTP

访问控制策略支持的应用类型。取值:

  • FTP
  • HTTP
  • HTTPS
  • Memcache
  • MongoDB
  • MQTT
  • MySQL
  • RDP
  • Redis
  • SMTP
  • SMTPS
  • SSH
  • SSL
  • VNC
  • ANY(表示所有应用类型)
Description String test

访问控制策略的描述信息。

DestPort String 80

访问控制策略中访问流量的目的端口。

DestPortGroup String my_port_group

访问控制策略中流量访问的目的端口地址簿名称。

DestPortGroupPorts List [80,443]

目的端口地址簿中包含的端口列表。

DestPortType String port

访问控制策略中流量访问的目的端口类型。取值:

  • port:端口
  • group:端口地址簿
Destination String 192.0.XX.XX/24

访问控制策略中的目的地址。DestinationType(目的类型)不同,目的地址的取值也不同。取值:

  • DestinationTypenet时,目的地址为IP/CIDR地址。例如:192.0.XX.XX/24。
  • DestinationTypedomain时,目的地址为域名。例如:aliyuncs.com。
  • DestinationTypegroup时,目的地址为地址簿的名称。例如:db_group。
  • DestinationTypelocation时,目的地址为区域名称(具体区域位置编码请参见AddControlPolicy)。例如: ["BJ11", "ZB"]。
DestinationGroupCidrs List ["192.0.XX.XX/24", "192.0.XX.XX/32"]

访问控制策略中的目的地址簿中的网段列表。

DestinationGroupType String ip

访问控制策略中的目的地址簿类型。取值:

  • ip:IP地址簿,包含一个或多个IP地址段。
  • tag:ECS标签地址簿,包含一个或多个ECS标签下的IP地址。
  • domain:域名地址簿,包含一个或多个域名地址。
  • threat:威胁地址簿,包含一个或多个恶意IP或域名地址。
  • backsrc:回源地址簿,包含一个或多个DDoS防护实例或WAF实例的回源地址。
DestinationType String net

访问控制策略中的目的地址类型。取值:

  • net:目的网段(CIDR)
  • group:目的地址簿
  • domain:目的域名
  • location:目的区域
Direction String in

访问控制策略的流量方向。取值:

  • in:外对内流量访问控制
  • out:内对外流量访问控制
DnsResult String 192.0.XX.XX,192.0.XX.XX

DNS解析结果。

DnsResultTime Long 1579261141

DNS解析的时间戳。使用秒级时间戳格式表示。

HitLastTime Long 1579261141

最新命中时间戳。使用秒级时间戳格式表示。

HitTimes Long 100

访问控制策略的命中次数。

IpVersion Integer 6

支持的IP地址版本。

取值:

  • 4:代表IPv4地址
  • 6:代表IPv6地址
Order Integer 1

访问控制策略生效的优先级。

优先级数字从1开始顺序递增,优先级数字越小,优先级越高。

Proto String TCP

访问控制策略中流量访问的安全协议类型。取值:

  • ANY
  • TCP
  • UDP
  • ICMP
Release String true

访问控制策略的启用状态。策略创建后默认启用该策略。取值:

  • true:启用访问控制策略
  • false:不启用访问控制策略
Source String 192.0.XX.XX/24

访问控制策略中的访问源地址。取值:

  • SourceTypenet时,访问源地址为CIDR地址。例如:192.0.XX.XX/24。
  • SourceTypegroup时,访问源地址为源地址簿名称。例如:db_group。
  • SourceTypelocation时,访问源地址为区域(具体区域位置编码请参见AddControlPolicy)。例如: ["BJ11", "ZB"]。
SourceGroupCidrs List ["192.0.XX.XX/24", "192.0.XX.XX/32"]

访问控制策略中的源地址簿中的网段列表。

SourceGroupType String ip

访问控制策略中的源地址簿类型。取值:

  • ip:IP地址簿,包含一个或多个IP地址段。
  • tag:ECS标签地址簿,包含一个或多个ECS标签下的IP地址。
  • domain:域名地址簿,包含一个或多个域名地址。
  • threat:威胁地址簿,包含一个或多个恶意IP或域名地址。
  • backsrc:回源地址簿,包含一个或多个DDoS防护实例或WAF实例的回源地址。
SourceType String net

访问控制策略中的源地址类型。取值:

  • net:源网段(CIDR地址)
  • group:源地址簿
  • location:源区域
RequestId String CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

结果的请求ID。

TotalCount String 100

访问控制策略的总数量。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeControlPolicy
&CurrentPage=1
&Direction=in
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式

<DescribeControlPolicyResponse>
  <TotalCount>100</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D</RequestId>
  <PageNo>1</PageNo>
  <Policys>
        <Order>1</Order>
        <Destination>192.0.XX.XX/24</Destination>
        <DnsFailedDomain></DnsFailedDomain>
        <ApplicationName>HTTP</ApplicationName>
        <Description>test</Description>
        <IpVersion>6</IpVersion>
        <HitLastTime>1579261141</HitLastTime>
        <SourceType>net</SourceType>
        <DnsResultTime>1579261141</DnsResultTime>
        <DnsResult>192.0.XX.XX,192.0.XX.XX</DnsResult>
        <DestPort>80</DestPort>
        <AclAction>accept</AclAction>
        <DestinationType>net</DestinationType>
        <Direction>in</Direction>
        <Source>192.0.XX.XX/24</Source>
        <DestPortType>port</DestPortType>
        <Proto>TCP</Proto>
        <HitTimes>100</HitTimes>
        <DestinationGroupType>ip</DestinationGroupType>
        <SourceGroupType>ip</SourceGroupType>
        <AclUuid>00281255-d220-4db1-8f4f-c4df221ad84c</AclUuid>
        <ApplicationId>10***</ApplicationId>
        <Release>true</Release>
        <DestPortGroup>my_port_group</DestPortGroup>
        <SourceGroupCidrs>["192.0.XX.XX/24", "192.0.XX.XX/32"]</SourceGroupCidrs>
        <DestinationGroupCidrs>["192.0.XX.XX/24", "192.0.XX.XX/32"]</DestinationGroupCidrs>
        <DestPortGroupPorts>[80,443]</DestPortGroupPorts>
  </Policys>
</DescribeControlPolicyResponse>

JSON格式

{
    "TotalCount": 100,
    "PageSize": 10,
    "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
    "PageNo": 1,
    "Policys": {
        "Order": 1,
        "Destination": "192.0.XX.XX/24",
        "DnsFailedDomain": "",
        "ApplicationName": "HTTP",
        "Description": "test",
        "IpVersion": 6,
        "HitLastTime": 1579261141,
        "SourceType": "net",
        "DnsResultTime": 1579261141,
        "DnsResult": "192.0.XX.XX,192.0.XX.XX",
        "DestPort": 80,
        "AclAction": "accept",
        "DestinationType": "net",
        "Direction": "in",
        "Source": "192.0.XX.XX/24",
        "DestPortType": "port",
        "Proto": "TCP",
        "HitTimes": 100,
        "DestinationGroupType": "ip",
        "SourceGroupType": "ip",
        "AclUuid": "00281255-d220-4db1-8f4f-c4df221ad84c",
        "ApplicationId": "10***",
        "Release": true,
        "DestPortGroup": "my_port_group",
        "SourceGroupCidrs": "[\"192.0.XX.XX/24\", \"192.0.XX.XX/32\"]",
        "DestinationGroupCidrs": "[\"192.0.XX.XX/24\", \"192.0.XX.XX/32\"]",
        "DestPortGroupPorts": "[80,443]"
    }
}