华为云用户手册

提取数据水印 输入参数 输入参数说明如表21所示。 表21 提取数据水印输入参数说明 参数 必填 说明 水印密钥 否 水印密钥。 字段类型列表 否 字段类型列表。 -数据的字段名称 否 数据的字段名称。 -数据的字段类型 否 数据的字段类型。 -标记该字段是否为主键 否 标记该字段是否为主键。 水印数据 否 水印数据。 -col 否 col。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表22。 表22 提取数据水印输出参数说明 参数 说明 watermarks 提取水印内容列表。

查看资产列表 输入参数 该执行动作无需输入参数。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表18。 表18 查看资产列表输出参数说明 参数 说明 buckets OBS桶列表。 -asset_name 资产名称。 -bucket_location 桶位置。 -bucket_name 桶名称。 -bucket_policy 桶策略。 -create_time 创建时间。 -deleted 是否被删除。 -id 桶ID。 -is_deleted 是否被删除。 total OBS桶总数。

查看规则列表 输入参数 输入参数说明如表19所示。 表19 查看规则列表输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 project_id 是 项目ID。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表20。 表20 查看规则列表输出参数说明 参数 说明 total 规则总数。 rules 规则列表。 -category 规则分类。 -delete_allowed 是否允许删除。 -group_names 分组名称。 -id 规则ID。 -logic_operator logic_operator -min_match min_match -risk_level 风险等级。 -rule_content 规则内容。 -rule_desc 规则描述。 -rule_name 规则名称。 -rule_type 规则类型。 -selected selected

查询OpenApi调用记录 输入参数 输入参数说明如表16所示。 表16 查询OpenApi调用记录输入参数说明 参数 必填 说明 分页大小 否 分页大小。 需要查询调用记录的URL 否 需要查询调用记录的URL。 开始时间 否 OpenApi调用的开始时间。 结束时间 否 OpenApi调用的结束时间。 指定标识符 否 指定标识符。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表17。 表17 查询OpenApi调用记录输出参数说明 参数 说明 total total succeed succeed failed failed openapi_called_records openapi_called_records -user_name user_name -user_id user_id -domain_name domain_name -domain_id domain_id -request_url request_url -request_method request_method -response_code response_code -fail_reason fail_reason -timestamp -timestamp next_marker next_marker

查询扫描任务列表 输入参数 输入参数说明如表12所示。 表12 查询扫描任务列表输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 内容 否 内容。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表13。 表13 查询扫描任务列表输出参数说明 参数 说明 total 任务总数。 tasks 本次返回的扫描任务列表。 -id 任务ID。 -name 任务名称。 -cycle 任务执行方式。 -status 任务当前状态。 -open 任务开启状态。 -rule_groups 任务使用的规则组。 -last_run_time 任务上一次执行时间。 -create_time 任务创建时间。 -last_scan_risk 任务上一次扫描风险等级结果。 -use_nlp 是否使用了NLP进行扫描。 -topic_urn SMN服务通知主题。 -start_time 任务扫描开始时间。

查询告警通知主题 输入参数 输入参数说明如表14所示。 表14 查询告警通知主题输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表15。 表15 查询告警通知主题输出参数说明 参数 说明 default_topic_urn 默认消息通知主题的唯一资源标识符。 topic_count 已确认的消息通知主题数量。 topics 已确认的消息通知主题列表。 -name 消息通知主题名称。 -topic_urn 消息通知主题的唯一资源标识符。

查询指定任务扫描结果 输入参数 输入参数说明如表8所示。 表8 查询指定任务扫描结果输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 资产类型 否 资产类型。 任务ID 是 指定任务的ID。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表9。 表9 查询指定任务扫描结果输出参数说明 参数 说明 job_id job_id job_name job_name type type db_scan_result db_scan_result -total total -db_scan_results db_scan_results --task_id task_id --db_name db_name --table_id table_id --table_name table_name --risk_level risk_level --sensitive_data_type sensitive_data_type --match_info match_info ---column_name column_name ---rule_name rule_name ---rule_id rule_id ---rule_risk_level rule_risk_level ---column_line column_line

查询扫描规则组列表 输入参数 输入参数说明如表10所示。 表10 查询扫描规则组列表输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表11。 表11 查询扫描规则组列表输出参数说明 参数 说明 total total groups groups -id -ID -group_name group_name -group_desc group_desc -category category -rule_names rule_names -task_names task_names -delete_allowed delete_allowed -is_default is_default

