华为云用户手册

文字识别 识别图片上的文字信息，返回识别的文字和坐标。支持扫描文件、电子文档、书籍、票据和表单等多种场景的文字识别。 输入参数 用户配置文字识别执行动作，相关参数说明如表3所示。 表3 文字识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 图片的URL路径，和图片文件二选一。 校正图片倾斜角 是否校正图片的倾斜角度。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表4。 表4 文字识别输出参数说明 参数 说明 识别文字块列表 识别文字块列表，输出顺序从左到右，先上后下。 文字 文字。 文字块的区域位置 文字块的区域位置。 文字块识别结果 文字块识别结果。 图片朝向 图片朝向。 检测到的文字块数目 检测到的文字块数目。

身份证识别 识别身份证图片中的文字内容，并将识别的结果返回给用户。 输入参数 用户配置身份证识别执行动作，相关参数说明如表5所示。 表5 身份证识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 图片的URL路径，和图片文件二选一。 识别正面/反面 front：身份证正面。 back：身份证背面。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表6。 表6 身份证识别输出参数说明 参数 说明 姓名 姓名。 性别 性别。 出生日期 出生日期。 民族 民族。 地址 地址。 身份证号 身份证号。 发证机关 身份证的发证机关。 有效起始日期 有效起始日期。 有效结束日期 有效结束日期。说明：身份证识别只支持中国大陆汉族身份证识别。

运势查询 根据输入的星座和日期，给出查询到的运势。 输入参数 用户配置运势查询执行动作，相关参数说明如表2所示。 表2 运势查询输入参数说明 参数 必填 说明 示例值/默认值 星座 是 需要查询的星座。 射手座 日期 是 需要查询的日期。 2020-10-12 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 运势查询输出参数说明 参数 说明 示例值/默认值 分类 运势内容分类。 今日概述 内容 查询的运势结果内容。 今天朋友里面有些计较算计的人，沟通不顺利。部分人可能会比较想宅家躺吃。

旅游景区查询 提供全国各类知名、不知名旅游景点等信息。 输入参数 用户配置旅游景区查询执行动作，相关参数说明如表2所示。 表2 旅游景区查询输入参数说明 参数 必填 说明 示例值/默认值 景点名称 是 输入景点名称。 虎丘 返回数量 否 输入数字，默认值为1。 1 页数 否 输入数字，默认值为1。 1 按景点省区检索 否 输入景点所在省区。 江苏 按景点城市检索 否 输入景点所在城市。 苏州 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。

下推数据 金蝶下推数据。 输入参数 输入参数说明如表19所示。 表19 下推数据输入参数说明 参数 必填 说明 Cookie 是 Cookie。 Content-Type 是 Content-Type。 FormId 否 FormId。 opNumber 否 opNumber。 Ids 否 Ids。 EntryIds 否 EntryIds。 RuleId 否 RuleId。 TargetBillTypeId 否 TargetBillTypeId。 TargetFormId 否 TargetFormId。 IsEnableDefaultRule 否 IsEnableDefaultRule。 IsDraftWhenSaveFail 否 IsDraftWhenSaveFail。 CustomParams 否 CustomParams。 Numbers 否 Numbers。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表20。 表20 下推数据输出参数说明 参数 说明 字符串 输出结果为字符串。

保存客户信息 输入参数 输入参数说明如表17所示。 表17 保存客户信息输入参数说明 参数 必填 说明 Cookie 是 Cookie。 Content-Type 是 Content-Type。 FormId 是 FormId。 FNumber 否 FNumber。 FName 否 FName。 FNumber 否 FNumber。 FNumber 否 FNumber。 F_kd_Text2 否 F_kd_Text2。 FADDRESS 否 FADDRESS。 FTEL 否 FTEL。 FShortName 否 FShortName。 FSOCIALCRECODE 否 FSOCIALCRECODE。 F_kd_Remark 否 F_kd_Remark。 FINVOICETITLE 否 FINVOICETITLE。 FCUSTID 否 FCUSTID。 FT_BD_CUSTBANK 否 FT_BD_CUSTBANK。 FT_BD_CUSTCONTACT 否 FT_BD_CUSTCONTACT。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表18。 表18 保存客户信息输出参数说明 参数 说明 Result Result。 ResponseStatus ResponseStatus。 -IsSuccess 是否成功。 -Errors 错误描述。 -SuccessEntitys SuccessEntitys --Id ID --Number Number --DIndex DIndex -SuccessMessages SuccessMessages -MsgCode MsgCode。 Id ID。 Number Number。 NeedReturnData NeedReturnData。

