查询安全报告模板列表
功能介绍
查询安全报告模板列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/report-profile
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
category |
否 |
String |
参数解释: 报告类型 约束限制: 不涉及 取值范围: daily 日报 weekly 周报 custom 自定义报告 默认取值: 不涉及 |
fw_instance_id |
是 |
String |
参数解释: 防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
limit |
是 |
Integer |
参数解释: 查询返回记录的数量限制 约束限制: 不涉及 取值范围: 1-1024 默认取值: 不涉及 |
offset |
是 |
Integer |
参数解释: 偏移量,表示查询该偏移量后面的记录 约束限制: 不涉及 取值范围: 0 - 1024 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
参数解释: 查询模板列表响应 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
limit |
Integer |
参数解释: 数量限制 取值范围: 不涉及 |
offset |
Integer |
参数解释: 偏移量 取值范围: 不涉及 |
records |
Array of ReportProfileVO objects |
参数解释: 模板列表 取值范围: 不涉及 |
total |
Integer |
参数解释: 总数 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
profile_id |
String |
参数解释: 模板ID 取值范围: 不涉及 |
name |
String |
参数解释: 模板名称 取值范围: 不涉及 |
category |
String |
参数解释: 模板类型 取值范围: daily 日报 weekly 周报 custom 自定义报告 |
status |
Integer |
参数解释: 启用状态 取值范围: 不涉及 |
report_id |
String |
参数解释: 最新的报告的ID 取值范围: 不涉及 |
last_time |
Long |
参数解释: 最新的报告的生成时间 取值范围: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
查询项目ID为eb7accd78ea845078275b2ad5280a109防火墙ID为8a996d43-75bd-48b4-b1b8-de0706b72b8f安全报告模板列表,偏移量为0,返回数量限制为10
https://{Endpoint}/v1/eb7accd78ea845078275b2ad5280a109/report-profile?fw_instance_id=8a996d43-75bd-48b4-b1b8-de0706b72b8f&offset=0&limit=10
响应示例
状态码:200
OK
{ "data" : { "limit" : 10, "offset" : 0, "records" : [ { "profile_id" : "53a9d352-4b35-4703-801a-0dbcfc306fc5", "name" : "test", "category" : "custom", "status" : 1, "report_id" : "2ff069b3-1ef8-4a6e-9aaf-d7308eeba826", "last_time" : 1749814939598 } ], "total" : 1 } }
状态码:400
Bad Request
{ "error_code" : "CFW.00200003", "error_msg" : "参数错误" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。