查询脱敏任务执行列表 输入参数 输入参数说明如表6所示。 表6 查询脱敏任务执行列表输入参数说明 参数 必填 说明 工作区ID 否 工作区ID。 页码 否 页码。 分页大小 否 分页大小。 模板ID 是 模板ID。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表7。 表7 查询脱敏任务执行列表输出参数说明 参数 说明 tasks 任务。 -db_type db_type -end_time 查询脱敏任务截止时间。 -execute_line execute_line -id ID -progress progress -run_status 查询脱敏任务的运行状态。 -start_time 查询脱敏任务的开始时间。 -task_template_id task_template_id -type type total total

添加资产授权 添加数据资产扫描授权。 输入参数 输入参数说明如表4所示。 表4 添加资产授权输入参数说明 参数 必填 说明 资产类型 否 资产的类型。 OBS桶列表 否 支持输入框和数组两种模式。 输入框：请选择数组类型的节点输出。 数组：资产名称、桶位置、桶名称、桶策略等。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表5。 表5 添加资产授权输出参数说明 参数 说明 返回消息 返回消息。 返回状态 返回状态。

诗歌生成 根据用户输入的诗歌主题，自动赋诗。生成的诗歌种类多样，言简意深，对仗工整，平仄协调。用户不仅可以指定诗歌类型（五言绝句、七言绝句，五言律诗，七言律诗），而且还可以指定是否生成藏头诗，能够满足用户在不同节日、场景的需求。 接口功能及调用方法请参考诗歌生成。 输入参数 用户配置诗歌生成执行动作，相关参数说明如表6所示。 表6 诗歌生成输入参数说明 参数 必填 说明 诗歌标题 是 诗歌标题，仅支持中文，长度为1-10个字符。 诗歌正文 是 诗歌类型，有下拉框和输入框模式。取值如下： 0：五言绝句 1：七言绝句 2：五言律诗 3：七言律诗 藏头诗 是 藏头诗，有下拉框和输入框模式。取值如下： 取值为是，为藏头诗。 取值为否，非藏头诗。默认取值为否。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表7。 表7 诗歌生成输出参数说明 参数 说明 生成的诗歌 根据文本请求体，返回生成的诗歌。调用失败时无此字段。

关键词统计 用户问关键词统计。 输入参数 关键词统计执行动作，相关参数说明如表10所示。 表10 关键词统计输入参数说明 参数 必填 说明 用户问题关键词列表 是 用户问题关键词列表显示的个数。默认值为10，取值范围[1-50]。 查询的起始时间 否 查询的起始时间，long，utc时间，默认值为0。 查询的结束时间 否 查询的结束时间，long，utc时间，默认值为当前时间的毫秒数。 问答机器人ID 是 通过华为云CBS控制台获取。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表11。 表11 关键词统计输出参数说明 参数 说明 用户问题关键词列表 指定时间范围内，用户问题关键词列表。 关键词 关键词。 关键词频次 关键词频次。

获取问题提示 获取用户输入问题的提示问题列表。 输入参数 获取问题提示执行动作，相关参数说明如表8所示。 表8 获取问题提示输入参数说明 参数 必填 说明 用户输入的问题 是 用户输入的问题。 最多提示条数 否 最多提示条数。 问答机器人ID 是 通过华为云CBS控制台获取。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表9。 表9 获取问题提示输出参数说明 参数 说明 问题列表 推荐问列表。

访问统计 获取用户会话统计信息。 输入参数 访问统计执行动作，相关参数说明如表6所示。 表6 访问统计输入参数说明 参数 必填 说明 查询的起始时间 否 查询的起始时间，long，utc时间，默认值为0。 查询的结束时间 否 查询的结束时间，long，utc时间，默认值为当前时间的毫秒数。 统计周期 是 统计周期目前支持month、week、day。 请求所在时区 否 请求所在时区，例如：中国东八区为"+08:00"；美国西五区为"-05:00"；默认为"UTC"。（注意+-:符号需要经过urlEncoder加码）。 问答机器人ID 是 通过华为云CBS控制台获取。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表7。 表7 访问统计输出参数说明 参数 说明 统计周期 统计周期目前支持month、week、day。 请求所在时区 请求所在时区，例如：中国东八区为"+08:00"；美国西五区为"-05:00"；默认为"UTC"。（注意+-:符号需要经过urlEncoder加码）。 会话总计统计数据 会话总计统计数据。 会话总数 会话总数。 独立用户个数 独立用户个数。 平均会话轮数 平均会话轮数，保留小数点后三位。 平均会话时长 平均会话时长，保留小数点后三位。 会话间隔统计数据 会话间隔统计数据。 开始时间 间隔周期开始时间。 会话总数 间隔周期会话总数。 独立用户个数 间隔周期独立用户个数。 平均会话轮数 间隔周期平均会话轮数，保留小数点后三位。 平均会话时长 间隔周期平均会话时长，保留小数点后三位。 开始的utc时间 统计开始的utc时间。 结束的utc时间 统计结束的utc时间。

