ListPolicy - 查询防护策略

更新时间: 2024-09-29 14:23:23

查询防护策略。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Namestring

策略名称。

test**
Typestring

策略类型。取值:

  • default:表示默认防护策略。

  • l3:表示 IP 防护策略。

  • l4:表示端口防护策略。

l3
PageNolong

分页查询时,设置当前页面的页码。

1
PageSizelong

分页查询时每页的行数。默认值为 10

10
ProductTypestring

适用产品类型。取值

  • ecs:表示对于查询适用于 ecs 的默认策略。

  • slb:表示对于查询适用于 slb 的默认策略。

  • eip:表示对于查询适用于 eip 的默认策略。

  • gf-eip:表示对于查询适用于高防 EIP 的默认策略。

说明 仅对策略类型为 default生效。
ecs

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

B4B379C2-9319-4C6B-B579-FE36831B09F4
PolicyListarray<object>

策略列表。

policyListobject

策略列表。

Idstring

策略 ID。

877afbdf-3982-4d36-9886-f043********
Namestring

策略名称。

test**
Typestring

策略类型。取值:

  • default:表示默认防护策略。
  • l3:表示 IP 防护策略。
  • l4:表示端口防护策略。
l3
Remarkstring

策略备注。

test
AttachedCountinteger

策略关联的防护对象数量。

0
Contentobject

策略内容。

BlackIpListExpireAtlong

IP 黑名单超时时间(unix 时间戳)。

1716878000
EnableIntelligenceboolean

是否开启 AI 智能防护。

true
IntelligenceLevelstring

AI 智能防护的防护等级。取值:

  • default:表示正常。
  • hard:表示严格。
  • weak:表示宽松。
default
WhitenGfbrNetsboolean

是否开启 DDoS 高防(中国内地&非中国内地)回源地址加白。

false
EnableDropIcmpboolean

是否禁用 ICMP 协议。

false
RegionBlockCountryListarray

区域封禁的国家列表。

regionBlockCountryListinteger

区域封禁的国家代号。

11
RegionBlockProvinceListarray

区域封禁的省份列表。

regionBlockProvinceListinteger

区域封禁的省份代号。

2
SourceLimitobject

源限速。

Ppsinteger

源 PPS 限速,单位 Packet/s。

64
Bpsinteger

源带宽限速,单位 Byte/s。

2048
SynPpsinteger

源 SYN PPS 限速,单位 Packet/s。

64
SynBpsinteger

源 SYN 带宽限速,单位 Byte/s。

2048
SourceBlockListarray<object>

源限速拉黑列表。

sourceBlockListobject

源限速拉黑列表。

Typeinteger

源限速类型。取值:

  • 3:表示源 PPS 限速。

  • 4:表示源带宽限速。

  • 5:表示源 SYN PPS 限速。

  • 6:表示源 SYN 带宽限速。

3
BlockExpireSecondsinteger

源 IP 加入黑名单的时长。单位秒。

120
EverySecondsinteger

源限速拉黑的统计周期,单位秒。

60
ExceedLimitTimesinteger

源 IP 在 1 个统计周期内超过限速值的次数。

5
ReflectBlockUdpPortListarray

反射攻击防护过滤的端口列表。

reflectBlockUdpPortListinteger

反射攻击防护过滤的端口

123
PortRuleListarray<object>

端口封禁规则列表。

portRuleListobject

端口封禁规则列表。

Idstring

规则 ID。

8f3c3062-6c20-425d-8405-2bd1********
Protocolstring

协议类型,取值:

  • tcp:表示传输控制协议。
  • udp:表示用户数据报协议。
udp
SrcPortStartinteger

源端口范围的起始值。取值范围:0~65535

0
SrcPortEndinteger

源端口范围的结束值。取值范围:0~65535

65535
DstPortStartinteger

目的端口范围的起始值。取值范围:0~65535

0
DstPortEndinteger

目的端口范围的结束值。取值范围:0~65535

65535
MatchActionstring

匹配动作。取值:

  • drop:表示丢弃。
drop
SeqNointeger

生效顺序号,使用整数表示。

1
FingerPrintRuleListarray<object>

指纹过滤规则列表。

fingerPrintRuleListobject

指纹过滤规则列表。

Idstring

规则 ID。

2c0b09cd-a565-4481-9acb-418b********
Protocolstring

协议类型,取值:

  • tcp:表示传输控制协议。
  • udp:表示用户数据报协议。
udp
SrcPortStartinteger

源端口范围的开始值。取值范围:0~65535

0
SrcPortEndinteger

源端口范围的结束值。取值范围:0~65535

65535
DstPortStartinteger

目的端口范围的起始值。取值范围:0~65535

