Updated on 2025-10-29 GMT+08:00

Creating a Data Processing job.

Function

This API is used to create a data processing job.

Calling Method

For details, see Calling APIs.

URI

POST /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.

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

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

data_transformation_name

Yes

String

Data transformation name

description

Yes

String

Data transformation description

directory

No

String

Directory group.

script

Yes

String

Job script.

status

Yes

String

Definition

Job status.

  • ENABLED

  • DISABLED

Constraints

N/A

Range

  • ENABLED

  • DISABLED

Default Value

N/A

job_mode

Yes

String

Definition

Job mode.

  • STREAMING: streaming processing

  • BATCH: batch processing

  • SEARCH: retrieval

Constraints

N/A

Range

  • STREAMING

  • BATCH

  • SEARCH

Default Value

N/A

job_mode_setting

No

IsapJobModeSettingDto object

Data transmission object for job mode settings.

environment

Yes

String

Definition

Environment type.

  • PROD: production environment

  • TEST: test environment

Constraints

N/A

Range

  • PROD

  • TEST

Default Value

N/A

output_table_id

No

String

UUID

belong

No

String

belongs to

cu_quota_amount

Yes

Float

cu total

input_table_id

No

Array of strings

input table id

input_table_names

No

Array of strings

input table name list

output_table_ids

Yes

Array of strings

output table id list

output_table_names

Yes

Array of strings

output table name list

Table 4 IsapJobModeSettingDto

Parameter

Mandatory

Type

Description

batch_overtime_interval

No

Integer

Time

batch_overtime_unit

No

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

batch_frequency_interval

No

Integer

Time

batch_frequency_unit

No

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

streaming_state_ttl_interval

No

Integer

Time

streaming_state_ttl_unit

No

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

streaming_checkpoint_ttl_interval

No

Integer

Time

streaming_checkpoint_ttl_unit

No

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

streaming_startup_mode

No

String

Definition

Job startup mode.

  • UPGRADE: startup in upgrade mode

  • REFRESH_NEW: startup in refresh mode

Constraints

N/A

Range

  • UPGRADE

  • REFRESH_NEW

Default Value

N/A

batch_overtime_strategy_interval

No

Integer

Time

batch_overtime_strategy_unit

No

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

search_delay_interval

No

Integer

Time

search_delay_unit

No

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

search_frequency_interval

No

Integer

Time

search_frequency_unit

No

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

search_overtime_interval

No

Integer

Time

search_overtime_unit

No

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

search_period_interval

No

Integer

Time

search_period_unit

No

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

search_table_id

No

String

UUID

search_table_name

No

String

Table name.

dss_id

No

Integer

Time

Response Parameters

Status code: 200

Table 5 Response body parameters

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

job_mode_setting

IsapJobModeSettingVo object

Job mode settings.

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.

Table 6 IsapJobModeSettingVo

Parameter

Type

Description

batch_overtime_interval

Integer

Time

batch_overtime_unit

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

batch_frequency_interval

Integer

Time

batch_frequency_unit

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

streaming_state_ttl_interval

Integer

Time

streaming_state_ttl_unit

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

streaming_checkpoint_ttl_interval

Integer

Time

streaming_checkpoint_ttl_unit

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

streaming_startup_mode

String

Definition

Job startup mode.

  • UPGRADE: startup in upgrade mode

  • REFRESH_NEW: startup in refresh mode

Constraints

N/A

Range

  • UPGRADE

  • REFRESH_NEW

Default Value

N/A

batch_overtime_strategy_interval

Integer

Time

batch_overtime_strategy_unit

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

search_delay_interval

Integer

Time

search_delay_unit

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

search_frequency_interval

Integer

Time

search_frequency_unit

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

search_overtime_interval

Integer

Time

search_overtime_unit

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

search_period_interval

Integer

Time

search_period_unit

String

Definition

Time unit.

  • MINUTE

  • HOUR

  • DAY

  • MONTH: month

Constraints

N/A

Range

  • MINUTE

  • HOUR

  • DAY

  • MONTH

Default Value

N/A

search_table_id

String

UUID

search_table_name

String

Table name.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.