热点问题统计 获取热点问题列表。 输入参数 热点问题统计执行动作，相关参数说明如表4所示。 表4 热点问题统计输入参数说明 参数 必填 说明 热点问题所属领域 否 热点问题所属领域。 问题类别id列表 否 问题类别ID列表，一次最多传入10个。 查询的起始时间 否 查询的起始时间，long，utc时间，默认值为0。 查询的结束时间 否 查询的结束时间，long，utc时间，默认值为当前时间的毫秒数。 是否根据问答信息展示热点问题 否 true:根据问答对信息展示热点问题；false: 不根据问答对信息展示热点问题。 热点问题最多显示的个数 否 热点问题最多显示的个数，默认值为10，取值范围1-20。 问答机器人ID 是 通过华为云CBS控制台获取。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表5。 表5 热点问题统计输出参数说明 参数 说明 热点问题列表 指定时间范围内，热点问题列表。 问答对Id 问答对ID。 标准问题 标准问题。 标准问题所属领域 标准问题所属领域。

连接参数 对话机器人服务CBS连接器使用IAM认证，连接参数说明如表1所示。 表1 连接参数说明 名称 必填 说明 示例值/默认值 连接名称 是 设置连接名称。 问答机器人的连接 描述 否 对于连接的信息描述说明。 description 租户名 是 IAM用户所属账号信息。了解账号与IAM用户的关系。 domain 用户名 是 IAM用户名。 name 密码 是 IAM用户的登录密码。 - 区域 是 服务所属区域。 cn-north-4

问答机器人 用户可通过调用该接口与机器人进行会话。 输入参数 问答机器人执行动作，相关参数说明如表2所示。 表2 问答机器人输入参数说明 参数 必填 说明 用户问题 是 用户输入想要提出的问题。 问答机器人ID 是 通过华为云CBS控制台获取。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 问答机器人输出参数说明 参数 说明 闲聊回复 闲聊回复。 答案 根据问题，查询得出答案。

创建http请求 “创建http请求”执行动作为用户提供发送网络请求的能力，用户填写表单信息完成构造HTTP请求。 输入参数 用户配置创建http请求执行动作，相关参数说明如表2所示。 表2 创建http请求输入参数说明 参数 必须 说明 方法 是 选择方法，可选GET、PUT、DELETE、POST，有下拉框和输入框模式。 URL 是 输入的请求URL。 标头 否 输入键名称和键值，有输入框模式和键值模式。 查询 否 输入键名称和键值，有输入框模式和键值模式。 正文 否 输入的请求内容。 Cookie 否 输入的HTTP Cookie。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 创建http请求输出参数说明 参数 说明 状态 http请求状态。 状态码 http请求状态码。 body 返回的http请求体。

连接参数 创建http请求连接时使用IAM认证，连接参数说明如表1所示。 表1 连接参数说明 名称 必填 说明 示例值/默认值 连接名称 是 设置连接名称。 HTTP(IAM认证)的连接 描述 否 对于连接的信息描述说明。 description 租户名 是 IAM用户所属账号信息。了解账号与IAM用户的关系。 domain 用户名 是 IAM用户名。 name 密码 是 IAM用户的登录密码。 - 区域 是 服务所属区域，如果获取失败可尝试填写global。 global

