ROMA数据集成

连接参数

ROMA数据集成连接器使用IAM认证，连接参数说明如表1所示。

创建调度计划

创建调度计划。

• 输入参数

  用户配置查询事件通道列表执行动作，相关参数说明如表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表达式。

手工触发单个任务

手工触发一次任务调度。

• 输入参数

  用户配置手工触发单个任务执行动作，相关参数说明如表4所示。

  表4 手工触发单个任务输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  任务ID	是	任务ID。

• 输出参数

  该执行动作无输出参数。

通过任务ID查询指定任务的信息

通过任务ID查询指定任务的信息。

• 输入参数

  用户配置通过任务ID查询指定任务的信息执行动作，相关参数说明如表5所示。

  表5 通过任务ID查询指定任务的信息输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  任务ID	是	任务ID。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表6。

  表6 通过任务ID查询指定任务的信息输出参数说明

  参数	说明
  任务ID	任务ID，可为空。
  任务名称	任务名称，只能以字母、数字为开头，包含字母、数字和 . _ - 3~100个字符。
  任务类型	任务类型，- realtime (实时) ，- timing (定时)。
  任务状态	任务状态，- stop (0停止\未启动) ，- running (1运行中)。
  项目ID	项目ID。
  源端数据源ID	源端数据源ID。
  目标端数据源ID	目标端数据源ID。
  源端数据源的名称	源端数据源的名称。
  目标端数据源的名称	目标端数据源的名称。
  源端数据源所属集成应用ID	源端数据源所属集成应用ID。
  目标端数据源所属集成应用ID	目标端数据源所属集成应用ID。
  源端数据源所属集成应用名称	源端数据源所属集成应用名称。
  目标端数据源所属集成应用名称	目标端数据源所属集成应用名称。
  创建时间	任务的创建时间。
  最近一次的修改时间	最近一次的修改时间。
  描述信息	描述信息。
  任务标签	任务标签，只能包含字母、数字、中划线、下划线。
  任务的创建者	任务的创建者。
  参数类型为string	参数类型为string，参数结构参照附录中“数据集成参数说明>RawFormDataResponse”章节。

查询数据源

查询数据源。

