全部产品
Search

搜索本产品

    云防火墙：DescribeControlPolicy - 获取所有访问控制策略的信息

    文档中心

    云防火墙：DescribeControlPolicy - 获取所有访问控制策略的信息

    更新时间：Nov 21, 2024

    获取所有访问控制策略的信息。

    接口说明

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

    QPS 限制

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

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    yundun-cloudfirewall:DescribeControlPolicyget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    Langstring否

    接收消息的语言类型。取值：

    • zh（默认）：中文
    • en：英文
    		zh
    Directionstring否

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

    • in：外对内方向的流量访问控制。
    • out：内对外方向的流量访问控制。
    		in
    CurrentPagestring是

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

    默认值为 1。

    		1
    PageSizestring是

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

    		10
    Sourcestring否

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

    • 当 SourceType 为net时，访问源为 CIDR 格式的 IP 地址段。例如：192.0.XX.XX/24。

    • 当 SourceType 为group时，访问源为源地址簿名称。例如：db_group 为空（表示查询所有访问控制源）。

    • 当 SourceType 为location时，访问源为源区域。例如：北京或 beijing（支持使用中文或英文进行查询）。

    说明 不设置该参数表示查询所有类型的访问源。
    		192.0.XX.XX
    Destinationstring否

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

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

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

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

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

    说明 不设置该参数表示查询所有类型的目的地址。
    		192.0.XX.XX
    Descriptionstring否

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

    说明 不设置该参数表示查询所有策略的描述信息。
    		test
    Protostring否

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

    • TCP
    • UDP
    • ICMP
    • ANY（表示所有协议类型）
    说明 不设置该参数表示查询所有协议类型。
    		TCP
    AclActionstring否

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

    • accept：放行

    • drop：拒绝

    • log：观察

    说明 不设置该参数表示查询所有的动作类型。
    		accept
    Releasestring否

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

    • true：启用访问控制策略

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

    		true
    AclUuidstring否

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

    		00281255-d220-4db1-8f4f-c4df221a****
    IpVersionstring否

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

    • 4（默认）：代表 IPv4 地址

    • 6：代表 IPv6 地址

    		6
    RepeatTypestring否

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

    • Permanent（默认）：总是
    • None：指定单次时间
    • Daily：每天
    • Weekly：每周
    • Monthly：每月
    		Permanent

    返回参数

    名称类型描述示例值
    object
    PageNostring

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

    		1
    PageSizestring

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

    		10
    RequestIdstring

    结果的请求 ID。

    		CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****
    TotalCountstring

    访问控制策略的总数量。

    		100
    Policysarray<object>

    访问控制策略的信息。

    DataItemobject

    无

    Directionstring

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

    • in：外对内流量访问控制
    • out：内对外流量访问控制
    		in
    Orderinteger

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

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

    		1
    SourceTypestring

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

    • net：源网段（CIDR 地址）
    • group：源地址簿
    • location：源区域
    		net
    ApplicationNamestring

    访问控制策略支持的应用类型，推荐使用 ApplicationNameList。取值：

    • FTP
    • HTTP
    • HTTPS
    • Memcache
    • MongoDB
    • MQTT
    • MySQL
    • RDP
    • Redis
    • SMTP
    • SMTPS
    • SSH
    • SSL
    • VNC
    • ANY（表示所有应用类型）
    		HTTP
    HitTimeslong

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

    		100
    Descriptionstring

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

    		test
    SourceGroupTypestring

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

    • ip：IP 地址簿，包含一个或多个 IP 地址段。

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

    • domain：域名地址簿，包含一个或多个域名地址。

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

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

    		ip
    DnsResultTimelong

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

    		1579261141
    DnsResultdeprecatedstring

    DNS 解析结果。

    		192.0.XX.XX,192.0.XX.XX
    Protostring

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

    • ANY
    • TCP
    • UDP
    • ICMP
    		TCP
    DestinationGroupTypestring

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

    • ip：IP 地址簿，包含一个或多个 IP 地址段。

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

    • domain：域名地址簿，包含一个或多个域名地址。

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

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

    		ip
    Destinationstring

    访问控制策略中的目的地址。DestinationType（目的类型）不同，目的地址的取值也不同。取值：

    • 当 DestinationType 为 net 时，目的地址为 CIDR 格式的 IP 地址段。例如：192.0.XX.XX/24。
    • 当 DestinationType 为 domain 时，目的地址为域名。例如：aliyuncs.com。
    • 当 DestinationType 为 group 时，目的地址为地址簿的名称。例如：db_group。
    • 当 DestinationType 为 location 时，目的地址为区域名称（具体区域位置编码请参见 AddControlPolicy。例如： ["BJ11", "ZB"]。
    		192.0.XX.XX/24
    HitLastTimelong

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

    		1579261141
    DestPortGroupstring

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

    		my_port_group
    AclUuidstring

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

    		00281255-d220-4db1-8f4f-c4df221a****
    DestPortTypestring

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

    • port：端口
    • group：端口地址簿
    		port
    Sourcestring

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

    • 当 SourceType 为net时，访问源为 CIDR 格式的 IP 地址段。例如：192.0.XX.XX/24。
    • 当 SourceType 为group时，访问源地址为源地址簿名称。例如：db_group。
    • 当 SourceType 为location时，访问源地址为区域（具体区域位置编码请参见 AddControlPolicy ）。例如： ["BJ11", "ZB"]。
    		192.0.XX.XX/24
    DestinationTypestring

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

    • net：目的网段（CIDR）
    • group：目的地址簿
    • domain：目的域名
    • location：目的区域
    		net
    DestPortstring

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

    		80
    IpVersioninteger

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

    • 4：代表 IPv4 地址
    • 6：代表 IPv6 地址
    		6
    AclActionstring

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

    • accept：放行
    • drop：拒绝
    • log：观察
    		accept
    Releasestring

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

    • true：启用访问控制策略

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

    		true
    ApplicationIdstring

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

    		10***
    DestinationGroupCidrsarray

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

    DestinationGroupCidrsItemstring

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

    		192.0.XX.XX/24
    DestPortGroupPortsarray

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

    DestPortGroupPortsItemstring

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

    		80/80
    SourceGroupCidrsarray

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

    SourceGroupCidrsItemstring

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

    		192.0.XX.XX/24
    ApplicationNameListarray

    应用名称列表。

    ApplicationNameItemstring

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

    • FTP
    • HTTP
    • HTTPS
    • Memcache
    • MongoDB
    • MQTT
    • MySQL
    • RDP
    • Redis
    • SMTP
    • SMTPS
    • SSH
    • SSL
    • VNC
    • ANY（表示所有应用类型）
    		HTTP
    SpreadCntinteger

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

    		10000
    CreateTimelong

    创建策略的时间。

    		1761062400
    ModifyTimelong

    修改策略的时间。

    		1761062400
    RepeatTypestring

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

    • Permanent（默认）：总是
    • None：指定单次时间
    • Daily：每天
    • Weekly：每周
    • Monthly：每月
    		Permanent
    RepeatDaysarray

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

    • 当 RepeatType 为Permanent、None、Daily时，RepeatDays 为空集合。 例如：[]
    • 当 RepeatType 为 Weekly 时，RepeatDays 不能为空。 例如：[0, 6]
    说明 RepeatType 设置为 Weekly 时，RepeatDays 不允许重复。
    • 当 RepeatType 为Monthly时，RepeatDays 不能为空。 例如：[1, 31]
    说明 RepeatType 设置为 Monthly 时，RepeatDays 不允许重复。
    repeatDaylong

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

    说明 RepeatType 设置为 Weekly 时，取值范围：0~6，每周开始于周日。 RepeatType 设置为 Monthly 时，取值范围：1~31。
    		1
    RepeatStartTimestring

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

    说明 当 RepeatType 为 Permanent、None 时，RepeatStartTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时，RepeatStartTime 必须有值，您需要设置重复开始时间。
    		08:00
    RepeatEndTimestring

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

    说明 当 RepeatType 为 Permanent、None 时，RepeatEndTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时，RepeatEndTime 必须有值，您需要设置重复结束时间。
    		23:30
    StartTimelong

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

    说明 当 RepeatType 为 Permanent 时，StartTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时，StartTime 必须有值，您需要设置开始时间。
    		1694761200
    EndTimelong

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

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

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

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

    示例

    正常返回示例

    JSON格式

    {
  "PageNo": "1",
  "PageSize": "10",
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****",
  "TotalCount": "100",
  "Policys": [
    {
      "Direction": "in",
      "Order": 1,
      "SourceType": "net",
      "ApplicationName": "HTTP",
      "HitTimes": 100,
      "Description": "test",
      "SourceGroupType": "ip",
      "DnsResultTime": 1579261141,
      "DnsResult": "192.0.XX.XX,192.0.XX.XX",
      "Proto": "TCP",
      "DestinationGroupType": "ip",
      "Destination": "192.0.XX.XX/24",
      "HitLastTime": 1579261141,
      "DestPortGroup": "my_port_group",
      "AclUuid": "00281255-d220-4db1-8f4f-c4df221a****",
      "DestPortType": "port",
      "Source": "192.0.XX.XX/24",
      "DestinationType": "net",
      "DestPort": "80",
      "IpVersion": 6,
      "AclAction": "accept",
      "Release": "true",
      "ApplicationId": "10***",
      "DestinationGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "DestPortGroupPorts": [
        "80/80"
      ],
      "SourceGroupCidrs": [
        "192.0.XX.XX/24"
      ],
      "ApplicationNameList": [
        "HTTP"
      ],
      "SpreadCnt": 10000,
      "CreateTime": 1761062400,
      "ModifyTime": 1761062400,
      "RepeatType": "Permanent",
      "RepeatDays": [
        1
      ],
      "RepeatStartTime": "08:00",
      "RepeatEndTime": "23:30",
      "StartTime": 1694761200,
      "EndTime": 1694764800,
      "DomainResolveType": "FQDN"
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    400ErrorParametersUidThe aliUid parameter is invalid.aliUid 不合法
    400ErrorParametersPageSizeOrNoEither pageSize or pageNo is invalid.无效的pageSize或者pageNo
    400ErrorParameterIpVersionThe IP version is invalid.IP版本参数错误
    400ErrorParametersDirectionThe direction is invalid.无效的方向
    400ErrorDBSelectAn error occurred while querying database.内部错误：数据库查询错误
    400ErrorUnmarshalJSONAn error occurred while parsing JSON.内部错误：JSON解码错误
    400ErrorUUIDNewThe UUID is invalid.内部错误：UUID错误
    400ErrorParametersAppIdThe AppId parameter is incorrect.AppId不正确
    400ErrorParametersSourceThe source is invalid.无效的来源
    400ErrorDomainResolveAn error occurred while resolving the domain.域名解析错误
    400ErrorParametersDestinationThe Destination parameter is invalid.Destination参数非法
    400ErrorParametersProtoThe protocol is invalid.无效的协议
    400ErrorParametersDestPortThe dst_port is invalid.无效的目的端口
    400ErrorParametersActionThe action is invalid.无效的动作
    400ErrorParametersParameters error.参数错误。
    400ErrorMarshalJSONAn error occurred while encoding JSON.内部错误：JSON编码错误

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

    变更历史

    变更时间变更内容概要操作
    2024-07-31OpenAPI 错误码发生变更查看变更详情
    2024-07-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-10-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情