查询调度计划 查询调度计划。 输入参数 用户配置查询调度计划执行动作，相关参数说明如表30所示。 表30 查询调度计划输入参数说明 参数 必填 说明 实例ID 是 实例ID。 任务ID 是 任务ID。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表31。 表31 查询调度计划输出参数说明 参数 说明 调度计划ID 调度计划ID。 调度计划关联的任务ID 调度计划关联的任务ID。 调度计划的执行开始时间 调度计划的执行开始时间。 调度计划执行周期的时间单位 调度计划执行周期的时间单位，当使用cron表达式时为空。- MIN (分钟) - HOUR (小时) - DAY (日) - WEEK (周) - MON (月)。 调度计划的执行间隔时间周期 调度计划的执行间隔时间周期。 调度计划的创建时间 调度计划的创建时间。 调度计划最近一次的修改时间 调度计划最近一次的修改时间。 调度计划的备注信息 调度计划的备注信息。 调度计划是否使用cron表达式 调度计划是否使用cron表达式，允许如下值：- true (使用cron表达式)，- false (不使用cron表达式)。

获取数据源中所有表 获取数据源中所有的表。 输入参数 用户配置获取数据源中所有的表执行动作，相关参数说明如表34所示。 表34 获取数据源中所有的表输入参数说明 参数 必填 说明 实例ID 是 实例ID。 数据源ID 是 数据源ID。 数据源所在任务位置 是 数据源所在任务位置： - SOURCE：数据源处于任务源端； - TARGET：数据源处于任务目标端。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表35。 表35 获取数据源中所有的表输出参数说明 参数 说明 数据源中所有的表名称 数据源中所有的表名称。

更新普通任务 更新普通任务。 输入参数 用户配置更新普通任务执行动作，相关参数说明如表28所示。 表28 更新普通任务输入参数说明 参数 必填 说明 实例ID 是 实例ID。 任务ID 是 任务ID。 任务名称 否 任务名称，只能以字母、数字为开头，包含字母、数字和 . _ - 3~100个字符。 任务类型 否 任务类型。 源端数据源ID 否 源端数据源ID。 目标端数据源ID 否 目标端数据源ID。 描述信息 否 描述信息。 任务标签 否 任务标签，只能包含字母、数字、中划线、下划线。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表29。 表29 更新普通任务输出参数说明 参数 说明 任务ID 任务ID，可为空。 任务名称 任务名称，只能以字母、数字为开头，包含字母、数字和 . _ - 3~100个字符。 任务类型 任务类型，- realtime (实时)，- timing (定时)。 任务状态 任务状态，- stop (0停止\未启动)，- running (1运行中)。 项目ID 项目ID。 源端数据源ID 源端数据源ID。 目标端数据源ID 目标端数据源ID。 源端数据源的名称 源端数据源的名称。 目标端数据源的名称 目标端数据源的名称。 源端数据源所属集成应用ID 源端数据源所属集成应用ID。 目标端数据源所属集成应用ID 目标端数据源所属集成应用ID。 源端数据源所属集成应用名称 源端数据源所属集成应用名称。 目标端数据源所属集成应用名称 目标端数据源所属集成应用名称。 创建时间 任务的创建时间。 最近一次的修改时间 最近一次的修改时间。 描述信息 描述信息。 任务标签 任务标签，只能包含字母、数字、中划线、下划线。 任务的创建者 任务的创建者。

任务监控信息列表查询 任务监控信息列表查询。 输入参数 用户配置任务监控信息列表查询执行动作，相关参数说明如表26所示。 表26 任务监控信息列表查询输入参数说明 参数 必填 说明 实例ID 是 实例ID。 偏移量 否 偏移量，表示从此偏移量开始查询，offset大于等于1。 每页显示条目数量 否 每页显示条目数量，最大数量999，超过999后只返回999。 任务名称 否 需要搜索的任务名称，支持模糊搜索，大小写敏感，非必填参数，如果为空，搜索所有任务。 执行状态 否 需要搜索任务的执行状态。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表27。 表27 任务监控信息列表查询输出参数说明 参数 说明 总数 总数。 当前页信息数量 当前页监控信息数量。 当前页元素 任务监控信息当前页元素。 任务ID 任务ID。 任务名称 任务名称。 任务类型 任务类型，只允许两种类型：TIMING-定时任务，REALTIME-实时任务。 任务状态 任务状态，只允许两种类型：0-停止，1-运行中。 最近执行时间 任务最近一次执行时间，格式timestamp(ms)，使用UTC时区。 是否使用Quartz表达式 任务是否使用Quartz表达式，只有定时任务才有该属性。 CRON表达式 CRON表达式，只有定时任务且use_quartz_cron为true时才有该属性。 调度周期的单位 调度周期的单位，如天，小时等，只有定时任务且use_quartz_cron为false时才有该属性。 调度周期 调度周期，和period字段一起可以确定每隔多长时间调度一次，只有定时任务且use_quartz_cron为false时才有该属性。 任务执行阶段 标识最近一次任务执行到哪一个阶段，允许如下值：ADAPTER-任务处于初始化阶段，READER-任务正在执行Reader读操作，WRITER-任务正在执行Writer写操作。 执行状态 任务最近一次执行状态，允许如下值：UNSTARTED-未启动，WAITING-等待调度中，RUNNING-执行中，SUCCESS-执行成功，CANCELLED-任务取消，ERROR-执行异常。 任务源端数据源所属应用ID 任务源端数据源所属应用ID。 任务源端数据源所属应用名称 任务源端数据源所属应用名称。 任务源端数据源所属实例ID 任务源端数据源所属实例ID。 任务目标端数据源所属应用ID 任务目标端数据源所属应用ID。 任务目标端数据源所属应用名称 任务目标端数据源所属应用名称。 任务目标端数据源所属实例ID 任务目标端数据源所属实例ID。 任务扩展类型 任务扩展类型，当前如果是CDC组合任务，该字段为CDC，否则为null。 任务所属企业项目ID 任务所属企业项目ID，默认为0。 任务标签 任务标签。

