文档首页/云防火墙 CFW/API参考 (联盟区域) /API/日志管理/获取日志配置
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取日志配置

功能介绍

获取日志配置

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

是

String

防火墙id，可通过防火墙ID获取方式获取

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

Content-Type

是

String

内容类型，只有application/json的值是适用的

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

LogConfigDto object

日志配置数据

表5 LogConfigDto

参数

参数类型

描述

fw_instance_id

String

防火墙id，可通过防火墙ID获取方式获取

lts_enable

Integer

是否开启LTS，1表示是，0表示不是，Whether to enable LTS: 1 (yes), 0 (no). If the parameter is set to 1 then parameters lts_attack_log_stream_enable, lts_access_log_stream_enable, lts_flow_log_stream_enable must be mandatory

lts_log_group_id

String

LTS日志分组id,可通过查询LTS（云日志服务）下查询账号下所有日志组接口获得，通过返回值中的log_groups.log_group_id（.表示各对象之间层级的区分）获得

lts_attack_log_stream_id

String

攻击日志流id,可通过查询LTS（云日志服务）下查询指定日志组下的所有日志流接口获得，通过返回值中的log_streams.log_stream_id（.表示各对象之间层级的区分）获得

lts_attack_log_stream_enable

Integer

是否开启攻击日志流，1表示是，0表示不是

lts_access_log_stream_id

String

访问控制日志流id,可通过查询LTS（云日志服务）下查询指定日志组下的所有日志流接口获得，通过返回值中的log_streams.log_stream_id（.表示各对象之间层级的区分）获得

lts_access_log_stream_enable

Integer

是否开启访问控制流，1表示是，0表示不是

lts_flow_log_stream_id

String

流量日志id,可通过查询LTS（云日志服务）下查询指定日志组下的所有日志流接口获得，通过返回值中的log_streams.log_stream_id（.表示各对象之间层级的区分）获得

lts_flow_log_stream_enable

Integer

是否开启流量日志，1表示是，0表示不是

请求示例

查询项目id为408972e72dcd4c1a9b033e955802a36b下的防火墙id为4e113415-7811-4bb3-bf5e-eb835953f7d4的防火墙的日志配置。

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4e113415-7811-4bb3-bf5e-eb835953f7d4&enterprise_project_id=default

响应示例

状态码：200

查询日志配置返回值

{
  "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"
  }
}

状态码

状态码

描述

200

查询日志配置返回值

错误码

请参见错误码。

父主题：日志管理