文档首页/ 安全云脑 SecMaster/ API参考/ 安全分析V2 API/ 数据加工作业管理/ 更新数据加工 - UpdateDataTransformation
更新时间:2025-11-21 GMT+08:00
分享

更新数据加工 - UpdateDataTransformation

功能介绍

更新数据加工

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

PUT /v2/{project_id}/workspaces/{workspace_id}/siem/data-transformations/{data_transformation_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

data_transformation_id

String

数据转换 ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

data_transformation_name

String

数据转换名称

description

String

数据转换描述

directory

String

directory 目录分组

script

String

Job Script 作业脚本

status

String

参数解释:

作业状态

  • ENABLED 启用

  • DISABLED 禁用

约束限制

不涉及

取值范围:

  • ENABLED

  • DISABLED

默认值

不涉及

job_mode_setting

IsapJobModeSettingDto object

作业模式设置数据传输对象

environment

String

参数解释:

环境类型

  • PROD 生产环境

  • TEST 测试环境

约束限制

不涉及

取值范围:

  • PROD

  • TEST

默认值

不涉及

output_table_id

String

UUID

output_table_ids

Array of strings

输出表ID列表

output_table_names

Array of strings

输出表名称列表

表4 IsapJobModeSettingDto

参数

是否必选

参数类型

描述

batch_overtime_interval

Integer

整型间隔时长

batch_overtime_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

batch_frequency_interval

Integer

整型间隔时长

batch_frequency_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

streaming_state_ttl_interval

Integer

整型间隔时长

streaming_state_ttl_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

streaming_checkpoint_ttl_interval

Integer

整型间隔时长

streaming_checkpoint_ttl_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

streaming_startup_mode

String

参数解释:

作业启动模式

  • UPGRADE 升级启动

  • REFRESH_NEW 全新启动

约束限制

不涉及

取值范围:

  • UPGRADE

  • REFRESH_NEW

默认值

不涉及

batch_overtime_strategy_interval

Integer

整型间隔时长

batch_overtime_strategy_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

search_delay_interval

Integer

整型间隔时长

search_delay_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

search_frequency_interval

Integer

整型间隔时长

search_frequency_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

search_overtime_interval

Integer

整型间隔时长

search_overtime_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

search_period_interval

Integer

整型间隔时长

search_period_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

search_table_id

String

UUID

search_table_name

String

表名称

field_not_null_policy

String

参数解释:

作业表非空字段处理策略

LOOSE 宽松

STRICT 严格

约束限制

不涉及

取值范围:

LOOSE

STRICT

默认值

LOOSE

dss_id

Integer

长整型间隔时长

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

data_transformation_id

String

UUID

data_transformation_name

String

数据转换名称

script

String

Job Script 作业脚本

status

String

参数解释:

作业状态

  • ENABLED 启用

  • DISABLED 禁用

约束限制

不涉及

取值范围:

  • ENABLED

  • DISABLED

默认值

不涉及

directory

String

directory 目录分组

description

String

数据转换描述

job_mode

String

参数解释:

作业模式

  • STREAMING 流式处理

  • BATCH 批处理

  • SEARCH 检索

约束限制

不涉及

取值范围:

  • STREAMING

  • BATCH

  • SEARCH

默认值

不涉及

job_mode_setting

IsapJobModeSettingVo object

作业模式设置

process_status

String

参数解释:

作业处理状态

  • COMPLETED 已完成

  • CREATING 创建中

  • UPDATING 更新中

  • ENABLING 启用中

  • DISABLING 停用中

  • DELETING 删除中

  • CREATE_FAILED 创建失败

  • UPDATE_FAILED 更新失败

  • ENABLE_FAILED 启用失败

  • DISABLE_FAILED 停用失败

  • DELETE_FAILED 删除失败

  • RECOVERING 恢复中

约束限制

不涉及

取值范围:

  • COMPLETED

  • CREATING

  • UPDATING

  • ENABLING

  • DISABLING

  • DELETING

  • CREATE_FAILED

  • UPDATE_FAILED

  • ENABLE_FAILED

  • DISABLE_FAILED

  • DELETE_FAILED

  • RECOVERING

默认值

不涉及

process_error

String

参数解释:

数据加工处理错误

  • NONE 无

约束限制

不涉及

取值范围:

  • NONE

默认值

不涉及

environment

String

参数解释:

环境类型

  • PROD 生产环境

  • TEST 测试环境

约束限制

不涉及

取值范围:

  • PROD

  • TEST

默认值

不涉及

output_table_id

String

UUID

output_table_name

String

表名称

output_table_ids

Array of strings

输出表ID列表

output_table_names

Array of strings

输出表名称列表

create_by

String

创建者

create_time

Integer

毫秒时间戳

update_by

String

更新者

update_time

Integer

毫秒时间戳

delete_time

Integer

毫秒时间戳

表6 IsapJobModeSettingVo

参数

参数类型

描述

batch_overtime_interval

Integer

整型间隔时长

batch_overtime_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

batch_frequency_interval

Integer

整型间隔时长

batch_frequency_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

streaming_state_ttl_interval

Integer

整型间隔时长

streaming_state_ttl_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

streaming_checkpoint_ttl_interval

Integer

整型间隔时长

streaming_checkpoint_ttl_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

streaming_startup_mode

String

参数解释:

作业启动模式

  • UPGRADE 升级启动

  • REFRESH_NEW 全新启动

约束限制

不涉及

取值范围:

  • UPGRADE

  • REFRESH_NEW

默认值

不涉及

batch_overtime_strategy_interval

Integer

整型间隔时长

batch_overtime_strategy_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

search_delay_interval

Integer

整型间隔时长

search_delay_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

search_frequency_interval

Integer

整型间隔时长

search_frequency_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

search_overtime_interval

Integer

整型间隔时长

search_overtime_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

search_period_interval

Integer

整型间隔时长

search_period_unit

String

参数解释:

时间单位

  • MINUTE 分钟

  • HOUR 小时

  • DAY 天

  • MONTH 月

约束限制

不涉及

取值范围:

  • MINUTE

  • HOUR

  • DAY

  • MONTH

默认值

不涉及

search_table_id

String

UUID

search_table_name

String

表名称

field_not_null_policy

String

参数解释:

作业表非空字段处理策略

LOOSE 宽松

STRICT 严格

约束限制

不涉及

取值范围:

LOOSE

STRICT

默认值

LOOSE

请求示例

响应示例

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档