保存联系人 输入参数 输入参数说明如表15所示。 表15 保存联系人输入参数说明 参数 必填 说明 Cookie 是 Cookie。 Content-Type 否 Content-Type。 FormId 否 FormId。 FCONTACTID 否 FCONTACTID。 FName 否 FName。 FNumber 否 FNumber。 FCompanyType 否 FCompanyType。 FNumber 否 FNumber。 FMobile 否 FMobile。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表16。 表16 保存联系人输出参数说明 参数 说明 字符串 输出结果为字符串。

反审核表单数据 输入参数 输入参数说明如表9所示。 表9 反审核表单数据输入参数说明 参数 必填 说明 Cookie 是 Cookie。 Content-Type 是 Content-Type。 formid 否 formid。 CreateOrgId 否 CreateOrgId。 Ids 否 Ids。 InterationFlags 否 InterationFlags。 IgnoreInterationFlag 否 IgnoreInterationFlag。 NetworkCtrl 否 NetworkCtrl。 IsVerifyProcInst 否 IsVerifyProcInst。 Numbers 否 Numbers。支持输入框和数组两种模式。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表10。 表10 反审核表单数据输出参数说明 参数 说明 ResponseStatus ResponseStatus。 -ErrorCode 错误码。 -IsSuccess 是否成功。 -Errors 错误描述。 --FieldName 字段名称。 --Message Message --DIndex DIndex -SuccessEntitys SuccessEntitys --Id ID --Number Number --DIndex DIndex -SuccessMessages SuccessMessages --FieldName 字段名称。 --Message Message。 --DIndex DIndex。

删除表单数据 输入参数 输入参数说明如表11所示。 表11 删除表单数据输入参数说明 参数 必填 说明 Cookie 是 Cookie。 Content-Type 否 Content-Type。 FormId 否 FormId。 CreateOrgId 否 CreateOrgId。 Ids 否 Ids。 NetworkCtrl 否 NetworkCtrl。 Numbers 否 Numbers。支持输入框和数组两种模式。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表12。 表12 删除表单数据输出参数说明 参数 说明 字符串 输出结果为字符串。

保存表单数据 输入参数 输入参数说明如表13所示。 表13 保存表单数据输入参数说明 参数 必填 说明 Cookie 是 Cookie。 Content-Type 是 Content-Type。 FormId 是 表单ID。 Model 是 Model。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表14。 表14 保存表单数据输出参数说明 参数 说明 ResponseStatus ResponseStatus。 -ErrorCode 错误码。 -IsSuccess 是否成功。 -Errors 错误描述。 --FieldName 字段名称。 --Message Message --DIndex DIndex -SuccessEntitys SuccessEntitys --Id ID --Number Number --DIndex DIndex -SuccessMessages SuccessMessages --FieldName 字段名称。 --Message Message。 --DIndex DIndex。 --MsgCode MsgCode。 Id ID。 Number Number。 NeedReturnData NeedReturnData。