• 输入参数

  用户配置查询数据源执行动作，相关参数说明如表7所示。

  表7 查询数据源输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  每页显示条目数量	否	每页显示条目数量，最大数量999，超过999后只返回999。
  分页查询	否	分页查询，分页的偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0。
  数据源类型	否	数据源类型。
  排序字段	否	排序字段（CREATED_DATE）。
  数据源排序类型	否	查询数据源排序的类型，增序还是降序，可为空。
  数据源名称	否	数据源名称，支持模糊匹配。
  集成应用ID	否	集成应用ID。
  连接器ID	否	连接器ID。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表8。

  表8 查询数据源输出参数说明

  参数	说明
  满足条件的对象个数	返回所有满足条件的对象个数。
  返回对象的大小	返回对象的大小。
  返回的实体对象	返回的实体对象。
  数据源ID	数据源ID。
  数据源名称	数据源名称。
  数据源类型	数据源类型。
  数据源所属虚拟私有云VpcId	数据源所属虚拟私有云VpcId。
  数据源所属应用ID	数据源所属应用ID。
  数据源所属应用名称	数据源所属应用名称。
  数据源所属实例Id	数据源所属实例ID。
  数据源创建时间	数据源创建时间。
  数据源修改时间	数据源修改时间。
  数据源所属连接器Id	数据源所属连接器ID。
  gauss100的版本号	gauss100的版本号：- V100R003C20，- V300R001C00。
  主机IP地址	主机IP地址。 - 数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ类型时需要配置； - 数据源为MYSQL、ORACLE、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ARTEMISMQ、POSTGRESQL/OPENGAUSS、HIVE类型且mode为default时需要配置； - 数据源为HL7类型且作为目标端（position为target）时需要配置； - 初始值为空，配置任务启动后生成host。
  端口	端口，端口号为0到65535。 - 数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ，obs类型时需要配置； - 数据源为MYSQL、ORACLE、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ARTEMISMQ、POSTGRESQL/OPENGAUSS、HIVE类型且mode为default时需要配置； - 数据源为HL7类型且作为目标端（position为target）时需要配置。
  数据库名称	数据库名称。 - 数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ，obs类型时需要配置； - 数据源为MYSQL、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ARTEMISMQ、POSTGRESQL/OPENGAUSS、HIVE类型且mode为default时需要配置； - 数据源为ORACLE类型且mode为（default、multiAddress）时需要配置。
  REDIS数据源类型配置	REDIS数据源类型配置，数据库编号，纯数字编码。
  访问服务的用户名	访问服务的用户名： - 数据源为MYSQL、DWS、FTP、ORACLE、MONGODB、HANA、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ACTIVEMQ、ARTEMISMQ、POSTGRESQL/OPENGAUSS、RABBITMQ、SAP、IBMMQ、HIVE类型时需要配置； - 数据源为WEBSOCKET类型，认证方式（basicauth）时需要配置； - 数据源为LDAP，安全认证类型（security_auth_type）为simple时需要配置。
  访问服务的密码	访问服务的密码： - 数据源为MYSQL、DWS、FTP、ORACLE、MONGODB、HANA、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ACTIVEMQ、ARTEMISMQ、POSTGRESQL/OPENGAUSS、RABBITMQ、SAP、IBMMQ、HIVE类型时需要配置 ； - 数据源为WEBSOCKET，且认证方式（basicauth）时需要配置 ； - 数据源为LDAP，且安全认证类型（security_auth_type）为simple时需要配置。
  数据源连接模式	数据源连接模式： - 数据源为DWS、MONGODB、REDIS、HANA时配置默认； - 数据源为MYSQL、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、POSTGRESQL/OPENGAUSS、HIVE时配置（default,professional）； - 数据源为ORACLE时配置专有的模式multiAddress。
  cdc模式	cdc模式，只有组合任务使用。
  ORACLE集群地址	ORACLE集群地址，当mode为multiAddress时需要配置。
  oracle_address	ORACLE地址。
  oracle_port	ORACLE端口。
  ORACLE集群服务名	ORACLE集群服务名。
  访问FTP服务的连接模式	访问FTP服务的连接模式：- active (主动模式)，- passive (被动模式)。
  访问FTP服务协议类型	访问FTP服务协议类型：- sftp，- ftp。 说明： FTP协议本身存在安全风险，建议您使用SFTP安全协议。
  地址	地址： - OBS (obs远端地址，obs数据源使用) - MONGODB (MONGODB数据源类型主机IP地址，多个IP:PORT，使用","隔开) - REDIS (redis服务地址，多个IP:PORT, 使用","隔开)
  Access Key ID	Access Key ID，数据源为OBS，DIS类型时需要配置。
  Secret Access Key	Secret Access Key，数据源为OBS，DIS类型时需要配置。
  桶名称	桶名称，数据源为OBS时需要配置。
  是否使用https	是否使用https，数据源为OBS时需要配置，一般默认使用。
  连接字符串	连接字符串，访问url ： - 数据源为API、LDAP、WEBSOCKE类型时需要配置； - 数据源为MYSQL、ORACLE、DB2、GAUSS100、GaussDB(for MySQL)、POSTGRESQL，且mode配置为professional专业时需要配置。
  访问API请求方式	访问API请求方式：- POST - PUT - DELETE - PATCH - GET。
  访问WEBSOCKET服务的认证方式	访问WEBSOCKET服务的认证方式：- none，- basicauth。
  访问API服务的认证方式	访问API服务的认证方式：- none - basicauth - oauth2.0 - hmac - secret - md5 - apiGateway - keyTop - hikVision - huaweiNetworkManagement - liHe。
  访问API服务的APP认证方式	访问API服务的APP认证方式，认证方式为（apiGateway）时填写 - default - secret - jwt。
  访问API服务的用户名	访问API服务的用户名，认证方式为（lihe、huaweiNetworkManagement、basicauth）时填写。
  访问API服务的密码	访问API服务的密码，认证方式为（lihe、huaweiNetworkManagement、basicauth、secret、md5、hmac）时填写。
  访问API服务的AppKey	访问API服务的AppKey，认证方式为（apiGateway、oauth2.0）时填写。
  访问API服务的AppSecret	访问API服务的AppSecret，认证方式为（apiGateway、oauth2.0）时填写。
  访问API服务的Secret	访问API服务的Secret， 认证方式为（KeyTop、HikVision、Secret、HMAC、MD5）时填写。
  访问API服务的备用IP	访问API服务的备用IP，认证方式为（HuaweiNetworkManagement）时填写。
  访问API服务的AccessTokenUrl	访问API服务的AccessTokenUrl，认证方式为（liHe、oauth2.0 huaweiNetworkManagement）时填写。
  访问API服务的Scope	访问API服务的Scope，认证方式为（LiHe、Oauth2）时填写。
  访问API服务的Authorization	访问API服务的Authorization，认证方式为（LiHe）时填写。
  访问API服务的授权类型	访问API服务的授权类型，认证方式为（LiHe、Oauth2）时填写，- client_credentials （oauth2.0使用）。
  KAFKA、ACTIVEMQ的服务器地址	KAFKA、ACTIVEMQ的服务器地址，多个IP:PORT, 使用","分隔。
  是否开启SSL认证	是否开启SSL认证： - 数据源为KAFKA时需要配置，连接MQS内网地址时，如果MQS同时开启了SSL与VPC内网明文访问，请选择“否” ； - 数据源为ARTEMISMQ、ACTIVEMQ、RABBITMQ、IBMMQ时需要配置； - 数据源为HL7时且作为源端时需要配置。
  SSL用户名/应用Key	SSL用户名/应用Key，数据源为KAFKA且开启SSL认证时需要配置。
  SSL密码/应用Secret	SSL密码/应用Secret，数据源为KAFKA且开启SSL认证时需要配置。
  MONGODB认证源	MONGODB认证源。
  MONGODB集群模式	MONGODB集群模式：- true (集群模式)，- false （非集群模式）。
  MONGODB副本集	MONGODB副本集，当MONGODB为非集群模式时配置。
  编码格式	编码格式： - 数据源为GAUSS100、POSTGRESQL类型时配置"big5"； - 数据源为MYSQL、GaussDB(for MySQL)类型且mode为default时配置。
  MYSQL连接超时时间	MYSQL连接超时时间（秒）。
  公钥库密码	公钥库密码： - 数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置 ； - 数据源类为HL7且HL7为目标端（position为target）时，并且开启SSL认证时需要配置。
  数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置	- 数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置，公钥库密码 ； - 数据源类型为HL7且为目标端（position为target），并且开启SSL认证时需要配置，公钥库密码。
  数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置	-数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置，公钥库密码 ； - 数据源类型为HL7且为目标端（position为target），并且开启SSL认证时需要配置，公钥库密码。
  数据源类型为ACTIVEMQ、ARTEMISMQ且开启SSL认证时需要配置	数据源类型为ACTIVEMQ、ARTEMISMQ且开启SSL认证时需要配置 ：- one-way (单向认证)，- two-way (双向认证)。
  私钥库文件内容	私钥库文件内容： - 数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置； - 数据源类型HL7且为源端（position为source），并且开启SSL认证时需要配置。
  私钥库文件类型	私钥库文件类型，数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置。
  私钥库密码	私钥库密码： - 数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置； - 数据源为HL7类型，为源端（position为source）并且开启SSL认证时需要配置。
  DIS通道名称	DIS通道名称。
  DIS数据类别	DIS数据类别，JSON。
  DIS配置类别	DIS配置类别：- senior (高级)，- basic (基础)。
  DIS Endpoint	DIS Endpoint，当setting_type为senior时填写。
  DIS Region	DIS Region，当setting_type为senior时填写。
  DIS源端项目id	DIS源端项目ID，当setting_type为senior时填写。
  HL7数据源方向	HL7数据源方向：- source (源端)，- target (目标端)。
  HL7是否开启白名单设置	HL7是否开启白名单设置。
  HL7白名单	HL7白名单，允许同步数据到源端HL7的服务器地址，当HL7为源端（position为source）并且开启白名单设置(open_whitelist为true)时填写。
  LDAP安全认证类型	LDAP安全认证类型。
  RABBITMQ虚拟主机	RABBITMQ虚拟主机。
  RABBITMQ SSL认证协议	RABBITMQ SSL认证协议：- TLS。
  SAP客户端号	SAP客户端号。
  SAP实例编号	SAP实例编号。
  SNMP网络协议	SNMP网络协议：- udp，- tcp。
  SNMP版本号	SNMP版本号。
  SNMP团体名	SNMP团体名，用于访问SNMP管理代理的身份认证，相当于访问密码。
  IBMMQ字符集标识	IBMMQ字符集标识。
  IBMMQ队列管理器	IBMMQ队列管理器。
  IBMMQ通道名称	IBMMQ通道名称。
  IBMMQ密钥算法套件	IBMMQ密钥算法套件。
  HDFS URL	HDFS URL：- 数据源为MRSHIVE、MRSHDFS、FIHDFS、FIHIVE类型时配置 - fihadfs (/fdi/autotest)。
  机机交互用户名	机机交互用户名 ：- 数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、FIHDFS、FIHIVE、FIKAFKA类型时配置。
  用户认证文件	用户认证文件，文件获取方式参考《ROMA Connect API参考》的“附录>获取数据源配置文件”章节。 - 将获取到的文件打包成zip文件，文件名配置在config_file_name中，内容以BASE64编码形式放到config_file_content； - 数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、FIHDFS、FIHIVE、FIKAFKA类型时配置。
  用户认证文件内容	- 用户认证文件内容，config_file_name对应的文件内容BASE64编码 ； - 数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、FIHDFS、FIHIVE、FIKAFKA类型时配置。
  连接器实例ID	连接器实例ID，连接器发布后对应的实例ID。
  连接器对应的数据源参数	连接器对应的数据源参数，值按实际填写。
  数据源描述	数据源描述。
  集成应用权限信息	集成应用权限信息：- read (读权限) - access (调用权限) - delete (删除权限) - modify (修改权限)。