修改调度计划 通过任务ID和调度ID修改调度计划。 输入参数 用户配置修改调度计划执行动作，相关参数说明如表20所示。 表20 修改调度计划输入参数说明 参数 必填 说明 实例ID 是 实例ID。 任务ID 是 任务ID。 调度计划ID 是 调度唯一标识，调度计划ID。 开始时间 否 调度计划的执行开始时间。 时间单位 否 调度计划执行周期的时间单位，当使用cron表达式时为空。- MIN (分钟) - HOUR (小时) - DAY (日) - WEEK (周) - MON (月)。 间隔时间周期 否 调度计划的执行间隔时间周期。 备注信息 否 调度计划的备注信息。 是否使用cron表达式 否 调度计划是否使用cron表达式，允许如下值：- true (使用cron表达式)，- false (不使用cron表达式)。 cron表达式 否 调度计划的cron表达式。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表21。 表21 修改调度计划输出参数说明 参数 说明 调度计划ID 调度计划ID。 任务ID 调度计划关联的任务ID。 开始时间 调度计划的执行开始时间。 时间单位 调度计划执行周期的时间单位，当使用cron表达式时为空。- MIN (分钟) - HOUR (小时) - DAY (日) - WEEK (周) - MON (月)。 间隔时间周期 调度计划的执行间隔时间周期。 创建时间 调度计划的创建时间。 最近修改时间 调度计划最近一次的修改时间。 备注信息 调度计划的备注信息。 是否使用cron表达式 调度计划是否使用cron表达式，允许如下值： - true (使用cron表达式)，- false (不使用cron表达式)。 cron表达式 调度计划的cron表达式。

批量启动或停止任务 批量启动或停止任务。 输入参数 用户配置批量启动或停止任务执行动作，相关参数说明如表16所示。 表16 批量启动或停止任务输入参数说明 参数 必填 说明 实例ID 是 实例ID。 操作类型 否 操作类型：- start (启动)，- stop (停止)。 任务ID列表 否 需要启动或者停止的任务ID列表。 任务ID 否 任务ID，可为空。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表17。 表17 批量启动或停止任务输出参数说明 参数 说明 成功个数 成功的个数。 失败个数 失败的个数。 失败详情 失败的详情。 任务ID 任务ID。 任务名称 任务名称。 失败错误码 失败的错误码。 错误详情 错误详情。 成功的任务信息 成功的任务信息。 任务ID 任务ID。 任务名称 任务名称。 失败的错误码 失败的错误码。 错误详情 错误详情。

