文档首页/ 云防火墙 CFW/ API参考/ API/ 安全报告/ 创建安全报告模板
更新时间:2025-08-12 GMT+08:00

创建安全报告模板

功能介绍

创建安全报告模板

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/report-profile

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

category

String

参数解释

报告类型

约束限制

不涉及

取值范围

daily 日报

weekly 周报

custom 自定义报告

默认取值

不涉及

description

String

参数解释

描述信息

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

name

String

参数解释

模板名称

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

send_period

Integer

参数解释

发送时间,日报和周报需要设置

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

send_week_day

Integer

参数解释

发送星期,周报需要设置

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

statistic_period

StatisticPeriod object

参数解释

统计周期,自定义报告需要设置

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

status

Integer

参数解释

启用状态

约束限制

不涉及

取值范围

0 关闭

1 启用

默认取值

不涉及

topic_urn

String

参数解释

通知群组

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

subscription_type

Integer

参数解释

通知方式

约束限制

不涉及

取值范围

0 SMN通知方式

1 不需要通知

默认取值

不涉及

表4 StatisticPeriod

参数

是否必选

参数类型

描述

end_time

Long

参数解释

结束时间

约束限制

不涉及

取值范围

毫秒级时间戳

默认取值

不涉及

start_time

Long

参数解释

结束时间

约束限制

不涉及

取值范围

毫秒级时间戳

默认取值

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

data

data object

参数解释

响应信息

取值范围

不涉及

表6 data

参数

参数类型

描述

id

String

参数解释

模板ID

取值范围

不涉及

name

String

参数解释

模板名称

取值范围

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

创建安全报告模板,项目ID为eb7accd78ea845078275b2ad5280a109,防火墙ID为8a996d43-75bd-48b4-b1b8-de0706b72b8f,模板名称为test,类型为日报,发送的topic名称为test,urn为urn:smn:cn-north-4:eb7accd78ea845078275b2ad5280a109:test,发送时间为每天0点

https://{Endpoint}/v1/eb7accd78ea845078275b2ad5280a109/report-profile?fw_instance_id=8a996d43-75bd-48b4-b1b8-de0706b72b8f

{
  "name" : "test",
  "category" : "daily",
  "topic_urn" : "urn:smn:cn-north-4:eb7accd78ea845078275b2ad5280a109:test",
  "send_period" : 0
}

响应示例

状态码:200

OK

{
  "data" : {
    "id" : "f9116386-4ef9-40b5-bc2e-bdd7c17b3650",
    "name" : "fgsd"
  }
}

状态码:400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码