创建普通任务

创建普通任务(区别于组合任务)。

• 输入参数

  用户配置创建普通任务执行动作，相关参数说明如表9所示。

  表9 创建普通任务输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  任务名称	否	任务名称，只能以字母、数字为开头，包含字母、数字和 . _ - 3~100个字符。
  任务类型	否	任务类型：- REALTIME (实时)，- TIMING (定时)。
  源端数据源ID	否	源端数据源ID。
  目标端数据源ID	否	目标端数据源ID。
  描述信息	否	描述信息。
  任务标签	否	任务标签，只能包含字母、数字、中划线、下划线。
  参数类型为string	否	参数类型为string，参数结构参照附录中“数据集成参数说明>RawFormDataRequest”章节。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表10。

  表10 创建普通任务输出参数说明

  参数	说明
  任务ID	任务ID，可为空。
  任务名称	任务名称，只能以字母、数字为开头，包含字母、数字和 . _ - 3~100个字符。
  任务类型	任务类型，- realtime (实时)，- timing (定时)。
  任务状态	任务状态，- stop (0停止\未启动)，- running (1运行中)。
  项目ID	项目ID。
  源端数据源ID	源端数据源ID。
  目标端数据源ID	目标端数据源ID。
  源端数据源的名称	源端数据源的名称。
  目标端数据源的名称	目标端数据源的名称。
  源端数据源所属集成应用ID	源端数据源所属集成应用ID。
  目标端数据源所属集成应用ID	目标端数据源所属集成应用ID。
  源端数据源所属集成应用名称	源端数据源所属集成应用名称。
  目标端数据源所属集成应用名称	目标端数据源所属集成应用名称。
  创建时间	任务的创建时间。
  最近一次的修改时间	最近一次的修改时间。
  描述信息	描述信息。
  任务标签	任务标签，只能包含字母、数字、中划线、下划线。
  任务的创建者	任务的创建者。
  参数类型为string	参数类型为string，参数结构参照附录中“数据集成参数说明>RawFormDataResponse”章节。

