CreateEventExportJob
功能介绍
参数解释:
下发自定义导出攻击事件的异步任务
约束限制:
不涉及
取值范围:
不涉及
默认取值:
不涉及
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/waf/event/job/export
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 租户token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
Content-Type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
recent |
是 |
String |
参数解释: 查询日志的时间范围,如1day(1天)、1week(1周)、1month(1个月) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
ids |
否 |
Array of strings |
参数解释: 查询指定事件ID列表的日志,仅导出包含这些ID的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
nids |
否 |
Array of strings |
参数解释: 查询不包含事件ID列表的日志,排除这些ID对应的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
attacks |
否 |
Array of strings |
参数解释: 查询指定攻击类型列表的日志,仅导出这些类型的攻击事件(如SQL注入、XSS等) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
nattacks |
否 |
Array of strings |
参数解释: 查询不包含攻击类型列表的日志,排除这些类型的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
rules |
否 |
Array of strings |
参数解释: 查询指定命中的规则id列表的日志,仅导出命中这些规则的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
nrules |
否 |
Array of strings |
参数解释: 查询不包含命中的规则id列表的日志,排除命中这些规则的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
sip |
否 |
String |
参数解释: 查询指定源ip(模糊查询),导出包含该IP(模糊匹配)的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
url |
否 |
String |
参数解释: 查询指定攻击的url(模糊查询),导出包含该URL(模糊匹配)的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
sips |
否 |
Array of strings |
参数解释: 查询指定源ip列表的日志,仅导出这些IP对应的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
nsips |
否 |
Array of strings |
参数解释: 查询不包含源ip列表的日志,排除这些IP对应的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
urls |
否 |
Array of strings |
参数解释: 查询指定攻击的url链接列表的日志,仅导出这些URL对应的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
nurls |
否 |
Array of strings |
参数解释: 查询不包含攻击的url链接列表的日志,排除这些URL对应的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
actions |
否 |
Array of strings |
参数解释: 查询指定防护动作列表的日志,仅导出执行这些动作的攻击事件(如block-拦截、log-日志) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
nactions |
否 |
Array of strings |
参数解释: 查询不包含防护动作列表的日志,排除执行这些动作的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
hosts |
否 |
Array of strings |
参数解释: 查询指定host列表的日志,仅导出这些域名对应的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
instances |
否 |
Array of strings |
参数解释: 查询指定instance列表的日志,仅导出这些实例对应的攻击事件 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
dump_columns |
是 |
Array of strings |
参数解释: 需要导出的列名称,指定攻击事件日志中需要导出的字段(如时间、事件ID、攻击类型等) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 异步任务的状态,如RUNNING(运行中)、SUCCESS(成功)、FAILED(失败) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
message |
String |
参数解释: 异步任务的描述,说明当前任务的进展或结果 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
job_id |
String |
参数解释: 异步任务的ID,用于查询任务进度或结果的唯一标识 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
参数解释: OK 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
400 |
参数解释: 请求失败 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
401 |
参数解释: token权限不足 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
500 |
参数解释: 服务器内部错误 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
错误码
请参见错误码。