:original_name: UpdateLogConfig.html

.. _UpdateLogConfig:

Update Log Config
=================

Function
--------

This API is used to update log config.

URI
---

PUT /v1/{project_id}/cfw/logs/configuration

.. table:: **Table 1** Path Parameters

   ========== ========= ====== ===========
   Parameter  Mandatory Type   Description
   ========== ========= ====== ===========
   project_id Yes       String Project ID
   ========== ========= ====== ===========

.. table:: **Table 2** Query Parameters

   +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | Parameter             | Mandatory | Type   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
   +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
   | fw_instance_id        | Yes       | 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. |
   +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | enterprise_project_id | No        | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
   +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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. |
   +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+

.. table:: **Table 4** Request body parameters

   +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | Parameter                    | Mandatory | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
   +==============================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
   | fw_instance_id               | Yes       | 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. |
   +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | lts_enable                   | Yes       | Integer | whether to enable LTS                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
   +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | lts_log_group_id             | Yes       | String  | Lts log group id                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
   +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | lts_attack_log_stream_id     | No        | String  | Lts attack log stream id                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
   +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | lts_attack_log_stream_enable | Yes       | Integer | whether to enable attack log streaming                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | lts_access_log_stream_id     | No        | String  | Lts access log stream id                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
   +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | lts_access_log_stream_enable | Yes       | Integer | whether to enable access log streaming                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | lts_flow_log_stream_id       | No        | String  | Lts flow log stream id                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | lts_flow_log_stream_enable   | Yes       | Integer | whether to enable flow log streaming                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
   +------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Response Parameters
-------------------

**Status code: 200**

.. table:: **Table 5** Response body parameters

   ========= ====== =============
   Parameter Type   Description
   ========= ====== =============
   data      String Log Config Id
   ========= ====== =============

Example Requests
----------------

Update the log configuration of the firewall whose firewall instance id is 22c4a5db-504c-471f-8187-5192bc11de0b and project id is 408972e72dcd4c1a9b033e955802a36b, set LTS logs to disabled, and set flow logs, access control logs, and attack logs to disabled.

.. code-block::

   https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=22c4a5db-504c-471f-8187-5192bc11de0b&enterprise_project_id=default

   {
     "fw_instance_id" : "22c4a5db-504c-471f-8187-5192bc11de0b",
     "lts_enable" : 0,
     "lts_log_group_id" : "20282428-a8f9-4e75-8246-165e64cf8ba8",
     "lts_attack_log_stream_enable" : 0,
     "lts_access_log_stream_enable" : 0,
     "lts_flow_log_stream_enable" : 0
   }

Example Responses
-----------------

**Status code: 200**

Update Log Config Response

.. code-block::

   {
     "data" : "4e113415-7811-4bb3-bf5e-eb835953f7d4"
   }

Status Codes
------------

=========== ==========================
Status Code Description
=========== ==========================
200         Update Log Config Response
=========== ==========================

Error Codes
-----------

See :ref:`Error Codes <errorcode>`.