任务监控日志查询

查询单个任务的所有日志信息。

• 输入参数

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

通过任务ID删除指定任务

通过任务ID删除指定任务。

• 输入参数

  用户配置通过任务ID删除指定任务执行动作，相关参数说明如表15所示。

  表15 通过任务ID删除指定任务输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  任务ID	是	任务ID。

• 输出参数

  该执行动作无输出参数。

批量启动或停止任务

批量启动或停止任务。

• 输入参数

  用户配置批量启动或停止任务执行动作，相关参数说明如表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。
  任务标签	任务标签。

修改调度计划

通过任务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表达式。

测试数据源连通性

测试数据源连通性。

• 输入参数

  用户配置测试数据源连通性执行动作，相关参数说明如表22所示。

  表22 测试数据源连通性输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  数据源ID	是	数据源ID。
  数据源名称	否	数据源名称，不能包含&、<、>、"、'、(、) ，长度为1~255字符。
  数据源类型	否	数据源类型。
  数据源所属应用ID	否	数据源所属应用ID。
  数据源所属连接器Id	否	数据源所属连接器ID。
  gauss100的版本号	否	gauss100的版本号，- V100R003C20，- V300R001C00。
  主机IP地址	否	主机IP地址。 - 数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ类型时需要配置； - 数据源为MYSQL、ORACLE、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ARTEMISMQ、POSTGRESQL/OPENGAUSS、HIVE类型且mode为default时需要配置； - 数据源为HL7类型且作为目标端（position为target）时需要配置； - 初始值为空，配置任务启动后生成host。
  端口	否	端口，端口号为0到65535。 - 数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ，obs类型时需要配置； - 数据源为MYSQL、ORACLE、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ARTEMISMQ、POSTGRESQL/OPENGAUSS、HIVE类型且mode为default时需要配置； - 数据源为HL7类型且作为目标端（position为target）时需要配置。
  数据库名称	否	数据库名称。 - 数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ，obs类型时需要配置； - 数据源为MYSQL、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ARTEMISMQ、POSTGRESQL/OPENGAUSS、HIVE类型且mode为default时需要配置； - 数据源为ORACLE类型且mode为（default、multiAddress）时需要配置。
  REDIS数据源类型配置	否	REDIS数据源类型配置，数据库编号，纯数字编码。
  访问服务的用户名	否	访问服务的用户名。
  访问服务的密码	否	访问服务的密码。
  数据源连接模式	否	数据源连接模式。
  cdc模式	否	cdc模式，只有组合任务使用。
  ORACLE集群服务名	否	ORACLE集群服务名。
  访问FTP服务的连接模式	否	访问FTP服务的连接模式：- active (主动模式)，- passive (被动模式)。
  访问FTP服务协议类型	否	访问FTP服务协议类型：- sftp，- ftp。 说明： FTP协议本身存在安全风险，建议您使用SFTP安全协议。
  地址	否	地址。 - OBS (obs远端地址，obs数据源使用) - MONGODB (MONGODB数据源类型主机IP地址，多个IP:PORT, 使用","隔开) - REDIS (redis服务地址，多个IP:PORT, 使用","隔开)
  Access Key ID	否	Access Key ID，- 数据源为OBS，DIS类型时需要配置。
  Secret Access Key	否	Secret Access Key，- 数据源为OBS，DIS类型时需要配置。
  桶名称	否	桶名称，数据源为OBS时需要配置。
  是否使用https	否	是否使用https，数据源为OBS时需要配置，一般默认使用。
  连接字符串	否	连接字符串，访问url ： - 数据源为API、LDAP、WEBSOCKE类型时需要配置； - 数据源为MYSQL、ORACLE、DB2、GAUSS100、GaussDB(for MySQL)、POSTGRESQL，且mode配置为professional专业时需要配置。
  访问API请求方式	否	访问API请求方式：- POST - PUT - DELETE - PATCH - GET。
  访问WEBSOCKET服务的认证方式	否	访问WEBSOCKET服务的认证方式：- none - basicauth。
  访问API服务的认证方式	否	访问API服务的认证方式：- none - basicauth - oauth2.0 - hmac - secret - md5 - apiGateway - keyTop - hikVision - huaweiNetworkManagement - liHe。
  访问API服务的APP认证方式	否	访问API服务的APP认证方式，认证方式为（apiGateway）时填写 - default - secret - jwt。
  访问API服务的用户名	否	访问API服务的用户名，认证方式为（lihe、huaweiNetworkManagement、basicauth）时填写。
  访问API服务的密码	否	访问API服务的密码，认证方式为（lihe、huaweiNetworkManagement、basicauth、secret、md5、hmac）时填写。
  访问API服务的AppKey	否	访问API服务的AppKey，认证方式为（apiGateway、oauth2.0）时填写。
  访问API服务的AppSecret	否	访问API服务的AppSecret，认证方式为（apiGateway、oauth2.0）时填写。
  访问API服务的Secret	否	访问API服务的Secret， 认证方式为（KeyTop、HikVision、Secret、HMAC、MD5）时填写。
  访问API服务的备用IP	否	访问API服务的备用IP，认证方式为（HuaweiNetworkManagement）时填写。
  访问API服务的AccessTokenUrl	否	访问API服务的AccessTokenUrl，认证方式为（liHe、oauth2.0 huaweiNetworkManagement）时填写。
  访问API服务的Scope	否	访问API服务的Scope，认证方式为（LiHe、Oauth2）时填写。
  访问API服务的Authorization	否	访问API服务的Authorization，认证方式为（LiHe）时填写。
  访问API服务的授权类型	否	访问API服务的授权类型，认证方式为（LiHe、Oauth2）时填写 - client_credentials （oauth2.0使用）。
  KAFKA、ACTIVEMQ的服务器地址	否	KAFKA、ACTIVEMQ的服务器地址，多个IP:PORT, 使用","分隔。
  是否开启SSL认证	否	是否开启SSL认证： - 数据源为KAFKA时需要配置，连接MQS内网地址时，如果MQS同时开启了SSL与VPC内网明文访问，请选择“否” ； - 数据源为ARTEMISMQ、ACTIVEMQ、RABBITMQ、IBMMQ时需要配置； - 数据源为HL7时且作为源端时需要配置。
  SSL用户名/应用Key	否	SSL用户名/应用Key，数据源为KAFKA且开启SSL认证时需要配置。
  SSL密码/应用Secret	否	SSL密码/应用Secret，数据源为KAFKA且开启SSL认证时需要配置。
  MONGODB认证源	否	MONGODB认证源。
  MONGODB集群模式	否	MONGODB集群模式：- true (集群模式)，- false （非集群模式）。
  MONGODB副本集	否	MONGODB副本集，当MONGODB为非集群模式时配置。
  编码格式	否	编码格式： - 数据源为GAUSS100、POSTGRESQL类型时配置"big5"； - 数据源为MYSQL、GaussDB(for MySQL)类型且mode为default时配置。
  MYSQL连接超时时间（秒）	否	MYSQL连接超时时间（秒）。
  公钥库密码	否	公钥库密码： - 数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置 ； - 数据源类为HL7且HL7为目标端（position为target）时，并且开启SSL认证时需要配置。
  数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置	否	- 数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置，公钥库密码 ； - 数据源类型为HL7且为目标端（position为target），并且开启SSL认证时需要配置，公钥库密码。
  数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置	否	-数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置，公钥库密码 ； - 数据源类型为HL7且为目标端（position为target），并且开启SSL认证时需要配置，公钥库密码。
  数据源类型为ACTIVEMQ、ARTEMISMQ且开启SSL认证时需要配置	否	数据源类型为ACTIVEMQ、ARTEMISMQ且开启SSL认证时需要配置 ：- one-way (单向认证)，- two-way (双向认证)。
  私钥库文件内容	否	私钥库文件内容： - 数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置； - 数据源类型HL7且为源端（position为source），并且开启SSL认证时需要配置。
  私钥库文件类型	否	私钥库文件类型，数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置。
  私钥库密码	否	私钥库密码： - 数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置； - 数据源为HL7类型，为源端（position为source）并且开启SSL认证时需要配置。
  私钥库私钥密码	否	私钥库私钥密码。 - 数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置； - 数据源为HL7类型，为源端（position为source）并且开启SSL认证时需要配置。
  DIS通道名称	否	DIS通道名称。
  DIS数据类别	否	DIS数据类别，JSON。
  DIS配置类别	否	DIS配置类别：- senior (高级)，- basic (基础)。
  DIS Endpoint	否	DIS Endpoint，当setting_type为senior时填写。
  DIS Region	否	DIS Region，当setting_type为senior时填写。
  DIS源端项目id	否	DIS源端项目ID，当setting_type为senior时填写。
  HL7数据源方向	否	HL7数据源方向：- source (源端)，- target (目标端)。
  HL7是否开启白名单设置	否	HL7是否开启白名单设置。
  HL7白名单	否	HL7白名单，允许同步数据到源端HL7的服务器地址，当HL7为源端（position为source）并且开启白名单设置(open_whitelist为true)时填写。
  LDAP安全认证类型	否	LDAP安全认证类型。
  RABBITMQ虚拟主机	否	RABBITMQ虚拟主机。
  RABBITMQ SSL认证协议	否	RABBITMQ SSL认证协议：TLS。
  SAP客户端号	否	SAP客户端号。
  SAP实例编号	否	SAP实例编号。
  SNMP网络协议	否	SNMP网络协议：- udp，- tcp。
  SNMP团体名	否	SNMP团体名，用于访问SNMP管理代理的身份认证，相当于访问密码。
  IBMMQ字符集标识	否	IBMMQ字符集标识。
  IBMMQ队列管理器	否	IBMMQ队列管理器。
  IBMMQ通道名称	否	IBMMQ通道名称。
  IBMMQ密钥算法套件	否	IBMMQ密钥算法套件。
  HDFS URL	否	HDFS URL：- 数据源为MRSHIVE、MRSHDFS、FIHDFS、FIHIVE类型时配置 - fihadfs (/fdi/autotest)。
  机机交互用户名	否	机机交互用户名 ：数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、FIHDFS、FIHIVE、FIKAFKA类型时配置。
  用户认证文件	否	用户认证文件，文件获取方式参考《ROMA Connect API参考》的“附录>获取数据源配置文件”章节。 - 将获取到的文件打包成zip文件，文件名配置在config_file_name中，内容以BASE64编码形式放到config_file_content； - 数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、FIHDFS、FIHIVE、FIKAFKA类型时配置。
  用户认证文件内容	否	- 用户认证文件内容，config_file_name对应的文件内容BASE64编码 ； - 数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、FIHDFS、FIHIVE、FIKAFKA类型时配置。
  连接器实例ID	否	连接器实例ID，连接器发布后对应的实例ID。
  连接器对应的数据源参数	否	连接器对应的数据源参数，值按实际填写。
  数据源描述	否	数据源描述。
  ORACLE集群地址	否	ORACLE集群地址，当mode为multiAddress时需要配置。
  oracle_address	否	ORACLE地址。
  oracle_port	否	ORACLE端口。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表23。

  表23 测试数据源连通性输出参数说明

  参数	说明
  返回结果	返回结果 - true (成功)。

查询指定数据源

根据数据源ID查询数据源。

• 输入参数

  用户配置查询指定数据源执行动作，相关参数说明如表24所示。

  表24 查询指定数据源输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  数据源ID	是	数据源ID。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表25。

  表25 查询指定数据源输出参数说明

  参数	说明
  数据源ID	数据源ID。
  数据源名称	数据源名称。
  数据源类型	数据源类型。
  数据源所属虚拟私有云VpcId	数据源所属虚拟私有云VpcId。
  数据源所属应用ID	数据源所属应用ID。
  数据源所属应用名称	数据源所属应用名称。
  数据源所属实例Id	数据源所属实例ID。
  数据源创建时间	数据源创建时间。
  数据源修改时间	数据源修改时间。
  数据源所属连接器Id	数据源所属连接器ID。
  gauss100的版本号	gauss100的版本号：- V100R003C20，- V300R001C00。
  主机IP地址	主机IP地址。 - 数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ类型时需要配置； - 数据源为MYSQL、ORACLE、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ARTEMISMQ、POSTGRESQL/OPENGAUSS、HIVE类型且mode为default时需要配置； - 数据源为HL7类型且作为目标端（position为target）时需要配置； - 初始值为空，配置任务启动后生成host。
  端口	端口，端口号为0到65535。 - 数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ，obs类型时需要配置； - 数据源为MYSQL、ORACLE、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ARTEMISMQ、POSTGRESQL/OPENGAUSS、HIVE类型且mode为default时需要配置； - 数据源为HL7类型且作为目标端（position为target）时需要配置。
  数据库名称	数据库名称。 - 数据源为DWS、HANA、RABBITMQ、SAP、SNMP、IBMMQ，obs类型时需要配置； - 数据源为MYSQL、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ARTEMISMQ、POSTGRESQL/OPENGAUSS、HIVE类型且mode为default时需要配置； - 数据源为ORACLE类型且mode为（default、multiAddress）时需要配置。
  REDIS数据源类型配置	REDIS数据源类型配置，数据库编号，纯数字编码。
  访问服务的用户名	访问服务的用户名： - 数据源为MYSQL、DWS、FTP、ORACLE、MONGODB、HANA、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ACTIVEMQ、ARTEMISMQ、POSTGRESQL/OPENGAUSS、RABBITMQ、SAP、IBMMQ、HIVE类型时需要配置； - 数据源为WEBSOCKET类型，认证方式（basicauth）时需要配置； - 数据源为LDAP，安全认证类型（security_auth_type）为simple时需要配置。
  访问服务的密码	访问服务的密码： - 数据源为MYSQL、DWS、FTP、ORACLE、MONGODB、HANA、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、ACTIVEMQ、ARTEMISMQ、POSTGRESQL/OPENGAUSS、RABBITMQ、SAP、IBMMQ、HIVE类型时需要配置 ； - 数据源为WEBSOCKET，且认证方式（basicauth）时需要配置 ； - 数据源为LDAP，且安全认证类型（security_auth_type）为simple时需要配置。
  数据源连接模式	数据源连接模式： - 数据源为DWS、MONGODB、REDIS、HANA时配置默认； - 数据源为MYSQL、SQLSERVER、DB2、GAUSS100、GaussDB(for MySQL)、POSTGRESQL/OPENGAUSS、HIVE时配置（default,professional）； - 数据源为ORACLE时配置专有的模式multiAddress；- default (默认模式) - professional (专业模式) - multiAddress (多地址)。
  cdc模式	cdc模式，只有组合任务使用。
  ORACLE集群地址	ORACLE集群地址，当mode为multiAddress时需要配置。
  oracle_address	ORACLE地址。
  oracle_port	ORACLE端口。
  ORACLE集群服务名	ORACLE集群服务名。
  访问FTP服务的连接模式	访问FTP服务的连接模式：- active (主动模式) ，- passive (被动模式)。
  访问FTP服务协议类型	访问FTP服务协议类型：- sftp，- ftp。 说明： FTP协议本身存在安全风险，建议您使用SFTP安全协议。
  地址	地址： - OBS (obs远端地址，obs数据源使用) - MONGODB (MONGODB数据源类型主机IP地址，多个IP:PORT, 使用","隔开) - REDIS (redis服务地址，多个IP:PORT, 使用","隔开)
  Access Key ID	Access Key ID，数据源为OBS，DIS类型时需要配置。
  Secret Access Key	Secret Access Key，数据源为OBS，DIS类型时需要配置。
  桶名称	桶名称，数据源为OBS时需要配置。
  是否使用https	是否使用https，数据源为OBS时需要配置，一般默认使用。
  连接字符串	连接字符串，访问url ： - 数据源为API、LDAP、WEBSOCKE类型时需要配置； - 数据源为MYSQL、ORACLE、DB2、GAUSS100、GaussDB(for MySQL)、POSTGRESQL，且mode配置为professional专业时需要配置
  访问API请求方式	访问API请求方式：- POST - PUT - DELETE - PATCH - GET。
  访问WEBSOCKET服务的认证方式	访问WEBSOCKET服务的认证方式：- none，- basicauth。
  访问API服务的认证方式	访问API服务的认证方式：- none - basicauth - oauth2.0 - hmac - secret -md5 - apiGateway - keyTop - hikVision - huaweiNetworkManagement -liHe。
  访问API服务的APP认证方式	访问API服务的APP认证方式，认证方式为（apiGateway）时填写：- default - secret - jwt。
  访问API服务的用户名	访问API服务的用户名，认证方式为（lihe、huaweiNetworkManagement、basicauth）时填写。
  访问API服务的密码	访问API服务的密码，认证方式为（lihe、huaweiNetworkManagement、basicauth、secret、md5、hmac）时填写。
  访问API服务的AppKey	访问API服务的AppKey，认证方式为（apiGateway、oauth2.0）时填写。
  访问API服务的AppSecret	访问API服务的AppSecret，认证方式为（apiGateway、oauth2.0）时填写。
  访问API服务的Secret	访问API服务的Secret， 认证方式为（KeyTop、HikVision、Secret、HMAC、MD5）时填写。
  访问API服务的备用IP	访问API服务的备用IP，认证方式为（HuaweiNetworkManagement）时填写。
  访问API服务的AccessTokenUrl	访问API服务的AccessTokenUrl，认证方式为（liHe、oauth2.0 huaweiNetworkManagement）时填写。
  访问API服务的Scope	访问API服务的Scope，认证方式为（LiHe、Oauth2）时填写。
  访问API服务的Authorization	访问API服务的Authorization，认证方式为（LiHe）时填写。
  访问API服务的授权类型	访问API服务的授权类型，认证方式为（LiHe、Oauth2）时填写，- client_credentials （oauth2.0使用）。
  KAFKA、ACTIVEMQ的服务器地址	KAFKA、ACTIVEMQ的服务器地址，多个IP:PORT, 使用","分隔。
  是否开启SSL认证	是否开启SSL认证： - 数据源为KAFKA时需要配置，连接MQS内网地址时，如果MQS同时开启了SSL与VPC内网明文访问，请选择“否”； - 数据源为ARTEMISMQ、ACTIVEMQ、RABBITMQ、IBMMQ时需要配置； - 数据源为HL7时且作为源端时需要配置。
  SSL用户名/应用Key	SSL用户名/应用Key，数据源为KAFKA且开启SSL认证时需要配置。
  SSL密码/应用Secret	SSL密码/应用Secret，数据源为KAFKA且开启SSL认证时需要配置。
  MONGODB认证源	MONGODB认证源。
  MONGODB集群模式	MONGODB集群模式：- true (集群模式)，- false （非集群模式）。
  MONGODB副本集	MONGODB副本集，当MONGODB为非集群模式时配置。
  编码格式	编码格式： - 数据源为GAUSS100、POSTGRESQL类型时配置"big5"； - 数据源为MYSQL、GaussDB(for MySQL)类型且mode为default时配置。
  MYSQL连接超时时间	MYSQL连接超时时间（秒）。
  公钥库密码	公钥库密码： - 数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置 ； - 数据源类为HL7且HL7为目标端（position为target）时，并且开启SSL认证时需要配置。
  数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置	- 数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置，公钥库密码 ； - 数据源类型为HL7且为目标端（position为target），并且开启SSL认证时需要配置，公钥库密码。
  数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置	-数据源类型为ACTIVEMQ、ARTEMISMQ、RABBITMQ、IBMMQ且开启SSL认证时需要配置，公钥库密码 ； - 数据源类型为HL7且为目标端（position为target），并且开启SSL认证时需要配置，公钥库密码。
  数据源类型为ACTIVEMQ、ARTEMISMQ且开启SSL认证时需要配置	数据源类型为ACTIVEMQ、ARTEMISMQ且开启SSL认证时需要配置 ：- one-way (单向认证)，- two-way (双向认证)。
  私钥库文件内容	私钥库文件内容： - 数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置； - 数据源类型HL7且为源端（position为source），并且开启SSL认证时需要配置。
  私钥库文件类型	私钥库文件类型，数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置。
  私钥库密码	私钥库密码： - 数据源类型为ACTIVEMQ、ARTEMISMQ，开启SSL认证并且认证方式是two-way时需要配置； - 数据源为HL7类型，为源端（position为source）并且开启SSL认证时需要配置。
  DIS通道名称	DIS通道名称。
  DIS数据类别	DIS数据类别，JSON。
  DIS配置类别	DIS配置类别：- senior (高级)，- basic (基础)。
  DIS Endpoint	DIS Endpoint，当setting_type为senior时填写。
  DIS Region	DIS Region，当setting_type为senior时填写。
  DIS源端项目id	DIS源端项目ID，当setting_type为senior时填写。
  HL7数据源方向	HL7数据源方向：- source (源端)，- target (目标端)。
  HL7是否开启白名单设置	HL7是否开启白名单设置。
  HL7白名单	HL7白名单，允许同步数据到源端HL7的服务器地址，当HL7为源端（position为source）并且开启白名单设置(open_whitelist为true)时填写。
  LDAP安全认证类型	LDAP安全认证类型。
  RABBITMQ虚拟主机	RABBITMQ虚拟主机。
  RABBITMQ SSL认证协议	RABBITMQ SSL认证协议：- TLS。
  SAP客户端号	SAP客户端号。
  SAP实例编号	SAP实例编号。
  SNMP网络协议	SNMP网络协议：- udp，- tcp。
  SNMP版本号	SNMP版本号。
  SNMP团体名	SNMP团体名，用于访问SNMP管理代理的身份认证，相当于访问密码。
  IBMMQ字符集标识	IBMMQ字符集标识。
  IBMMQ队列管理器	IBMMQ队列管理器。
  IBMMQ通道名称	IBMMQ通道名称。
  IBMMQ密钥算法套件	IBMMQ密钥算法套件。
  HDFS URL	HDFS URL：- 数据源为MRSHIVE、MRSHDFS、FIHDFS、FIHIVE类型时配置 - fihadfs (/fdi/autotest)。
  机机交互用户名	机机交互用户名：数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、FIHDFS、FIHIVE、FIKAFKA类型时配置。
  用户认证文件	用户认证文件，文件获取方式参考《ROMA Connect API参考》的“附录>获取数据源配置文件”章节。 - 将获取到的文件打包成zip文件，文件名配置在config_file_name中，内容以BASE64编码形式放到config_file_content； - 数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、FIHDFS、FIHIVE、FIKAFKA类型时配置。
  用户认证文件内容	- 用户认证文件内容，config_file_name对应的文件内容BASE64编码 ； - 数据源为MRSHIVE、MRSHDFS、MRSHBASE、MRSKAFKA、FIHDFS、FIHIVE、FIKAFKA类型时配置。
  连接器实例ID	连接器实例ID，连接器发布后对应的实例ID。
  连接器对应的数据源参数	连接器对应的数据源参数，值按实际填写。
  数据源描述	数据源描述。
  集成应用权限信息	集成应用权限信息：- read (读权限) - access (调用权限) - delete (删除权限) - modify (修改权限)。

