Help Center/ Web Application Firewall/ API Reference/ APIs/ Managing Events/ Delivering an Asynchronous Task to Export Attack Events
Updated on 2026-05-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Delivering an Asynchronous Task to Export Attack Events

Function

This API is used to deliver an asynchronous task to export attack events.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain it, log in to the Huawei Cloud console, click the username, choose My Credentials, and find the project ID in the Projects list.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are supported.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

recent

Yes

String

Definition

Time range for querying logs. 1week: a one-week period. 1month: a one-month period.

Constraints

N/A

Range

  • yesterday

  • today

  • 3days

  • 1week

  • 1month

Default Value

N/A

ids

No

Array of strings

Definition

IDs of the events you want to query and export the corresponding logs.

Constraints

N/A

Range

N/A

Default Value

N/A

nids

No

Array of strings

Definition

IDs of the events you want to exclude from the query results.

Constraints

N/A

Range

N/A

Default Value

N/A

attacks

No

Array of strings

Definition

Attack types by which you want to query and export only the attack events of the specified types (such as SQL injection and XSS).

Constraints

N/A

Range

N/A

Default Value

N/A

nattacks

No

Array of strings

Definition

IDs of the attack events you want to exclude from the query results.

Constraints

N/A

Range

N/A

Default Value

N/A

rules

No

Array of strings

Definition

IDs of included rules. Only events matching these rules will be queried and exported.

Constraints

N/A

Range

N/A

Default Value

N/A

nrules

No

Array of strings

Definition

IDs of excluded rules. Events matching these rules will be excluded from the query and export.

Constraints

N/A

Range

N/A

Default Value

N/A

sip

No

String

Definition

Source IP address for fuzzy query. Events containing the specified IP address (fuzzy match) will be exported.

Constraints

N/A

Range

N/A

Default Value

N/A

url

No

String

Definition

Attacked URL for fuzzy query. Events containing the specified URL (fuzzy match) will be exported.

Constraints

N/A

Range

N/A

Default Value

N/A

sips

No

Array of strings

Definition

Source IP address list for the query. Only attack events corresponding to these IP addresses will be exported.

Constraints

N/A

Range

N/A

Default Value

N/A

nsips

No

Array of strings

Definition

Excluded source IP address list for the query. Attack events corresponding to these IP addresses will be excluded from the export result.

Constraints

N/A

Range

N/A

Default Value

N/A

urls

No

Array of strings

Definition

URLs for the query. Only attack events corresponding to these URLs will be exported.

Constraints

N/A

Range

N/A

Default Value

N/A

nurls

No

Array of strings

Definition

Excluded URLs for the query. Attack events related to those URLs will be excluded from the export result.

Constraints

N/A

Range

N/A

Default Value

N/A

actions

No

Array of strings

Definition

Protective actions for the query. Only attack events handled with these protective actions (such as block and log) will be exported.

Constraints

N/A

Range

N/A

Default Value

N/A

nactions

No

Array of strings

Definition

Excluded protective actions for the query. Attack events handled with these protective actions will be excluded from the export result.

Constraints

N/A

Range

N/A

Default Value

N/A

hosts

No

Array of strings

Definition

Hosts for the query. Only attack events corresponding to these domains will be exported.

Constraints

N/A

Range

N/A

Default Value

N/A

instances

No

Array of strings

Definition

Instance list for the query. Only attack events corresponding to these instances will be exported.

Constraints

N/A

Range

N/A

Default Value

N/A

dump_columns

Yes

Array of strings

Definition

Name of the column to be exported, which specifies the fields (such as the time, event ID, and attack type) to be exported from the attack event logs.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition

Status of the asynchronous task, for example, RUNNING, SUCCESS, or FAILED.

Constraints

N/A

Range

N/A

Default Value

N/A

message

String

Definition

Description of the asynchronous task, which indicates the progress or result of the current task.

Constraints

N/A

Range

N/A

Default Value

N/A

job_id

String

Definition

ID of an asynchronous task, which uniquely identifies the task progress or result.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.
Table 6 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.
Table 8 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.
Table 10 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

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

Example Responses

Status code: 200

Definition

OK

Constraints

N/A

Range

N/A

Default Value

N/A

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

SDK Sample Code

The SDK sample code is as follows.

 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
 
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();
        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
 
# 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()
        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
40
41
42
43
44
45
46
47
48
49
 
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := waf.WafClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := waf.NewWafClient(hcClient)

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

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Definition

OK

Constraints

N/A

Range

N/A

Default Value

N/A

400

Definition

Request failed.

Constraints

N/A

Range

N/A

Default Value

N/A

401

Definition

The token does not have required permissions.

Constraints

N/A

Range

N/A

Default Value

N/A

500

Definition

Internal server error.

Constraints

N/A

Range

N/A

Default Value

N/A

Error Codes

See Error Codes.

Parent Topic: Managing Events