审核表单数据 输入参数 输入参数说明如表7所示。 表7 审核表单数据输入参数说明 参数 必填 说明 Cookie 是 Cookie。 Content-Type 是 Content-Type。 formid 否 formid。 CreateOrgId 否 CreateOrgId。 Ids 否 Ids。 InterationFlags 否 InterationFlags。 NetworkCtrl 否 NetworkCtrl。 IsVerifyProcInst 是 IsVerifyProcInst。 IgnoreInterationFlag 否 IgnoreInterationFlag。 Numbers 否 Numbers。支持输入框和数组两种模式。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表8。 表8 审核表单数据输出参数说明 参数 说明 ResponseStatus ResponseStatus。 -ErrorCode 错误码。 -IsSuccess 是否成功。 -Errors 错误描述。 --FieldName 字段名称。 --Message Message --DIndex DIndex -SuccessEntitys SuccessEntitys --Id ID --Number Number --DIndex DIndex -SuccessMessages SuccessMessages --FieldName 字段名称。 --Message Message。 --DIndex DIndex。

获取sessionId 输入参数 输入参数说明如表3所示。 表3 获取sessionId输入参数说明 参数 必填 说明 acctID 是 acctID。 username 是 用户名。 password 是 密码。 lcid 是 lcid。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表4。 表4 获取sessionId输出参数说明 参数 说明 字符串 输出结果为字符串。

表单数据查询 输入参数 输入参数说明如表1所示。 表1 表单数据查询输入参数说明 参数 必填 说明 Cookie 是 Cookie。 Content-Type 是 Content-Type。 表单ID 是 表单ID。支持输入框和下拉框两种模式。 生产BOM表单 BOS_ASSISTANTDATA_DETAIL 单位表单 人员表单 采购订单表单 组织表单 入场记录表单 PRD_INSTOCK 最多允许查询数量 否 最多允许查询数量。 每页数据量 否 每页数据量。 分页开始行索引 否 分页开始行索引。 查询字段 是 查询表单数据的字段。 过滤条件 否 过滤条件。 排序条件 否 排序条件。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表2。 表2 表单数据查询输出参数说明 参数 说明 字符串 输出结果为字符串。

提交表单数据 输入参数 输入参数说明如表5所示。 表5 提交表单数据输入参数说明 参数 必填 说明 Cookie 是 Cookie。 Content-Type 是 Content-Type。 formid 否 formid。 CreateOrgId 否 CreateOrgId。 Ids 否 Ids。 SelectedPostId 否 SelectedPostId。 NetworkCtrl 否 NetworkCtrl。 IgnoreInterationFlag 否 IgnoreInterationFlag。 Numbers 否 Numbers。支持输入框和数组两种模式。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表6。 表6 提交表单数据输出参数说明 参数 说明 ResponseStatus ResponseStatus。 -ErrorCode 错误码。 -IsSuccess 是否成功。 -Errors 错误描述。 --FieldName 字段名称。 --Message Message --DIndex DIndex -SuccessEntitys SuccessEntitys --Id ID --Number Number --DIndex DIndex -SuccessMessages SuccessMessages --FieldName 字段名称。 --Message Message。 --DIndex DIndex。

更多操作 创建和关联流水线完成后，您还可以执行如下表5所示操作。 表5 更多操作 操作 步骤 查看流水线运行历史 在流水线列表中单击流水线名称，进入“流水线运行历史”页面： 选择“流水线详情”页签，查看流水线编排的详情。 选择“执行历史”页面，选择时间段，可查看该时间段的流水线执行详情信息。 执行流水线 在当前服务版本的流水线列表中已关联的流水线所在行的“操作”列，单击“执行”。 在“执行构建”对话框，单击“确定”，流水线开始构建版本的发布软件包。 说明： 在流水线进行中，单击“操作”列“终止”可停止构建。 一个版本可多次重复执行发布构建，但以最后一次的构建结果为准。 解除关联流水线 在流水线列表“操作”列，单击“解除关联”。 单击“确认”，解除此流水线与当前版本的关联。 版本基线化 版本基线化是版本发布前的必要操作。在申请版本标准发布前，需要通过版本基线化将流水线执行完的发布构建产物（软件包）复制至OBS中心。 具体操作请参见版本基线化。

