DescribeAclCheck - 查询ACL检查详情

更新时间:
复制为 MD 格式

查询ACL检查详情。

接口说明

QPS 限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Lang

string

接收消息的语言类型。

枚举值:

  • en :

    英文

  • zh :

    中文(默认)

zh

TaskId

string

任务 ID。

132

PageNo

integer

页码。

1

PageSize

integer

每页数目。

10

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

25E655B0-CAED-53D4-8054-F983126****

CheckRecord

object

检查记录。

AclTotalCount

integer

检查时的 ACL 策略总数。

10

RecordAssessmentDetail

string

ACL 检查的研判详情。

It is recommended to remove the invalid policy, while helping to save the specification.

CheckName

string

ACL 检查名称。

PolicyHitCountZero

Description

string

ACL 检查项说明。

Due to business offline or other reasons, the number of hits of the object policy in a period of time is 0.

LastCheckTime

string

最近检查时间戳,单位:秒。

1724982259

Level

string

风险等级。

High

TaskId

string

任务 ID。

task-c92d4544ef7b6a42

Acls

array<object>

ACL 检查结果列表。

array<object>

ACL 检查结果。

Acl

object

ACL 检查结果。

Direction

string

互联网流量方向。取值:

  • in:外对内流量访问控制

  • out:内对外流量访问控制

out

Order

integer

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

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

1

SourceType

string

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

  • net:源网段(CIDR 地址)

  • group:源地址簿

  • location:源区域

group

ApplicationName

string

VPC 边界防火墙访问控制策略支持的应用类型,推荐使用 ApplicationNameList。取值:

  • HTTP

  • HTTPS

  • MySQL

  • SMTP

  • SMTPS

  • RDP

  • VNC

  • SSH

  • Redis

  • MQTT

  • MongoDB

  • Memcache

  • SSL

  • ANY(表示查询访问控制策略所有的应用类型)

ANY

HitTimes

integer

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

1

Description

string

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

test_policy

SourceGroupType

string

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

  • ip:IP 地址簿,包含一个或多个 IP 地址段。

  • tag:ECS 标签地址簿,包含一个或多个 ECS 标签下的 IP 地址。

  • domain:域名地址簿,包含一个或多个域名地址。

  • threat:威胁地址簿,包含一个或多个恶意 IP 或域名地址。

  • backsrc:回源地址簿,包含一个或多个 DDoS 防护实例或 WAF 实例的回源地址。

ip

DnsResultTime

integer

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

1579261141

DnsResult

string

DNS 解析结果。

192.0.XX.XX

Proto

string

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

  • TCP

  • UDP

  • ICMP

  • ANY(表示所有协议类型)

说明

不设置该参数表示查询所有协议类型。

TCP

DestinationGroupType

string

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

  • ip:IP 地址簿,包含一个或多个 IP 地址段。

  • tag:ECS 标签地址簿,包含一个或多个 ECS 标签下的 IP 地址。

  • domain:域名地址簿,包含一个或多个域名地址。

  • threat:威胁地址簿,包含一个或多个恶意 IP 或域名地址。

  • backsrc:回源地址簿,包含一个或多个 DDoS 防护实例或 WAF 实例的回源地址。

domain

Destination

