List Log Config
Function
This API is used to list log config.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/cfw/logs/configuration
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
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
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
Parameter |
Type |
Description |
---|---|---|
data |
LogConfigDto object |
Log Config Response |
Parameter |
Type |
Description |
---|---|---|
fw_instance_id |
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 |
Integer |
whether to enable LTS |
lts_log_group_id |
String |
Lts log group id |
lts_attack_log_stream_id |
String |
Lts attack log stream id |
lts_attack_log_stream_enable |
Integer |
whether to enable attack log streaming |
lts_access_log_stream_id |
String |
Lts access log stream id |
lts_access_log_stream_enable |
Integer |
whether to enable access log streaming |
lts_flow_log_stream_id |
String |
Lts flow log stream id |
lts_flow_log_stream_enable |
Integer |
whether to enable flow log streaming |
Example Requests
Query the log configuration of whose firewall instance id is 4e113415-7811-4bb3-bf5e-eb835953f7d4 and project id is 408972e72dcd4c1a9b033e955802a36b.
https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4e113415-7811-4bb3-bf5e-eb835953f7d4&enterprise_project_id=default
Example Responses
Status code: 200
List Log Config Response
{ "data" : { "fw_instance_id" : "4df2bcd1-6299-4fba-8e71-8d50ea807090", "lts_access_log_stream_enable" : 0, "lts_attack_log_stream_enable" : 0, "lts_enable" : 0, "lts_flow_log_stream_enable" : 0, "lts_log_group_id" : "d783ce42-7f56-4c2d-9a96-b1043d016f5a" } }
Status Codes
Status Code |
Description |
---|---|
200 |
List Log Config Response |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot