华为云用户手册

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

提交表单数据 输入参数 输入参数说明如表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配置完成的构建任务，“仓库”下拉列表选择创建代码仓库中已创建的仓库，其他参数无需配置，保持默认即可。 单击“确定”，添加业务包构建任务完成。 单击“任务编排”页面右上角“保存”，保存流水线的任务配置。

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

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

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

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

气象预警查询 根据城市名和日期查询相关气象预警信息。 输入参数 用户配置气象预警查询执行动作，相关参数说明如表2所示。 表2 气象预警查询输入参数说明 参数 必填 说明 城市名 是 城市名称(含市)。 查询日期 否 查询日期(yyyy-MM-dd)。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 气象预警查询输出参数说明 参数 说明 返回结果集 返回结果集，无预警信息时返回空。 预警消息标题 预警消息标题。 预警等级 预警等级，橙色/红色/蓝色/黄色/未知。 预警类型 预警类型。 预警发布时间 预警发布时间。 省份 省份，可能为空。 城市 城市，可能为空。 区域 区域，可能为空。 预警详细内容 预警详细内容。

周边停车场查询 周边停车场查询。 输入参数：包含“页码”、“页码”、“距离范围”必填参数。“纬度”、“经度”选填参数。 输出参数：包含“响应内容”、“总数”、“停车场详细信息”、“区域”、“地址”、“经度”、“停车场图片列表”、“范围”、“城市名”、“总数车位”、“收费描述”、“停车ID”、“停车场类型”、“剩余车位”、“是否预定”、“省份”、“价格”、“价格单位”、“停车场名称”、“纬度”参数。

删除部门 删除部门信息。 输入参数 输入参数说明如表37所示。 表37 删除部门输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 部门id 是 部门ID。 说明： 不能删除根部门，不能删除含有子部门、成员的部门。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表38。 表38 删除部门输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

获取成员信息 在通讯录同步助手中此接口可以读取企业通讯录的所有成员的信息，而自建应用可以读取该应用设置的可见范围内的成员信息。 输入参数 输入参数说明如表41所示。 表41 获取成员信息输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 成员UserID 是 成员UserID。对应管理端的账号，企业内必须唯一。不区分大小写，长度为1~64个字节。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表42。 表42 获取成员信息输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。 成员UserID 成员UserID。对应管理端的账号，企业内必须唯一。不区分大小写，长度为1~64个字节。 成员名称 成员名称；第三方不可获取，调用时返回userid以代替name，代开发自建应用需要管理员授权才返回。对于非第三方创建的成员，第三方通讯录应用也不可获取。未返回name的情况需要通过通讯录展示组件来展示名字。 手机号码 手机号码，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 成员所属部门id列表 成员所属部门ID列表，仅返回该应用有查看权限的部门ID；成员授权模式下，固定返回根部门ID，即固定为1。对授权了“组织架构信息”权限的第三方应用，返回成员所属的全部部门ID。 部门内的排序值 部门内的排序值，默认为0。数量必须和department一致，数值越大排序越前面。值范围是0, 2^32)。[成员授权模式下不返回该字段。 职务信息 职务信息。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 性别 性别。0表示未定义，1表示男性，2表示女性。第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。不可获取指返回值0。 邮箱 邮箱，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 企业邮箱 企业邮箱，代开发自建应用不返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 表示在所在的部门内是否为部门负责人 表示在所在的部门内是否为部门负责人，数量与department一致；第三方通讯录应用或者授权了“组织架构信息-应用可获取企业的部门组织架构信息-部门负责人”权限的第三方应用可获取；对于非第三方创建的成员，第三方通讯录应用不可获取；上游企业不可获取下游企业成员该字段。 直属上级UserID 直属上级UserID，返回在应用可见范围内的直属上级列表，最多有五个直属上级；第三方通讯录应用或者授权了“组织架构信息-应用可获取可见范围内成员组织架构信息-直属上级”权限的第三方应用可获取；对于非第三方创建的成员，第三方通讯录应用不可获取；上游企业不可获取下游企业成员该字段。 头像url 头像url。 第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 头像缩略图url 头像缩略图url。第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 座机 座机。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 别名 别名；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 地址 地址。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 全局唯一 全局唯一。对于同一个服务商，不同应用获取到企业内同一个成员的open_userid是相同的，最多64个字节。仅第三方应用可获取。 主部门 主部门，仅当应用对主部门有查看权限时返回。 扩展属性 扩展属性，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 激活状态 激活状态。 1：已激活 2：已禁用 4：未激活 5：退出企业 已激活代表已激活企业微信或已关注微信插件（原企业号）。未激活代表既未激活企业微信又未关注微信插件（原企业号）。 员工个人二维码 员工个人二维码，扫描可添加为外部联系人(注意返回的是一个url，可在浏览器上打开该url以展示二维码)；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 对外职务 对外职务，如果设置了该值，则以此作为对外展示的职务，否则以position来展示。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 成员对外属性 成员对外属性，字段详情见对外属性；代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。

获取打卡记录数据 获取打卡的记录数据。 输入参数 输入参数说明如表43所示。 表43 获取打卡记录数据输入参数说明 参数 必填 说明 获取打卡记录的结束时间 是 获取打卡记录的结束时间，unix时间戳。 打卡类型 是 打卡类型。 上下班打卡 外出打卡 全部打卡 获取打卡记录的开始时间 是 获取打卡记录的开始时间，unix时间戳。 调用接口凭证 是 调用接口凭证。必须使用打卡应用的secret获取access_token。 需要获取打卡记录的用户列表 是 需要获取打卡记录的用户列表。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表44。 表44 获取打卡记录数据输出参数说明 参数 说明 errcode 返回码。 errmsg 返回码的描述内容。 checkindata 检查数据。 -userid 用户ID。 -groupname 打卡规则名称。 -checkin_type 打卡类型。目前包含以下几种： 上班打卡 下班打卡 外出打卡 -exception_type 异常类型。如果有多个异常，以分号间隔。 异常情况包含以下情形： 时间异常 地点异常 未打卡 wifi异常 非常用设备 -checkin_time 打卡时间，unix时间戳。 -location_title 打卡地点title。 -location_detail 打卡地点详情。 -wifiname 打卡wifi名称。 -notes 打卡备注。 -wifimac 打卡的MAC地址/bssid。 -mediaids 打卡的附件media_id，可使用media/get获取附件。 -sch_checkin_time 标准打卡时间，指此次打卡时间对应的标准上班时间或标准下班时间。 -groupid 规则ID，表示打卡记录所属规则的ID。 -schedule_id 班次ID，表示打卡记录所属规则中，所属班次的ID。 -timeline_id 时段ID，表示打卡记录所属规则中，某一班次中的某一时段的ID，如上下班时间为9:00-12:00、13:00-18:00的班次中，9:00-12:00为其中一组时段。 -lat 位置打卡地点维度，是实际维度的1000000倍，与腾讯地图一致采用GCJ-02坐标系统标准。 -lng 位置打卡地点经度，是实际经度的1000000倍，与腾讯地图一致采用GCJ-02坐标系统标准。 -deviceid 打卡设备ID。

获取子部门ID列表 该接口用于获取子部门的ID列表。 输入参数 输入参数说明如表29所示。 表29 获取子部门ID列表输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的secret获取access_token。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表30。 表30 获取子部门ID列表输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。 部门列表数据 部门列表数据。 -id 创建的部门ID。 -parentid 父部门ID。根部门为1。 -order 在父部门中的次序值。order值大的排序靠前。值范围是[0, 2^32]。

获取单个部门详情 获取单个部门详情。 输入参数 输入参数说明如表31所示。 表31 获取单个部门详情输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的Secret获取access_token。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表32。 表32 获取单个部门详情输出参数说明 参数 说明 返回码 返回码。 返回码描述 对返回码的文本描述内容。 部门详情 部门详情。 -id 创建的部门ID。 -name 部门名称，代开发自建应用需要管理员授权才返回。 -name_en 英文名称。 -department_leader 部门负责人的UserID；第三方仅通讯录应用可获取。 -parentid 父部门ID。根部门为1。 -order 在父部门中的次序值。order值大的排序靠前。 值范围是[0, 2^32]。

创建成员 创建成员信息。 输入参数 输入参数说明如表33所示。 表33 创建成员输入参数说明 参数 必填 说明 属性名称 是 属性名称。 需要先确保在管理端有创建该属性，否则会忽略。 文本属性内容 是 文本属性内容，长度限制64个UTF8字符。 属性类型 是 属性类型。 0：文本 1：网页 2：小程序 网页的展示标题 是 网页的展示标题，长度限制12个UTF8字符。 网页的url 是 网页的url。必须包含http或者https头。 external_corp_name 否 external_corp_name。 成员名称 是 成员名称。长度为1~64个utf8字符。 成员UserID 是 成员UserID。对应管理端的账号，企业内必须唯一。 长度为1~64个字节。只能由数字、字母和“_-@.”四种字符组成，且第一个字符必须是数字或字母。系统进行唯一性检查时会忽略大小写。 调用接口凭证 是 调用接口凭证。 成员所属部门id列表 否 成员所属部门ID列表，不超过100个。 attrs 否 请选择数组类型的节点输出。 external_attr 否 请选择数组类型的节点输出。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表34。 表34 创建成员输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

获取指定日程 该接口用于获取指定的日程详情。 输入参数 输入参数说明如表25所示。 表25 获取指定日程输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的Secret获取access_token。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表26。 表26 获取指定日程输出参数说明 参数 说明 返回码 返回码。 返回码描述 对返回码的文本描述内容。 日程列表 日程列表。 -schedule_id 日程ID。 -organizer 组织者不多于64字节。 -attendees 日程参与者列表。最多支持2000人。 --userid 日程参与者ID。 --response_status 日程参与者的接受状态。 0：未处理 1：待定 2：全部接受 3：仅接受一次 4：拒绝 -summary 日程标题。 -description 日程描述。 -reminders 提醒相关信息。 --is_remind 是否需要提醒。 0：否 1：是 --is_repeat 是否重复日程。 0：否 1：是 --remind_before_event_secs 日程开始（start_time）前多少秒提醒。 当is_remind为1时有效。 --remind_time_diffs 日程开始（start_time）与提醒时间的差值。 当is_remind为1时有效。 --repeat_type 重复类型，当is_repeat为1时有效。 目前支持如下类型： 0：每日 1：每周 2：每月 5：每年 7：工作日 --repeat_until 重复结束时刻，Unix时间戳。 不填或填0表示一直重复。 --is_custom_repeat 是否自定义重复。 0：否 1：是 --repeat_interval 重复间隔仅当指定为自定义重复时有效该字段随repeat_type不同而含义不同。 --repeat_day_of_week 每周周几重复仅当指定为自定义重复且重复类型为每周时有效。 取值范围：1~7，分别表示周一至周日。 --repeat_day_of_month 每月哪几天重复仅当指定为自定义重复且重复类型为每月时有效。 取值范围：1~31，分别表示1~31号。 --timezone 时区。UTC偏移量表示(即偏离零时区的小时数)，东区为正数，西区为负数。 --exclude_time_list 重复日程不包含的日期列表。对重复日程修改/删除特定一天或多天，则原来的日程将会排除对应的日期。 ---start_time 不包含的日期时间戳。 -location 日程地址不多于128个字符。 -cal_id 日程所属日历ID。该日历必须是access_token所对应应用所创建的日历。 -start_time 日程开始时间，unix时间戳。 -end_time 日程结束时间，unix时间戳。 -status 日程状态。 0：正常 1：已取消

获取部门列表 获取部门列表。 输入参数 输入参数说明如表27所示。 表27 获取部门列表输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的secret获取access_token。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表28。 表28 获取部门列表输出参数说明 参数 说明 返回码 返回码。 返回码描述 对返回码的文本描述内容。 部门详情 部门详情。 -id 创建的部门ID。 -name 部门名称，代开发自建应用需要管理员授权才返回。 -name_en 英文名称。 -department_leader 部门负责人的UserID；第三方仅通讯录应用可获取。 -parentid 父部门ID。根部门为1。 -order 在父部门中的次序值。order值大的排序靠前。 取值范围是[0, 2^32]。

获取部门成员列表 该接口用于获取部门成员列表。 输入参数 输入参数说明如表23所示。 表23 获取部门成员列表输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的secret获取access_token。 获取的部门id 是 获取的部门ID。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表24。 表24 获取部门成员列表输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。 成员列表 成员列表。 -userid 成员UserID。对应管理端的账号。 -name 成员名称，代开发自建应用需要管理员授权才返回。 -department 成员所属部门列表。列表项为部门ID，32位整型。 -open_userid 全局唯一。对于同一个服务商，不同应用获取到企业内同一个成员的open_userid是相同的，最多64个字节。仅第三方应用可获取。

获取指定日历 该接口用于获取应用在企业内创建的日历信息。 输入参数 输入参数说明如表19所示。 表19 获取指定日历输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的Secret获取access_token。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表20。 表20 获取指定日历输出参数说明 参数 说明 错误码 错误码。 错误码说明 错误码说明。 日历列表 日历列表。 -cal_id 日历ID。 -organizer 指定的组织者userid。 -readonly 日历组织者对日历是否只读权限。 0：否 1：是 -summary 日历标题。标题长度为1~128 字符。 -color 日历颜色，用RGB颜色编码16进制表示。 例如：#0000FF表示纯蓝色。 -description 日历描述。长度为0~512 字符。 -shares 日历共享成员列表。共享成员最多2000人。 --userid 日历共享成员的ID。 --readonly 共享成员对日历是否只读权限。 0：否 1：是