文档首页/ 云防火墙 CFW/ API参考/ API/ 流量过滤/ 获取流量过滤功能的开关信息
更新时间:2025-08-12 GMT+08:00

获取流量过滤功能的开关信息

功能介绍

流量过滤功能可以打开或者关闭,通过此接口可以获取当前的开关信息。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/ptf/ip-blacklist/switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,可以通过调用API获取,也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

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

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

IpBlacklistSwitchInfoVo object

包含IP黑名单功能的开关信息

表4 IpBlacklistSwitchInfoVo

参数

参数类型

描述

status

Integer

IP黑名单功能开关信息 1:enable 0:disable

请求示例

查询project id为eefb11b22d5944f2aa067954516df1cf、instance id为e494f486-fa6f-410e-9cfa-8edacfb28970的防火墙的IP黑名单开关信息,查询到的结果是功能开启。

https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/ptf/ip-blacklist/switch?fw_instance_id=e494f486-fa6f-410e-9cfa-8edacfb28970

响应示例

状态码:200

返回流量过滤功能开关信息的响应体

{
  "data" : {
    "status" : 1
  }
}

状态码

状态码

描述

200

返回流量过滤功能开关信息的响应体

401

Unauthorized,错误的请求

403

Forbidden,禁止访问

错误码

请参见错误码