更新时间:2025-12-29 GMT+08:00

创建日志配置

功能介绍

创建日志配置

URI

POST /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的值是适用的

表4 请求Body参数

参数

是否必选

参数类型

描述

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表示不是

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

data

String

添加日志配置返回值,为防火墙id

请求示例

给项目id为408972e72dcd4c1a9b033e955802a36b下的防火墙4d6c860a-0338-49e8-ac64-fcaeb4182ba5添加日志流配置,lts分组id为20282428-a8f9-4e75-8246-165e64cf8ba8,访问控制日志流关闭,流量日志流关闭,攻击日志流关闭,lts关闭。

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
}

响应示例

状态码:200

添加日志配置返回值

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

状态码

状态码

描述

200

添加日志配置返回值

错误码

请参见错误码