Add Log Config

Function

This API is used to add log config.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**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, which can be obtained by calling the ListFirewallList.

Request Parameters

**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 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, which can be obtained by calling the Querying All Log Groups of an Account API
lts_attack_log_stream_id	No	String	Lts attack log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API
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, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API
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, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API
lts_flow_log_stream_enable	Yes	Integer	whether to enable flow log streaming

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
data	String	Firewall instance Id

Example Requests

Add a log flow configuration to the firewall whose firewall instance id is 4d6c860a-0338-49e8-ac64-fcaeb4182ba5 and project id is 408972e72dcd4c1a9b033e955802a36b with LTS group ID 20282428-a8f9-4e75-8246-165e64cf8ba8, and the access control log flow is disabled, the traffic log flow is disabled, the attack log flow is disabled, and the LTS is disabled.

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4d6c860a-0338-49e8-ac64-fcaeb4182ba5&enterprise_project_id=default

{
  "fw_instance_id" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5",
  "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

Add Log Config Response

{
  "data" : "4d6c860a-0338-49e8-ac64-fcaeb4182ba5"
}

Status Codes

Status Code	Description
200	Add Log Config Response

Error Codes

See Error Codes <errorcode>.

23 KiB Raw Blame History