文档首页/ Web应用防火墙 WAF/ API参考/ API/ 事件管理/ 下发自定义导出攻击事件的异步任务 - CreateEventExportJob
更新时间:2025-11-28 GMT+08:00
分享

下发自定义导出攻击事件的异步任务 - CreateEventExportJob

功能介绍

下发自定义导出攻击事件的异步任务

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/waf/event/job/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。

约束限制:

不涉及

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

表3 请求Body参数

参数

是否必选

参数类型

描述

recent

String

参数解释:

查询日志的时间范围,如1week(1周)、1month(1个月)

约束限制:

不涉及

取值范围:

  • yesterday

  • today

  • 3days

  • 1week

  • 1month

默认取值:

不涉及

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

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

异步任务的状态,如RUNNING(运行中)、SUCCESS(成功)、FAILED(失败)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

message

String

参数解释:

异步任务的描述,说明当前任务的进展或结果

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

job_id

String

参数解释:

异步任务的ID,用于查询任务进度或结果的唯一标识

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表6 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表8 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

{
  "recent" : "today",
  "dump_columns" : [ "id" ]
}

响应示例

状态码:200

参数解释:

OK

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

{
  "status" : "RUNNING",
  "message" : "Checking domain name configuration",
  "job_id" : "f67a449d22634193a7edd4edb5b29ee5"
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class CreateEventExportJobSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateEventExportJobRequest request = new CreateEventExportJobRequest();
        AsyncJobReqBody body = new AsyncJobReqBody();
        request.withBody(body);
        try {
            CreateEventExportJobResponse response = client.createEventExportJob(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateEventExportJobRequest()
        request.body = AsyncJobReqBody(
        )
        response = client.create_event_export_job(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateEventExportJobRequest{}
	request.Body = &model.AsyncJobReqBody{
	}
	response, err := client.CreateEventExportJob(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

参数解释:

OK

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

400

参数解释:

请求失败

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

401

参数解释:

token权限不足

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

500

参数解释:

服务器内部错误

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

错误码

请参见错误码

相关文档