0
DstPortEndinteger

目的端口范围的结束值。取值范围:0~65535

65535
MinPktLeninteger

最小包长,取值范围:1~1500

1
MaxPktLeninteger

最大包长,取值范围:1~1500

1500
Offsetinteger

偏移量,取值范围:0~1500

0
PayloadBytesstring

检测载荷。使用十六进制字符串格式表示。

abcd
MatchActionstring

匹配动作。取值:

  • accept:表示放行满足指纹特征的流量。
  • drop:表示丢弃满足指纹特征的流量。
  • ip_rate:表示对满足指纹特征的流量来源 IP 进行访问限速。限速值通过 RateValue 参数设置。
  • session_rate:表示对满足指纹特征的流量来源会话进行访问限速。限速值通过 RateValue 参数设置。
drop
RateValueinteger

限速值。取值范围:1~100000

说明 匹配后动作为源 IP 限速或者源 Session 限速时(匹配动作ip_ratesession_rate),必须填写该参数。
1000
SeqNointeger

生效顺序号,使用整数表示。

1
EnableL4Defenseboolean

是否开启端口防护。

true
L4RuleListarray<object>

端口防护规则列表。

l4RuleListobject

端口防护规则列表。

Namestring

规则名称。

test**
Priorityinteger

规则优先级。

1
Methodstring

规则类型。取值:

  • char:表示字符串匹配。

  • hex:表示十六进制匹配。

char
Matchstring

逻辑符。取值:

  • 0:表示命中执行动作。

  • 1:表示未命中执行动作。

1
Actionstring

动作。取值:

  • 2: 表示丢弃。
2
Limitedinteger

会话流启动规则匹配的最小字节数,取值范围:0~2048

0
ConditionListarray<object>

检测条件列表。

conditionListobject

检测条件列表。

Argstring

检测内容。

说明 规则类型为 char,必须为 ACSII 字符串;规则类型为 hex,必须为十六进制字符串。最大长度 2048。
test
Positioninteger

检测起始位置,取值范围:0~2047

0
Depthinteger

检测窗口长度,取值范围:1~2048

32
Totallong

策略总数。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "B4B379C2-9319-4C6B-B579-FE36831B09F4",
  "PolicyList": [
    {
      "Id": "877afbdf-3982-4d36-9886-f043********",
      "Name": "test**",
      "Type": "l3",
      "Remark": "test",
      "AttachedCount": 0,
      "Content": {
        "BlackIpListExpireAt": 1716878000,
        "EnableIntelligence": true,
        "IntelligenceLevel": "default",
        "WhitenGfbrNets": false,
        "EnableDropIcmp": false,
        "RegionBlockCountryList": [
          11
        ],
        "RegionBlockProvinceList": [
          2
        ],
        "SourceLimit": {
          "Pps": 64,
          "Bps": 2048,
          "SynPps": 64,
          "SynBps": 2048
        },
        "SourceBlockList": [
          {
            "Type": 3,
            "BlockExpireSeconds": 120,
            "EverySeconds": 60,
            "ExceedLimitTimes": 5
          }
        ],
        "ReflectBlockUdpPortList": [
          123
        ],
        "PortRuleList": [
          {
            "Id": "8f3c3062-6c20-425d-8405-2bd1********",
            "Protocol": "udp",
            "SrcPortStart": 0,
            "SrcPortEnd": 65535,
            "DstPortStart": 0,
            "DstPortEnd": 65535,
            "MatchAction": "drop",
            "SeqNo": 1
          }
        ],
        "FingerPrintRuleList": [
          {
            "Id": "2c0b09cd-a565-4481-9acb-418b********",
            "Protocol": "udp",
            "SrcPortStart": 0,
            "SrcPortEnd": 65535,
            "DstPortStart": 0,
            "DstPortEnd": 65535,
            "MinPktLen": 1,
            "MaxPktLen": 1500,
            "Offset": 0,
            "PayloadBytes": "abcd",
            "MatchAction": "drop",
            "RateValue": 1000,
            "SeqNo": 1
          }
        ],
        "EnableL4Defense": true,
        "L4RuleList": [
          {
            "Name": "test**",
            "Priority": 1,
            "Method": "char",
            "Match": "1",
            "Action": "2",
            "Limited": 0,
            "ConditionList": [
              {
                "Arg": "test",
                "Position": 0,
                "Depth": 32
              }
            ]
          }
        ]
      }
    }
  ],
  "Total": 10
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-13OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
上一篇: ModifyPolicyContent - 修改防护策略内容 下一篇: AttachToPolicy - 防护对象关联防护策略
阿里云首页 DDoS防护 相关技术圈