文档首页/ 云防火墙 CFW/ API参考 (联盟区域) / API/ IPS管理/ IPS特性开关操作
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

IPS特性开关操作

功能介绍

切换开关状态

URI

POST /v1/{project_id}/ips/switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

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

fw_instance_id

否

String

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

内容类型，只有application/json的值是适用的
表4 请求Body参数

参数

是否必选

参数类型

描述

object_id

是

String

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

ips_type

是

Integer

补丁类型，仅支持虚拟补丁，值为2。

status

是

Integer

ips特性开关状态，0表示关闭，1表示开启

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

data

data object

修改ips防护模式返回值数据
表6 data

参数

参数类型

描述

id

String

防护对象id

请求示例

ips开关接口，该接口是租户界面通过开关控制引擎的基础补丁和虚拟补丁的开闭状态。以下示例为开启项目id为14181c1245cf4fd786824efe1e2b9388，防护对象id为1530de8a-522d-4771-9067-9fa4e2f53b48的虚拟补丁开关。

https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default

{
  "ips_type" : 2,
  "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48",
  "status" : 1
}

响应示例

状态码：200

修改IPS开关返回值

{
  "data" : {
    "id" : "1530de8a-522d-4771-9067-9fa4e2f53b48"
  }
}

状态码

状态码

描述

200

修改IPS开关返回值

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： IPS管理