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

获取ips规则列表

功能介绍

获取ips规则列表

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/ips-rule

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

参数

是否必选

参数类型

描述

affected_application_like

否

Integer

攻击对象

create_time

否

Integer

创建时间

fw_instance_id

否

String

防火墙ID，可通过防火墙ID获取方式获取

ips_cve_like

否

Integer

cve

ips_group

否

Integer

ips组

ips_id

否

String

ips规则id

ips_level

否

Integer

ips等级

ips_name_like

否

String

ips规则名称

ips_rules_type_like

否

Integer

ips规则类型

ips_status

否

String

ips规则状态

is_updated_ips_rule_queried

否

Boolean

是否查新更新规则

limit

是

Integer

分页查询数据量限制

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（.表示各对象之间层级的区分）获得。

offset

是

Integer

查询偏移量

enterprise_project_id

否

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

IpsRuleListVO object
表5 IpsRuleListVO

参数

参数类型

描述

fw_instance_id

String

limit

Integer

object_id

String

offset

Integer

records

Array of IpsRuleVO objects

total

Integer
表6 IpsRuleVO

参数

参数类型

描述

affected_application

String

create_time

String

default_status

String

ips_cve

String

ips_group

String

ips_id

String

ips_level

String

ips_name

String

ips_rules_type

String

ips_status

String

请求示例

获取项目id为eefb11b22d5944f2aa067954516df1cf的IPS规则列表，防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf，企业项目id为fb55459c-41b3-47fc-885d-540946fddda4，目标对象id为1b90f031-0c7b-4f25-95e2-b6d9940d269e。查询结果限制为1000条，偏移量为0。

https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/ips-rule?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4&project_id=eefb11b22d5944f2aa067954516df1cf&object_id=1b90f031-0c7b-4f25-95e2-b6d9940d269e&limit=1000&offset=0

响应示例

状态码： 200

OK

{
  "data" : {
    "fw_instance_id" : "e743cfaf-8164-4807-aa13-d893d83313cf",
    "limit" : 1000,
    "offset" : 1,
    "records" : [ {
      "affected_application" : "Others",
      "create_time" : "2015",
      "default_status" : "CLOSE",
      "ips_group" : "STRICTLY",
      "ips_id" : "340710",
      "ips_level" : "MEDIUM",
      "ips_name" : "WEBC2-QBP登录响应1 - 嵌入式CnC APT1相关",
      "ips_rules_type" : "特洛伊木马",
      "ips_status" : "CLOSE"
    }, {
      "affected_application" : "Others",
      "create_time" : "2015",
      "default_status" : "CLOSE",
      "ips_group" : "STRICTLY",
      "ips_id" : "340922",
      "ips_level" : "MEDIUM",
      "ips_name" : "Win32/Fujacks活动",
      "ips_rules_type" : "特洛伊木马",
      "ips_status" : "CLOSE"
    } ],
    "total" : 2
  }
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： IPS管理

相关文档