查询任务列表 查询任务列表。 输入参数 用户配置查询任务列表执行动作，相关参数说明如表18所示。 表18 查询任务列表输入参数说明 参数 必填 说明 实例ID 是 实例ID。 每页显示条目数量 否 每页显示条目数量，最大数量999，超过999后只返回999。 分页查询 否 分页查询，分页的偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0。 任务ID 否 任务ID，可为空。 模糊匹配任务名称 否 模糊匹配任务名称，可为空。 任务状态 否 任务状态，可为空。- 0（停止/未启动），- 1（运行中）。 任务类型 否 任务类型，- realtime (实时)，- timing (定时)。 源端数据源ID 否 源端数据源ID，可为空。 目标端数据源ID 否 目标端数据源ID，可为空。 查询排序的条件 否 查询排序的条件。 排序类型 否 排序类型，可为空。- ASC (升序)，- DESC (降序)。 执行状态 否 执行状态，可为空。- UNSTARTED (未启动) - WAITING (等待执行) - RUNNING (执行中) - SUCCESS (执行成功) - CANCELLED (任务取消) - ERROR (执行异常)。 源端数据源所属集成应用ID 否 源端数据源所属集成应用ID，可为空。 目标端数据源所属集成应用ID 否 目标端数据源所属集成应用ID，可为空。 任务标签 否 任务标签，可为空。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表19。 表19 查询任务列表输出参数说明 参数 说明 查询任务列表任务总个数 查询任务列表任务总个数。 查询任务列表返回的当前页的任务个数 查询任务列表返回的当前页的任务个数。 查询任务列表返回的对象 查询任务列表返回的对象。 任务ID 任务ID。 任务名称 任务名称。 任务类型 任务类型：- REALTIME (实时)，- TIMING (定时)。 任务状态 任务状态：- 0 (停止/未启动)，- 1 (运行中)。 创建时间 任务的创建时间。 任务的版本 任务的版本。 上次修改时间 上次修改时间。 任务执行状态 任务执行状态：- UNSTARTED (未启动) - WAITING (等待执行) - RUNNING (执行中) - SUCCESS (执行成功) - CANCELLED (任务取消) - ERROR (执行异常)。 源端数据源所属应用ID 源端数据源所属应用ID。 目标端数据源所属应用ID 目标端数据源所属应用ID。 源端实例ID 源端实例ID。 目标端实例ID 目标端实例ID。 组合任务类型 组合任务类型，可为空。 企业项目id 企业项目ID。 任务标签 任务标签。

任务监控日志查询 查询单个任务的所有日志信息。 输入参数 用户配置任务监控日志查询执行动作，相关参数说明如表11所示。 表11 任务监控日志查询输入参数说明 参数 必填 说明 实例ID 是 实例ID。 任务ID 是 任务ID。 偏移量 否 偏移量，表示从此偏移量开始查询，offset大于等于1。 每页显示条目数量 否 每页显示条目数量，最大数量999，超过999后只返回999。 日志查询的起始时间 否 日志查询的起始时间，格式timestamp(ms)，使用UTC时区。 日志查询的结束时间 否 日志查询的结束时间，格式timestamp(ms)，使用UTC时区。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表12。 表12 任务监控日志查询输出参数说明 参数 说明 总数 总数。 当前页日志数量 当前页日志数量。 任务监控日志当前页元素 任务监控日志当前页元素。 单次任务执行的跟踪ID 单次任务执行的跟踪ID。 本次执行启动时间 本次执行启动时间，格式timestamp(ms)，使用UTC时区。 任务本次执行状态 任务本次执行状态，允许如下值：UNSTARTED-未启动，WAITING-等待调度中，RUNNING-执行中，SUCCESS-执行成功，CANCELLED-任务取消，ERROR-执行异常。 标识本次任务执行到哪一个阶段 标识本次任务执行到哪一个阶段，允许如下值：ADAPTER-任务处于初始化阶段，READER-任务正在执行Reader读操作，WRITER-任务正在执行Writer写操作。 任务本次执行当前阶段的状态 任务本次执行当前阶段的状态，允许如下值：NORMAL-正在运行，NODE_END-本节点正常结束，RUNTIME_CANCEL-任务被取消，TASK_END-本任务正常结束，RUNTIME_ERR-运行时异常，INTERNAL_ERR-内部程序异常。 本次任务执行详细状态 本次任务执行详细状态，使用状态码的形式。 异常数据条数 异常数据条数。 成功数据条数 成功数据条数。 成功数据大小 成功数据大小，浮点数类型。 成功数据大小的计量单位 成功数据大小的计量单位。 执行时长 执行时长，单位：ms。 本次执行详细轨迹信息 本次执行详细轨迹信息。 任务每次执行步骤产生的唯一ID 任务每次执行步骤产生的唯一ID。 当前步骤执行详细状态 当前步骤执行详细状态，使用状态码的形式。 标识当前步骤属于哪一个阶段 标识当前步骤属于哪一个阶段，允许如下值：ADAPTER-任务处于初始化阶段，READER-任务正在执行Reader读操作，WRITER-任务正在执行Writer写操作。 任务当前步骤的状态 任务当前步骤的状态，允许如下值：NORMAL-正在运行，NODE_END-本节点正常结束，RUNTIME_CANCEL-任务被取消，TASK_END-本任务正常结束，RUNTIME_ERR-运行时异常，INTERNAL_ERR-内部程序异常。 标识当前步骤属于哪一个FDI插件 标识当前步骤属于哪一个FDI插件，如adapter，apireader，rdbwriter等。 异常数据条数 异常数据条数。 成功数据条数 成功数据条数。 成功数据大小 成功数据大小，浮点数类型。 成功数据大小的计量单位 成功数据大小的计量单位。 执行时长 执行时长，单位：ms。 执行详细信息 执行详细信息。 本次步骤启动时间 本次步骤启动时间，格式timestamp(ms)，使用UTC时区。 本次步骤结束时间 本次步骤结束时间，格式timestamp(ms)，使用UTC时区。

