:original_name: ListIpsProtectMode.html
.. _ListIpsProtectMode:
Querying the Protection Mode
============================
Function
--------
This API is used to query the protection mode.
URI
---
GET /v1/{project_id}/ips/protect
.. table:: **Table 1** Path Parameters
========== ========= ====== ===========
Parameter Mandatory Type Description
========== ========= ====== ===========
project_id Yes String Project ID
========== ========= ====== ===========
.. table:: **Table 2** Query Parameters
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. |
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
.. table:: **Table 3** Request header parameters
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+====================================================================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------
**Status code: 200**
.. table:: **Table 4** Response body parameters
+-----------+----------------------------------------------------------------------------------------+----------------------+
| Parameter | Type | Description |
+===========+========================================================================================+======================+
| data | :ref:`IpsProtectModeObject ` object | IpsProtectModeObject |
+-----------+----------------------------------------------------------------------------------------+----------------------+
.. _listipsprotectmode__response_ipsprotectmodeobject:
.. table:: **Table 5** IpsProtectModeObject
+-----------+---------+-----------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+=========+=========================================================================================+
| id | String | ips protect mode id |
+-----------+---------+-----------------------------------------------------------------------------------------+
| mode | Integer | IPS protection mode. 0: observation mode; 1: strict mode; 2: medium mode; 3: loose mode |
+-----------+---------+-----------------------------------------------------------------------------------------+
**Status code: 400**
.. table:: **Table 6** Response body parameters
+-----------------------+-----------------------+-----------------------+
| Parameter | Type | Description |
+=======================+=======================+=======================+
| error_code | String | Error code |
| | | |
| | | Minimum: **8** |
| | | |
| | | Maximum: **36** |
+-----------------------+-----------------------+-----------------------+
| error_msg | String | Description |
| | | |
| | | Minimum: **2** |
| | | |
| | | Maximum: **512** |
+-----------------------+-----------------------+-----------------------+
Example Requests
----------------
Query the IPS protection mode of the project whose ID is 9d80d070b6d44942af73c9c3d38e0429.
.. code-block::
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2
Example Responses
-----------------
**Status code: 400**
Bad Request
.. code-block::
{
"error_code" : "CFW.0020016",
"error_msg" : "instance status error"
}
Status Codes
------------
=========== =====================
Status Code Description
=========== =====================
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
=========== =====================
Error Codes
-----------
See :ref:`Error Codes `.