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

获取防火墙反病毒规则信息

功能介绍

获取防火墙反病毒规则信息

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/anti-virus/rule

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

engine_type

是

Integer

防火墙类型

limit

是

Integer

每页显示的数据量

offset

是

Integer

查询偏移量

enterprise_project_id

否

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

AntiVirusRuleVO object
表5 AntiVirusRuleVO

参数

参数类型

描述

id

String

name

String

scan_protocol_configs

Array of ScanProtocolConfig objects

total

Integer
表6 ScanProtocolConfig

参数

参数类型

描述

action

Integer

反病毒动作，0：观察 1：拦截 2：禁用

protocol_type

Integer

协议类型

请求示例

查询项目id为408972e72dcd4c1a9b033e955802a36b的防病毒规则，防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf，企业项目id为fb55459c-41b3-47fc-885d-540946fddda4，目标对象id为1b90f031-0c7b-4f25-95e2-b6d9940d269e，引擎类型为1。查询结果限制为50条，偏移量为0。

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

响应示例

状态码： 200

OK

{
  "data" : {
    "scan_protocol_configs" : [ {
      "action" : 0,
      "protocol_type" : 0
    }, {
      "action" : 1,
      "protocol_type" : 1
    }, {
      "action" : 2,
      "protocol_type" : 2
    }, {
      "action" : 2,
      "protocol_type" : 4
    }, {
      "action" : 2,
      "protocol_type" : 3
    }, {
      "action" : 2,
      "protocol_type" : 6
    }, {
      "action" : 2,
      "protocol_type" : 5
    } ],
    "total" : 7
  }
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 反病毒管理

相关文档