查询IPS特性开关状态
功能介绍
查询IPS特性开关状态
URI
GET /v1/{project_id}/ips/switch
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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（.表示各对象之间层级的区分）获得。 |
| enterprise_project_id | 否 | String | 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 |
| fw_instance_id | 否 | String | 防火墙id，可通过防火墙ID获取方式获取 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。可通过如何获取用户Token获取。 |
| Content-Type | 是 | String | 内容类型，只有application/json的值是适用的 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | IpsSwitchResponseDTO object | 查询ips开关返回值数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | ips开关id，此处为互联网边界防护对象id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得 |
| basic_defense_status | Integer | 基础防御状态，0表示关闭，1表示开启 |
| virtual_patches_status | Integer | 虚拟补丁状态，0表示关闭，1表示开启 |
请求示例
通过租户id14181c1245cf4fd786824efe1e2b9388查询当前租户的补丁开启状态，用来加载入侵防御页面的虚拟补丁的开关状态。
https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2 响应示例
状态码：200
查询ips开关返回值
{
"data" : {
"basic_defense_status" : 1,
"id" : "cefe80aa-83e4-4308-99aa-f9b6c816de00",
"virtual_patches_status" : 0
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询ips开关返回值 |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
错误码
请参见错误码。
