Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Data Processing Job Management/ Querying the Data Processing Job List
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Data Processing Job List

Function

This API is used to query the list of data processing jobs.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/data-transformations

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Workspace ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Definition

Offset.

Constraints

N/A

Range

N/A

Default Value

N/A

limit

No

Long

Definition

Data query limit.

Range

0-1000

Default Value

N/A

output_table_id

No

String

Output table ID

data_transformation_name

No

String

Data transformation name

data_transformation_id

No

String

Data transformation ID

sort_key

No

String

Sorting by attribute.

sort_dir

No

String

Sorting order. The value can be ASC or DESC.

Request Parameters

Table 3 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. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Count

records

Array of DataTransformationItem objects

Record.
Table 5 DataTransformationItem

Parameter

Type

Description

data_transformation_id

String

UUID

data_transformation_name

String

Data transformation name

script

String

Job script.

status

String

Definition

Job status.

  • ENABLED

  • DISABLED

Constraints

N/A

Range

  • ENABLED

  • DISABLED

Default Value

N/A

directory

String

Directory group.

description

String

Data transformation description

job_mode

String

Definition

Job mode.

  • STREAMING: streaming processing

  • BATCH: batch processing

  • SEARCH: retrieval

Constraints

N/A

Range

  • STREAMING

  • BATCH

  • SEARCH

Default Value

N/A

process_status

String

Definition

Job processing status.

  • COMPLETED: completed.

  • CREATING: being created

  • UPDATING: being updated

  • ENABLING: being enabled

  • DISABLING: being disabled

  • DELETING: being deleted

  • CREATE_FAILED: creation failed

  • UPDATE_FAILED: update failed

  • ENABLE_FAILED: enabling failed

  • DISABLE_FAILED: disabling failed

  • DELETE_FAILED: deletion failed

  • RECOVERING: being recovered

Constraints

N/A

Range

  • COMPLETED

  • CREATING

  • UPDATING

  • ENABLING

  • DISABLING

  • DELETING

  • CREATE_FAILED

  • UPDATE_FAILED

  • ENABLE_FAILED

  • DISABLE_FAILED

  • DELETE_FAILED

  • RECOVERING

Default Value

N/A

process_error

String

Definition

Data processing error.

  • NONE

Constraints

N/A

Range

  • NONE

Default Value

N/A

environment

String

Definition

Environment type.

  • PROD: production environment

  • TEST: test environment

Constraints

N/A

Range

  • PROD

  • TEST

Default Value

N/A

output_table_id

String

UUID

output_table_name

String

Table name.

output_table_ids

Array of strings

output table id list

output_table_names

Array of strings

output table name list

create_by

String

Create by

create_time

Integer

Timestamp, in ms.

update_by

String

Updated by.

update_time

Integer

Timestamp, in ms.

delete_time

Integer

Timestamp, in ms.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.