获取数据源中某个表中所有字段 获取数据源中某个表中所有字段。 输入参数 用户配置获取数据源中某个表中所有字段执行动作，相关参数说明如表13所示。 表13 获取数据源中某个表中所有字段输入参数说明 参数 必填 说明 数据源所在任务位置 是 数据源所在任务位置： - SOURCE：数据源处于任务源端； - TARGET：数据源处于任务目标端。 实例ID 是 实例ID。 数据源ID 是 数据源ID。 数据库名称 否 数据库名称，只支持MRSHIVE，FIHIVE类型的数据源。 字段所在的表名 否 字段所在的表名。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表14。 表14 获取数据源中某个表中所有字段输出参数说明 参数 说明 返回的实体对象 返回的实体对象。 字段名称 字段名称。 字段类型 字段类型。 字段长度 字段长度。 是否允许为空 是否允许为空。 是否是分区字段 是否是分区字段。 是否是主键字段 是否是主键字段。 是否是唯一键字段 是否是唯一键字段。 小数部分位数 小数部分位数，非数字类型返回null。

连接参数 ROMA数据集成连接器使用IAM认证，连接参数说明如表1所示。 表1 连接参数说明 名称 必填 说明 示例值/默认值 连接名称 是 设置连接名称。 ROMA数据集成的连接 描述 否 对于连接的信息描述说明。 description 租户名 是 IAM用户所属账号信息。了解账号与IAM用户的关系。 domain 用户名 是 IAM用户名。 name 密码 是 IAM用户的登录密码。 - 区域 是 服务所属区域。 cn-north-4

创建调度计划 创建调度计划。 输入参数 用户配置查询事件通道列表执行动作，相关参数说明如表2所示。 表2 创建调度计划输入参数说明 参数 必填 说明 实例ID 是 实例ID。 任务ID 是 任务ID。 调度计划的执行开始时间 否 调度计划的执行开始时间。 调度计划执行周期的时间单位 否 调度计划执行周期的时间单位，当使用cron表达式时为空。- MIN (分钟) - HOUR (小时) - DAY (日) - WEEK (周) - MON (月)。 调度计划的执行间隔时间周期 否 调度计划的执行间隔时间周期。 调度计划的备注信息 否 调度计划的备注信息。 调度计划是否使用cron表达式 否 调度计划是否使用cron表达式，允许如下值：- true (使用cron表达式)，- false (不使用cron表达式)。 调度计划的cron表达式 否 调度计划的cron表达式。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 创建调度计划输出参数说明 参数 说明 调度计划ID 调度计划ID。 调度计划关联的任务ID 调度计划关联的任务ID。 调度计划的执行开始时间 调度计划的执行开始时间。 调度计划执行周期的时间单位 调度计划执行周期的时间单位，当使用cron表达式时为空。- MIN (分钟) - HOUR (小时) - DAY (日) - WEEK (周) - MON (月)。 调度计划的执行间隔时间周期 调度计划的执行间隔时间周期。 调度计划的创建时间 调度计划的创建时间。 调度计划最近一次的修改时间 调度计划最近一次的修改时间。 调度计划的备注信息 调度计划的备注信息。 调度计划是否使用cron表达式 调度计划是否使用cron表达式，允许如下值：- true (使用cron表达式)，- false (不使用cron表达式)。 调度计划的cron表达式 调度计划的cron表达式。