任务监控信息列表查询

任务监控信息列表查询。

• 输入参数

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

更新普通任务

更新普通任务。

• 输入参数

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

查询调度计划

查询调度计划。

• 输入参数

  用户配置查询调度计划执行动作，相关参数说明如表30所示。

  表30 查询调度计划输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  任务ID	是	任务ID。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表31。

  表31 查询调度计划输出参数说明

  参数	说明
  调度计划ID	调度计划ID。
  调度计划关联的任务ID	调度计划关联的任务ID。
  调度计划的执行开始时间	调度计划的执行开始时间。
  调度计划执行周期的时间单位	调度计划执行周期的时间单位，当使用cron表达式时为空。- MIN (分钟) - HOUR (小时) - DAY (日) - WEEK (周) - MON (月)。
  调度计划的执行间隔时间周期	调度计划的执行间隔时间周期。
  调度计划的创建时间	调度计划的创建时间。
  调度计划最近一次的修改时间	调度计划最近一次的修改时间。
  调度计划的备注信息	调度计划的备注信息。
  调度计划是否使用cron表达式	调度计划是否使用cron表达式，允许如下值：- true (使用cron表达式)，- false (不使用cron表达式)。

手工停止当前任务

手工停止当前任务。

• 输入参数

  用户配置手工停止当前任务执行动作，相关参数说明如表32所示。

  表32 手工停止当前任务输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  任务ID	是	任务ID。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表33。

  表33 手工停止当前任务输出参数说明

  参数	说明
  返回消息	手工启动/停止任务成功返回消息。

获取数据源中所有表

获取数据源中所有的表。

• 输入参数

  用户配置获取数据源中所有的表执行动作，相关参数说明如表34所示。

  表34 获取数据源中所有的表输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  数据源ID	是	数据源ID。
  数据源所在任务位置	是	数据源所在任务位置： - SOURCE：数据源处于任务源端； - TARGET：数据源处于任务目标端。

• 输出参数

  用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表35。

  表35 获取数据源中所有的表输出参数说明

  参数	说明
  数据源中所有的表名称	数据源中所有的表名称。

通过数据源Id删除指定数据源信息

通过数据源ID删除指定数据源信息。

• 输入参数

  用户配置通过数据源ID删除指定数据源信息执行动作，相关参数说明如表36所示。

  表36 通过数据源ID删除指定数据源信息输入参数说明

  参数	必填	说明
  实例ID	是	实例ID。
  数据源ID	是	数据源ID。

• 输出参数

  该执行动作无输出参数。