文档首页/云防火墙 CFW/API参考（安卡拉区域）/API/IPS管理/IPS特性开关操作
更新时间：2024-12-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

IPS特性开关操作

功能介绍

切换开关状态

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/ips/switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

project_id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目id，用户支持企业项目后，由企业项目生成的id。

fw_instance_id

否

String

防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

X-Language

否

String

语言头部，默认为zh-cn，如需使用英文，请选择en-us

表4 请求Body参数

参数

是否必选

参数类型

描述

object_id

是

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。

ips_type

是

Integer

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

status

是

Integer

ips特性开关状态

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

data

data object

object

表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" : 1,
  "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48",
  "status" : 1
}

响应示例

状态码： 200

OK

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

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题：IPS管理