string

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

  • 当 DestinationType 为net时,目的地址为 CIDR 格式的 IP 地址段。例如:10.0.3.0/24。

  • 当 DestinationType 为domain时,目的地址为域名。例如:aliyun。

  • 当 DestinationType 为group时,目的地址为地址簿的名称。例如:db_group。

  • 当 DestinationType 为location时,目的地址为区域名称(具体区域位置编码请参见 AddControlPolicy。例如:["BJ11", "ZB"]。

说明

不设置该参数表示查询所有类型的目的地址。

kms.cn-shanghai.aliyuncs.com

HitLastTime

integer

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

1579261141

DestPortGroup

string

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

  • port:端口

  • group:端口地址簿

my_port_group

AclUuid

string

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

997b38e0-01fa-4db7-8d30-02ebf6fdb747

DestPortType

string

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

  • port:端口

  • group:端口地址簿

port

Source

string

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

  • SourceTypenet时,访问源为 CIDR 格式的 IP 地址段。例如:192.0.XX.XX/24。

  • SourceTypegroup时,访问源地址为源地址簿名称。例如:db_group。

  • SourceTypelocation时,访问源地址为区域(具体区域位置编码请参见 AddControlPolicy )。例如: ["BJ11", "ZB"]。

172.28.7.167

DestinationType

string

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

  • net:目的网段(CIDR)

  • group:目的地址簿

  • domain:目的域名

  • location:目的区域

domain

DestPort

string

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

80/80

IpVersion

integer

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

  • 4:代表 IPv4 地址

  • 6:代表 IPv6 地址

4

AclAction

string

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

  • accept:放行

  • drop:拒绝

  • log:观察

log

Release

string

访问控制策略的启用状态。取值:

  • true:启用访问控制策略

  • false:不启用访问控制策略

true

ApplicationId

string

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

plugin_idp4_ciam

DestinationGroupCidrs

array

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

string

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

192.0.XX.XX/32

DestPortGroupPorts

array

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

string

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

80/80

SourceGroupCidrs

array

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

string

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

111.48.54.39/32

ApplicationNameList

array

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

  • FTP

  • HTTP

  • HTTPS

  • Memcache

  • MongoDB

  • MQTT

  • MySQL

  • RDP

  • Redis

  • SMTP

  • SMTPS

  • SSH

  • SSL

  • VNC

  • ANY(表示所有应用类型)

string

VPC 边界防火墙访问控制策略支持的应用类型列表。取值:

  • HTTP

  • HTTPS

  • MySQL

  • SMTP

  • SMTPS

  • RDP

  • VNC

  • SSH

  • Redis

  • MQTT

  • MongoDB

  • Memcache

  • SSL

  • ANY(表示查询访问控制策略所有的应用类型)

ANY

SpreadCnt

integer

占用访问控制策略的规格数,即每条策略占用规格数的累加值。 单条策略占用的规格数 = 源地址个数(IP 地址段个数或区域个数)* 目的地址个数(IP 地址段个数或区域个数或域名个数)* 端口段个数 * 应用数。

10

CreateTime

integer

创建策略的时间。

1761062400

ModifyTime

integer

修改策略的时间。

1761062400

RepeatType

string

访问控制策略的策略有效期的重复类型。取值:

  • Permanent(默认):总是

  • None:指定单次时间

  • Daily:每天

  • Weekly:每周

  • Monthly:每月

Permanent

RepeatDays

array

访问控制策略的策略有效期的重复日期。

说明

RepeatType 设置为 Weekly 时,取值范围:0~6,每周开始于周日。 RepeatType 设置为 Monthly 时,取值范围:1~31。

integer

访问控制策略的策略有效期的重复日期。

说明

RepeatType 设置为 Weekly 时,取值范围:0~6,每周开始于周日。 RepeatType 设置为 Monthly 时,取值范围:1~31。

6

RepeatStartTime

string

访问控制策略的策略有效期的重复开始时间。例如:08:00,必须为整点或半点时间,且小于重复结束时间至少半小时。

说明

当 RepeatType 为 Permanent、None 时,RepeatStartTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时,RepeatStartTime 必须有值,您需要设置重复开始时间。

08:00

RepeatEndTime

string

访问控制策略的策略有效期的重复结束时间。例如:23:30,必须为整点或半点时间,且大于重复开始时间至少半小时。

说明

当 RepeatType 为 Permanent、None 时,RepeatEndTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时,RepeatEndTime 必须有值,您需要设置重复结束时间。

23:30

StartTime

integer

设置查询开始时间。使用秒级时间戳格式表示。

1730318400

EndTime

integer

访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间,且大于开始时间至少半小时。

说明

当 RepeatType 为 Permanent 时,EndTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,EndTime 必须有值,您需要设置结束时间。

1758334822

AddressListCount

integer

地址簿中包含地址的个数。

1

GroupUuid

string

地址簿的唯一标识 ID。

删除安全访问控制的地址簿,需要提供该地址簿的唯一标识 ID,该 ID 可调用 DescribeAddressBook 接口获取。

b91d86c3-2b52-4534-aae9-8d0339b12a48

AutoAddTagEcs

integer

是否自动添加新匹配标签的 ECS(新购且完成标签设置的 ECS 或修改标签的 ECS)公网 IP 到地址簿。

0

GroupName

string

地址簿的名称。

Zhong Kui Open White List

ReferenceCount

integer

地址簿被引用次数。

1

GroupType

string

地址簿的类型。取值:

  • ip:IP 地址簿。

  • domain:域名地址簿。

  • port:端口地址簿。

  • tag:ECS 标签地址簿。

  • allCloud:云服务地址簿。

  • threat:威胁情报地址簿。

ip

TagRelation

string

多个 ECS 标签间的关系。取值:

  • and:多个标签间为“与”关系,即同时匹配多个标签的 ECS 公网 IP 才会被加入地址簿。

  • or:多个标签间为“或”关系,即只要匹配一个标签的 ECS 公网 IP 就会被加入地址簿。

or

TagList

array<object>

ECS 标签列表。

object

ECS 标签。

TagValue

string

ECS 标签值。

tfTestAcc0

TagKey

string

ECS 标签键。

ss

AddressList

array

地址簿的地址信息。

string

地址簿的地址信息。

183.2.201.71/32,60.28.235.22/32,210.51.58.107/32,60.28.235.81/32,210.51.58.51/32,60.28.235.52/32,1.1.1.1/32,154.212.141.143/32,167.94.146.55/32,185.226.197.47/32,101.251.238.174/32

NatGatewayId

string

NAT 网关的 ID。

ngw-2ze4w62zbdkwjmoqeokgl

DomainResolveType

integer

访问控制策略的域名解析方式。取值:

  • FQDN:基于 FQDN

  • DNS:基于 DNS 动态解析

  • FQDN_AND_DNS:基于 FQDN 与 DNS 动态解析

FQDN

VpcFirewallId

string

VPC 边界防火墙的实例 ID。

vfw-925514970c2c4bcab222

Addresses

array<object>

地址和描述备注信息列表。

object

地址和描述备注信息。

Address

string

地址簿的地址信息。

192.0.XX.XX/32

Note

string

描述备注信息。

Reviewed

AclStatus

string

ACL 检查状态。

枚举值:

  • Pending :

    待处理

  • Ignored :

    已忽略

  • Processed :

    已处理

Pending

AclAssessmentDetail

string

该条 ACL 策略的研判详情。

No traffic hit policy.

示例

正常返回示例

JSON格式

{
  "RequestId": "25E655B0-CAED-53D4-8054-F983126****",
  "CheckRecord": {
    "AclTotalCount": 10,
    "RecordAssessmentDetail": "It is recommended to remove the invalid policy, while helping to save the specification.\n",
    "CheckName": "PolicyHitCountZero",
    "Description": "Due to business offline or other reasons, the number of hits of the object policy in a period of time is 0.\n",
    "LastCheckTime": "1724982259",
    "Level": "High",
    "TaskId": "task-c92d4544ef7b6a42",
    "Acls": [
      {
        "Acl": {
          "Direction": "out",
          "Order": 1,
          "SourceType": "group",
          "ApplicationName": "ANY",
          "HitTimes": 1,
          "Description": "test_policy",
          "SourceGroupType": "ip",
          "DnsResultTime": 1579261141,
          "DnsResult": "192.0.XX.XX",
          "Proto": "TCP",
          "DestinationGroupType": "domain",
          "Destination": "kms.cn-shanghai.aliyuncs.com",
          "HitLastTime": 1579261141,
          "DestPortGroup": "my_port_group\n",
          "AclUuid": "997b38e0-01fa-4db7-8d30-02ebf6fdb747",
          "DestPortType": "port",
          "Source": "172.28.7.167",
          "DestinationType": "domain",
          "DestPort": "80/80",
          "IpVersion": 4,
          "AclAction": "log",
          "Release": "true",
          "ApplicationId": "plugin_idp4_ciam",
          "DestinationGroupCidrs": [
            "192.0.XX.XX/32"
          ],
          "DestPortGroupPorts": [
            "80/80"
          ],
          "SourceGroupCidrs": [
            "111.48.54.39/32"
          ],
          "ApplicationNameList": [
            "ANY"
          ],
          "SpreadCnt": 10,
          "CreateTime": 1761062400,
          "ModifyTime": 1761062400,
          "RepeatType": "Permanent",
          "RepeatDays": [
            6
          ],
          "RepeatStartTime": "08:00\n",
          "RepeatEndTime": "23:30",
          "StartTime": 1730318400,
          "EndTime": 1758334822,
          "AddressListCount": 1,
          "GroupUuid": "b91d86c3-2b52-4534-aae9-8d0339b12a48",
          "AutoAddTagEcs": 0,
          "GroupName": "Zhong Kui Open White List",
          "ReferenceCount": 1,
          "GroupType": "ip",
          "TagRelation": "or",
          "TagList": [
            {
              "TagValue": "tfTestAcc0",
              "TagKey": "ss"
            }
          ],
          "AddressList": [
            "183.2.201.71/32,60.28.235.22/32,210.51.58.107/32,60.28.235.81/32,210.51.58.51/32,60.28.235.52/32,1.1.1.1/32,154.212.141.143/32,167.94.146.55/32,185.226.197.47/32,101.251.238.174/32"
          ],
          "NatGatewayId": "ngw-2ze4w62zbdkwjmoqeokgl",
          "DomainResolveType": 0,
          "VpcFirewallId": "vfw-925514970c2c4bcab222",
          "Addresses": [
            {
              "Address": "192.0.XX.XX/32",
              "Note": "Reviewed"
            }
          ]
        },
        "AclStatus": "Pending",
        "AclAssessmentDetail": "No traffic hit policy."
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 ErrorAclCheckNotExist ACL check not exist. ACL检查不存在。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情