配置流水线（以添加业务包构建任务为例） 在流水线的“任务编排”页面，单击或者。 单击，在“编辑阶段”页面，修改“阶段名称”为“构建阶段”，并将“总是运行”设置为“是”（选择“是”，表示流水线执行时，该阶段下的任务默认选中必须执行且不可取消；选择“否”，表示流水线执行时，该阶段下的任务默认选中但可以取消。），然后单击“确定”。 在流水线的“构建阶段”，单击“新建任务”。 在“新建任务”页面的右侧区域，选择“构建”页签，搜索“Build构建”并将鼠标移至该插件卡片，单击“添加”，将此插件添加到任务中。 在“任务配置”页面右侧区域“请选择需要调用的任务”处单击“点击创建”，如图2所示。 图2 Build构建任务配置 在“新建构建任务”页面的“基本信息”页面，自定义任务名称（以“adadss-build”为例），归属项目默认为当前服务，源码源选择“Repo”，选择对应的代码仓库（以创建好的“adadss”仓库为例）以及分支“master”，单击“下一步”。 在“构建模板”页面，选择“空白构建模板”模板，然后单击“下一步”，进入“构建步骤”的“图形化”页签，该页面的“构建环境配置”和“代码下线配置”无需配置，保持默认配置即可。 配置构建步骤“Maven构建”。 返回“构建步骤”页签，单击“点击添加构建步骤”，在右侧“添加步骤”页面搜索“Maven构建”，鼠标移至插件卡片并单击“添加”。 执行maven构建命令将业务代码打包，不同项目有所不同。 参考示例：mvn -Dassembly clean compile package -Dmaven.test.skip=true -U -T4 若某些jar包依赖不到，可将仓库地址添加在setting配置的公有依赖仓库。 配置镜像构建。 登录华为云 容器镜像服务 控制台，在左侧导航栏选择“我的镜像”，单击右上角“页面上传”，在“页面上传”对话框，创建组织（必须使用华为云账号），单击“选择镜像文件”，选择已经准备好的基础镜像tar包，单击“开始上传”，待任务进度显示“上传完成”，表示镜像文件上传成功。 基础镜像tar包仅需上传一次，后续可直接从镜像文件列表中选取。 在镜像仓库找到9.a上传的基础镜像，参照图3复制镜像地址。 图3 复制镜像地址 将9.b复制的镜像地址粘贴到Dockerfile文件中第一行FROM命令后，如图4所示。 图4 将镜像地址粘贴到Dockerfile文件中 返回华为云容器 镜像服务 控制台镜像列表中单击镜像tar包名称，进入镜像详情页面，选择“Pull/Push指南”页签，单击“操作步骤”中的“生成登录指令”。 在“登录指令”对话框中的“临时登录指令”框的指令末尾处单击，复制临时登录指令，如图5所示。 图5 复制临时登录指令 返回“构建步骤”页面，单击“添加步骤”，在右侧“添加步骤”页面搜索“执行Docker命令”，鼠标移至该插件卡片并单击“添加”。 单击“执行Docker命令”步骤，在右侧“命令”参数下单击“添加”添加docker命令，在“命令”下拉框中选择“login”，参数框中输入“-u cn-north-7@K5X8GVN5B4H4B8KB9SDO -p 1dd00acee886bd05886cded19f5af1cb1e96326e4354fc0f3f493f12a3586518 swr.cn-north-7.myhuaweicloud.com”，登录环境以便Dockerfile文件中可正常获取基础镜像。 在“操作”列单击“+”继续添加docker命令，“命令”下拉框中选择“build”，参数框中输入“-t helloworldservice:23.11.02.1 -f ./deploy_docker/Dockerfile .”，指定代码仓中的Dockerfile文件，构建镜像。 工作目录一般为根目录。 在“操作”列单击“+”继续添加docker命令，“命令”下拉框中选择“save”，参数框中输入“-o helloworldservice.23.11.02.1.tar helloworldservice:23.11.02.1”，将镜像包保存为tar包。至此，添加docker命令完成，如图6所示。 图6 执行docker命令 返回“构建步骤”页面，单击“添加步骤”，在右侧“添加步骤”页面搜索“Maven构建”，鼠标移至插件卡片并单击“添加”。执行zip命令，将tar包与业务代码中的package.json文件直接压缩成一个zip包。 参考命令：zip helloworldservice_23.11.02.1.zip helloworldservice.23.11.02.1.tar package.json 继续单击“添加步骤”，添加“上传文件到OBS”插件，在“上传文件到OBS”页面，参照表3配置相关参数。 表3 “上传文件到OBS”(业务包）步骤配置的参数说明 参数名称 参数说明 步骤显示名称 构建步骤的名称，默认为“上传文件到OBS”，保持默认或自定义修改均可。 授权用户 在下拉列表选择： 当前用户：上传到当前租户的OBS桶。 其他用户：可以通过选择 IAM 账号的方式上传到指定租户的OBS桶。 IAM账号 “授权用户”选择“其他用户”时需配置此参数，配置步骤如下： 单击“管理IAM账号”，进入“服务扩展点管理”页面。 单击“新建服务扩展点”，选择“IAM账户”，弹出“新建服务扩展点”对话框，填写以下参数，补充租户下用户的AK、SK即可： 连接名称：服务扩展点的名称。例如“obs权限”。 Access Key Id：访问密钥ID（AK），获取访问密钥AK/SK。 Secret Access Key：秘密访问密钥（SK），获取访问密钥AK/SK。 信息填写完成，单击“确定”。 构建产物路径 路径为10的zip包的相对路径或输入*模糊匹配（如“./DemoServiceB/*.zip”） 桶名 用户自定义构建结果上传到的目标OBS桶名。 OBS存储目录 用户自定义构建结果在OBS上的存储目录 OBS存储文件名 非必填项，构建结果在OBS上的存储文件名（不包含目录），留空时可上传多个文件，取构建产物文件名为OBS存储文件名；不为空时只能上传单个文件，如 application.jar。 是否上传文件夹 非必填项，可选择是否开启上传文件夹。 OBS头域 非必填项，上传文件时加入一个或多个自定义的响应头，当用户下载此对象或查询此对象元数据时，加入的自定义响应头会在返回消息的头域中出现。如：“键”填写成“x-frame-options”，“值”填写成“false”，即可禁止OBS中存放的网页被第三方网页嵌入。 单击右上角“新建”，配置构建任务完成。 返回5的“任务配置”页面，在“请选择需要调用的任务”下拉列表中选择12配置完成的构建任务，“仓库”下拉列表选择创建代码仓库中已创建的仓库，其他参数无需配置，保持默认即可。 单击“确定”，添加业务包构建任务完成。 单击“任务编排”页面右上角“保存”，保存流水线的任务配置。

使用须知 流水线管理是开发中心结合流水线CodeArts Pipeline和编译构建CodeArts Build服务的能力，提供可视化、可编排的CI/CD持续交付软件生产线，帮助企业快速转型，实现DevOps持续交付高效自动化，缩短应用TTM（Time to Market）交付周期，提升研发效率。 流水线服务本质上是一个可视化的自动化任务调度平台，需要配合软件开发生产线中编译构建、代码检查、测试计划、部署等服务的自动化任务使用。根据用户需要的场景，如开发测试环境应用部署、生产环境应用部署等，对这些自动化任务进行自定义编排，一次配置后就可以一键自动化触发调度执行，避免频繁低效的手工操作。 关于流水线的详细介绍文档请参考流水线CodeArts Pipeline和编译构建 CodeArts Build。

配置流水线（以添加代码检查任务为例） 在流水线的“任务编排”页面，单击或者。 单击，在“编辑阶段”页面，修改“阶段名称”为“代码检查”，并将“总是运行”设置为“否”（选择“是”，表示流水线执行时，该阶段下的任务默认选中必须执行且不可取消；选择“否”，表示流水线执行时，该阶段下的任务默认选中但可以取消。），然后单击“确定”。 在流水线的“代码检查”阶段，单击“新建任务”。 在“新建任务”页面的右侧区域，选择“代码检查”页签，搜索“CodeArtsCheck代码检查”并将鼠标移至该插件卡片，单击“添加”，将此插件添加到任务中。 在“任务配置”页面右侧区域“请选择需要调用的任务”处单击“点击创建”。 在“新建任务”页面，参照表2配置参数信息（此处以创建Repo源码源检查任务为例）。 表2 参数说明 参数项 描述 归属项目 任务所属项目。默认填写，无需设置。 代码源 选择Repo，从代码托管拉取代码进行检查。 任务名称 代码检查任务名称，可自定义。 仓库 选择需要检查的代码仓库。 分支 填写需要检查的仓库分支名称。 检查语言 选择需要检查的代码语言。 单击“新建任务”，进入“代码检查详情”页面，单击“开始检查”，即可执行代码检查任务。执行完代码检查任务后，还可以根据需要查看检查结果。 返回5的“任务配置”页面，在“请选择需要调用的任务”下拉列表中选择7配置完成的代码检查任务，“仓库”下拉列表选择创建代码仓库中已创建的仓库，其他参数无需配置，保持默认即可。 单击“确定”，添加代码检查任务完成。 单击“任务编排”页面右上角“保存”，保存流水线的任务配置。

查询调度计划 查询调度计划。 输入参数 用户配置查询调度计划执行动作，相关参数说明如表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 获取数据源中所有的表输出参数说明 参数 说明 数据源中所有的表名称 数据源中所有的表名称。

任务监控信息列表查询 任务监控信息列表查询。 输入参数 用户配置任务监控信息列表查询执行动作，相关参数说明如表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-执行中，SUC CES S-执行成功，CANCELLED-任务取消，ERROR-执行异常。 任务源端数据源所属应用ID 任务源端数据源所属应用ID。 任务源端数据源所属应用名称 任务源端数据源所属应用名称。 任务源端数据源所属实例ID 任务源端数据源所属实例ID。 任务目标端数据源所属应用ID 任务目标端数据源所属应用ID。 任务目标端数据源所属应用名称 任务目标端数据源所属应用名称。 任务目标端数据源所属实例ID 任务目标端数据源所属实例ID。 任务扩展类型 任务扩展类型，当前如果是CDC组合任务，该字段为CDC，否则为null。 任务所属企业项目ID 任务所属企业项目ID，默认为0。 任务标签 任务标签。

更新普通任务 更新普通任务。 输入参数 用户配置更新普通任务执行动作，相关参数说明如表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。 源端数据源所属集成应用名称 源端数据源所属集成应用名称。 目标端数据源所属集成应用名称 目标端数据源所属集成应用名称。 创建时间 任务的创建时间。 最近一次的修改时间 最近一次的修改时间。 描述信息 描述信息。 任务标签 任务标签，只能包含字母、数字、中划线、下划线。 任务的创建者 任务的创建者。

查询任务列表 查询任务列表。 输入参数 用户配置查询任务列表执行动作，相关参数说明如表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。 任务标签 任务标签。

修改调度计划 通过任务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。 任务名称 任务名称。 失败的错误码 失败的错误码。 错误详情 错误详情。

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

任务监控日志查询 查询单个任务的所有日志信息。 输入参数 用户配置任务监控日志查询执行动作，相关参数说明如表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时区。

连接参数 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表达式。

发送邮件 将邮件发送到指定邮箱。 输入参数 用户配置发送邮件执行动作，相关参数说明如表2所示。 表2 发送邮件输入参数说明 参数 必填 说明 示例值/默认值 收件人 是 收件人邮箱，如果有多个收件人使用逗号隔开。 example@163.com 抄送 否 邮件需要抄送人邮箱。 example1@163.com 密送 否 邮件需要密送人邮箱。 example2@163.com 邮件主题 是 邮件主题。 作业 邮件内容 是 邮件内容。 题目1..... 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 发送邮件输出参数说明 参数 说明 示例值/默认值 操作结果 操作结果描述。 success 操作失败描述 如果发送失败显示。 false