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
|
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
|
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
data_transformation_name |
Yes |
String |
Data conversion name. |
|
description |
Yes |
String |
Data conversion description. |
|
directory |
No |
String |
Directory group. |
|
script |
Yes |
String |
Job script. |
|
status |
Yes |
String |
Definition Job status.
Constraints N/A Range
Default Value N/A |
|
job_mode |
Yes |
String |
Definition Job mode.
Constraints N/A Range
Default Value N/A |
|
job_mode_setting |
No |
IsapJobModeSettingDto object |
Data transmission object for job mode settings. |
|
environment |
Yes |
String |
Definition Environment type.
Constraints N/A Range
Default Value N/A |
|
output_table_id |
No |
String |
UUID |
|
belong |
No |
String |
Ownership. |
|
cu_quota_amount |
Yes |
Float |
Quantity. |
|
input_table_id |
No |
Array of strings |
Input table ID. |
|
input_table_names |
No |
Array of strings |
List of input table names. |
|
output_table_ids |
Yes |
Array of strings |
Output table ID list. |
|
output_table_names |
Yes |
Array of strings |
Output table name list. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
batch_overtime_interval |
No |
Integer |
Integer interval. |
|
batch_overtime_unit |
No |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
batch_frequency_interval |
No |
Integer |
Integer interval. |
|
batch_frequency_unit |
No |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
streaming_state_ttl_interval |
No |
Integer |
Integer interval. |
|
streaming_state_ttl_unit |
No |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
streaming_checkpoint_ttl_interval |
No |
Integer |
Integer interval. |
|
streaming_checkpoint_ttl_unit |
No |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
streaming_startup_mode |
No |
String |
Definition Job startup mode.
Constraints N/A Range
Default Value N/A |
|
batch_overtime_strategy_interval |
No |
Integer |
Integer interval. |
|
batch_overtime_strategy_unit |
No |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
search_delay_interval |
No |
Integer |
Integer interval. |
|
search_delay_unit |
No |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
search_frequency_interval |
No |
Integer |
Integer interval. |
|
search_frequency_unit |
No |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
search_overtime_interval |
No |
Integer |
Integer interval. |
|
search_overtime_unit |
No |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
search_period_interval |
No |
Integer |
Integer interval. |
|
search_period_unit |
No |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
search_table_id |
No |
String |
UUID |
|
search_table_name |
No |
String |
Table name. |
|
field_not_null_policy |
No |
String |
Definition Policy for processing non-empty fields in job tables. LOOSE STRICT Constraints N/A Value Range LOOSE STRICT Default Value LOOSE |
|
dss_id |
No |
Integer |
Long integer interval. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
data_transformation_id |
String |
UUID |
|
data_transformation_name |
String |
Data conversion name. |
|
script |
String |
Job script. |
|
status |
String |
Definition Job status.
Constraints N/A Range
Default Value N/A |
|
directory |
String |
Directory group. |
|
description |
String |
Data conversion description. |
|
job_mode |
String |
Definition Job mode.
Constraints N/A Range
Default Value N/A |
|
job_mode_setting |
IsapJobModeSettingVo object |
Job mode settings. |
|
process_status |
String |
Definition Job processing status.
Constraints N/A Range
Default Value N/A |
|
process_error |
String |
Definition Data processing error.
Constraints N/A Range
Default Value N/A |
|
environment |
String |
Definition Environment type.
Constraints N/A Range
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 |
Creator. |
|
create_time |
Integer |
Timestamp, in ms. |
|
update_by |
String |
Updater. |
|
update_time |
Integer |
Timestamp, in ms. |
|
delete_time |
Integer |
Timestamp, in ms. |
|
Parameter |
Type |
Description |
|---|---|---|
|
batch_overtime_interval |
Integer |
Integer interval. |
|
batch_overtime_unit |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
batch_frequency_interval |
Integer |
Integer interval. |
|
batch_frequency_unit |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
streaming_state_ttl_interval |
Integer |
Integer interval. |
|
streaming_state_ttl_unit |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
streaming_checkpoint_ttl_interval |
Integer |
Integer interval. |
|
streaming_checkpoint_ttl_unit |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
streaming_startup_mode |
String |
Definition Job startup mode.
Constraints N/A Range
Default Value N/A |
|
batch_overtime_strategy_interval |
Integer |
Integer interval. |
|
batch_overtime_strategy_unit |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
search_delay_interval |
Integer |
Integer interval. |
|
search_delay_unit |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
search_frequency_interval |
Integer |
Integer interval. |
|
search_frequency_unit |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
search_overtime_interval |
Integer |
Integer interval. |
|
search_overtime_unit |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
search_period_interval |
Integer |
Integer interval. |
|
search_period_unit |
String |
Definition Time unit.
Constraints N/A Range
Default Value N/A |
|
search_table_id |
String |
UUID |
|
search_table_name |
String |
Table name. |
|
field_not_null_policy |
String |
Definition Policy for processing non-empty fields in job tables. LOOSE STRICT Constraints N/A Value Range LOOSE STRICT Default Value LOOSE |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot