文档首页/ 云防火墙 CFW/ API参考/ API/ IPS管理/ 查询频率ips规则信息
更新时间：2024-12-25 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询频率ips规则信息

功能介绍

查询频率ips规则信息

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/advanced-ips-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，可以从调API处获取，也可以从控制台获取。可通过项目ID获取方式获取
表2 Query参数

参数

是否必选

参数类型

描述

object_id

是

String

防护对象ID，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为1的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，可通过如何获取用户Token获取

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

AdvancedIpsRuleListVo object
表5 AdvancedIpsRuleListVo

参数

参数类型

描述

advanced_ips_rules

Array of AdvancedIpsRuleVo objects

total

Integer
表6 AdvancedIpsRuleVo

参数

参数类型

描述

action

Integer

动作：0表示仅记录日志、1表示拦截session、2表示拦截ip

ips_rule_id

String

高级ips规则id

ips_rule_type

Integer

ips规则类型：0表示敏感目录扫描、1表示反弹xshell

param

String

包含特殊参数的JSON字符串

status

Integer

请求示例

查询项目id为408972e72dcd4c1a9b033e955802a36b的频率IPS规则信息，防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf，企业项目id为fb55459c-41b3-47fc-885d-540946fddda4，目标对象id为1b90f031-0c7b-4f25-95e2-b6d9940d269e。

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/advanced-ips-rules?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4&object_id=1b90f031-0c7b-4f25-95e2-b6d9940d269e

响应示例

状态码： 200

OK

{
  "data" : {
    "advanced_ips_rules" : [ {
      "action" : 0,
      "ips_rule_id" : "7d453586-524f-4a1d-a827-34d80389378f",
      "ips_rule_type" : 0,
      "param" : "{\"mode\":0}",
      "status" : 1
    }, {
      "action" : 0,
      "ips_rule_id" : "ed184f33-b4e2-4c42-9562-313563e60b7c",
      "ips_rule_type" : 1,
      "param" : "{\"threshold\":10}",
      "status" : 1
    } ],
    "total" : 2
  }
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： IPS管理

相关文档