华为云用户手册

9：x-apigateway-ratelimits 含义：流控策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit: 200 user-limit: 200 ip-limit: 200 interval: 1 unit: second/minute/hour shared: true special: - type: APP limit: 100 instance: xxxxxxxxx

9.2：x-apigateway-ratelimits.policy.special 含义：特殊流控策略定义。 作用域：x-apigateway-ratelimits.policy 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit: 200 user-limit: 200 ip-limit: 200 interval: 1 unit: MINUTE shared: false special: - type: USER limit: 100 instance: xxxxxxxx 表16 参数说明 参数 是否必选 类型 说明 type 是 String 特殊流控策略类型，支持“APP”和“USER”。 limit 是 Number 访问次数限制。 instance 是 String 特殊APP或USER的对象标识。

9.1：x-apigateway-ratelimits.policy 含义：流控策略定义。 作用域：x-apigateway-ratelimits 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit: 200 user-limit: 200 ip-limit: 200 interval: 1 unit: MINUTE shared: false special: - type: USER limit: 100 instance: xxxxxxx

10：x-apigateway-access-control 含义：ROMA Connect引用的访问控制策略。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-access-control: 'customAccessControlName' 表17 参数说明 参数 是否必选 类型 说明 x-apigateway-access-control 否 String 引用的访问控制策略名称，设置为“customAccessControlName”。

11.1：x-apigateway-access-controls.policy 含义：访问控制策略定义。 作用域：x-apigateway-access-controls 示例： x-apigateway-access-controls: customAccessControlName: acl-type: "DENY" entity-type: "IP" value: 127.0.0.1,192.168.0.1/16 表19 参数说明 参数 是否必选 类型 说明 acl-type 是 String 访问控制行为，支持“PERMIT”和“DENY”。 entity-type 是 String 访问控制对象，仅支持“IP”。 value 是 String 访问控制策略值，多个值之间以英文逗号（,）隔开。

11：x-apigateway-access-controls 含义：访问控制策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-access-controls: customAccessControlName: acl-type: "DENY" entity-type: "IP" value: 127.0.0.1,192.168.0.1/16

12：x-apigateway-roma-app 含义：API绑定的集成应用。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-roma-app: 'romaAppName' 表20 参数说明 参数 是否必选 类型 说明 x-apigateway-roma-app 是 String API所绑定的集成应用名称。

13 x-apigateway-plugins 含义：API网关定义的API插件服务。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-plugins: ['Plugin_mock'] 表21 参数说明 参数 是否必选 类型 说明 x-apigateway-plugins 否 Array API所绑定的插件名列表。

14 x-apigateway-is-send-fg-body-base64 含义：是否对与FunctionGraph交互场景的请求体进行Base64编码，boolean类型。 作用域：Operation Object 示例： paths: '/path': get: "x-apigateway-is-send-fg-body-base64": true 表22 参数说明 参数 是否必选 类型 说明 x-apigateway-is-send-fg-body-base64 否 boolean 是否对与FunctionGraph交互场景的请求体进行Base64编码。 true：编码 false：不编码

7：x-apigateway-backend-policies 含义：ROMA Connect定义的API后端策略。 作用域：Operation Object 示例： paths: '/users/{userId}': get: produces: - "application/json" responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "backend endpoint type" x-apigateway-backend-policies: - type: "backend endpoint type" name: "backend policy name" conditions: - type: "equal/enum/pattern", value: "string", origin: "source/request_parameter", parameter_name: "string" 表11 参数说明 参数 是否必选 类型 说明 type 是 String 后端服务类型，支持“HTTP”、“HTTP-VPC”和“MOCK”。 name 是 String 后端策略名称。 parameters 否 x-apigateway-backend.parameters 后端参数定义。 httpEndpoints 否 x-apigateway-backend.httpEndpoints HTTP类型服务定义。 httpVpcEndpoints 否 x-apigateway-backend.httpVpcEndpoints HTTP-VPC类型服务定义。 functionEndpoints 否 x-apigateway-backend.functionEndpoints FUNCTION类型服务定义。 mockEndpoints 否 x-apigateway-backend.mockEndpoints MOCK类型服务定义。 conditions 是 x-apigateway-backend-policies.conditions 后端策略条件。

5：x-apigateway-any-method 含义：ROMA Connect定义的API请求方法，用以匹配未指定定义的HTTP方法。 作用域：Path Item Object 示例： paths: '/path': get: produces: - application/json responses: "200": description: "get response" x-apigateway-any-method: produces: - application/json responses: "200": description: "any response"

6.2：x-apigateway-backend.httpEndpoints 含义：ROMA Connect定义的HTTP类型后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "HTTP" httpEndpoints: address: "www.example.com" scheme: "http" method: "GET" path: "/users" retryCount: "3" timeout: 30000

6.5：x-apigateway-backend.mockEndpoints 含义：ROMA Connect定义的MOCK类型后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "MOCK" mockEndpoints: result-content: "mocked"

2：x-apigateway-request-type 含义：ROMA Connect定义的API类型，支持public和private。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-request-type: 'public' 表2 参数说明 参数 是否必选 类型 说明 x-apigateway-request-type 是 String API类型，支持“public”和“private”。 public：公开类型API，可以上架云市场。 private：私有类型API，不会被上架云市场。

6.1：x-apigateway-backend.parameters 含义：ROMA Connect定义的API后端参数定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true - name: "userId" description: "user name" type: "string" in: "path" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "HTTP" parameters: - name: "userId" value: "userId" in: "query" origin: "REQUEST" description: "user name" - name: "X-Invoke-User" value: "apigateway" in: "header" origin: "CONSTANT" description: "invoke user"

8：x-apigateway-ratelimit 含义：ROMA Connect引用的流控策略。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-ratelimit: 'customRatelimitName' 表13 参数说明 参数 是否必选 类型 说明 x-apigateway-ratelimit 否 String 引用的流控策略名称，设置为“customRatelimitName”。

3：x-apigateway-match-mode 含义：ROMA Connect定义的API请求路径的匹配模式，支持NORMAL和SWA。 作用域：Operation Object 示例： paths: '/path': get: x-apigateway-match-mode: 'SWA' 表3 参数说明 参数 是否必选 类型 说明 x-apigateway-match-mode 是 String API请求路径的匹配模式，支持“SWA”和“NORMAL”。 SWA：前缀匹配，例如API的请求路径为“/test/AA”，使用前缀匹配时，通过/test/AA/BB和/test/AA/CC都可以访问API，但是通过/test/AACC无法访问。 NORMAL：绝对匹配。

6：x-apigateway-backend 含义：ROMA Connect定义的API后端服务定义。 作用域：Operation Object 示例： paths: '/users/{userId}': get: produces: - "application/json" responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "backend endpoint type"

6.4：x-apigateway-backend.functionEndpoints 含义：ROMA Connect定义的FUNCTION类型后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "FUNCTION" functionEndpoints: version: "v1" function-urn: "" invocation-type: "synchronous" timeout: 30000 表9 参数说明 参数 是否必选 类型 说明 function-urn 是 String 函数的URN地址。 version 是 String 函数的版本。 invocation-type 是 String 函数的调用类型，支持“async”和“sync”。 timeout 否 Number 函数超时时间，单位毫秒，缺省值为5000，取值范围为1-60000。

6.3：x-apigateway-backend.httpVpcEndpoints 含义：ROMA Connect定义的HTTP VPC类型后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces: - "application/json" parameters: - name: "X-Auth-Token" description: "authorization token" type: "string" in: "header" required: true responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "HTTP-VPC" httpVpcEndpoints: name: "vpc-test-1" scheme: "http" method: "GET" path: "/users" timeout: 30000

7.1：x-apigateway-backend-policies.conditions 含义：ROMA Connect定义的API后端策略条件。 作用域：x-apigateway-backend-policies 示例： paths: '/users/{userId}': get: produces: - "application/json" responses: default: description: "default response" x-apigateway-request-type: "public" x-apigateway-backend: type: "backend endpoint type" x-apigateway-backend-policies: - type: "backend endpoint type" name: "backend policy name" conditions: - type: "equal/enum/pattern", value: "string", origin: "source/request_parameter", parameter_name: "string" 表12 参数说明 参数 是否必选 类型 说明 type 是 String 策略条件类型，支持“equal”、“enum”和“pattern”。 value 是 String 策略条件值。 origin 是 String 策略条件输入来源，支持“source”和“request”。 parameter 否 String 策略条件输入来源为“request”时，请求入参的名称。

1：x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义ROMA Connect支持的特有认证方式。 作用域：Security Scheme Object 示例： securityDefinitions: customize-name-iam: type: "apiKey" name: "unused" in: "header" x-apigateway-auth-type: " IAM " customize-name-app: type: "apiKey" name: "Authorization" in: "header" x-apigateway-auth-type: "AppSigv1" customize-name-iam-none: type: "apiKey" name: "unused" in: "header" x-apigateway-auth-type: "IAM_NONE"

配置示例 以下示例将帮助您更好地理解QuartZ Cron表达式的含义。简单示例展示了QuartZ Cron表达式的初级使用方法，常用示例则展示了QuartZ Cron表达式在实际场景中常见的使用方法，您只需根据实际需求对常用示例进行微调即可直接使用。 简单示例： 0 0/1 * * * ? //每隔一分钟执行一次0 0 23 * * ? //每天23点执行一次0 0 1 1 * ? //每月一号凌晨1点执行一次0 0 23 L * ? //每月最后一天23点执行一次0 33,55 * * * ? //在33分，55分执行一次0 0 18 * * LW //每月最后一个工作日晚上六点执行一次

注意事项 每一个参数都使用数字，但还可以出现如下特殊字符。 *：表示匹配该域的任意值。假如在“分”使用“*”，即表示每分钟都会触发事件。 ?：只能用在“日（每月中的一天）”和“周”两个参数中。它也匹配参数的任意值，但实际不会。因为“日（每月中的一天）”和“周”会相互影响。例如想在每月的20日触发调度，不管20日是星期几，则只能使用如下写法： 13 13 15 20 * ?，其中最后一位只能用“?”，而不能使用“*”，如果使用“*”表示不管星期几都会触发，实际上并不是这样。 -：表示范围。例如在“分”使用“5-20”，表示从5分到20分钟每分钟触发一次。 /：表示起始时间开始触发，然后每隔固定时间触发一次。例如在“分”使用“5/20”，则表示每小时的第5、25、45分钟分别触发定时任务。 ,：表示列表值。例如：在“分”使用“5,20”，则表示在每小时的第5分和20分触发一次定时任务。 L：表示最后，只能出现在“日（每月中的一天）”和“周”参数中。如果在“周”域使用“5L”表示在最后的一个星期四触发。 W：表示有效工作日(周一到周五)，只能出现在“日（每月中的一天）”参数中，系统将在离指定日期的最近的有效工作日触发事件。例如：在 “日（每月中的一天）”使用“5W”，如果5日是星期六，则将在最近的工作日：星期五，即4日触发。如果5日是星期天，则在6日(周一)触发；如果5日在星期一到星期五中的一天，则就在5日触发。W的最近寻找不会跨过月份 。 LW：这两个字符可以连用，表示在某个月最后一个工作日，即最后一个星期五。 #：用于确定每个月第几个星期几，只能出现在“日（每月中的一天）”域。例如在4#2，表示某月的第二个星期三。 定时任务配置QuartZ Cron表达式时，还需要注意以下内容： QuartZ Cron表达式采用UTC+0时区，在配置QuartZ Cron表达式时，您需要把本地时间换算成在UTC+0时区的时间。例如，中国的时区是UTC+8，如果您计划在中国时区（例如每天20：00）执行任务，需要将计划执行时间减去8小时，设置的QuartZ Cron表达式应为0 12 * * ？

参数说明 数据集成任务支持使用QuartZ Cron表达式配置定时任务的调度计划。 QuartZ Cron表达式由6个部分组成，每个部分使用空格隔开。表达式中的六个部分从左到右代表的含义如下： 秒 分 时 日 月 周 具体参数如表1所示。 表1 QuartZ Cron参数说明 名称 是否必填 可选数值 可选特殊符号 秒 否，该配置项暂不支持 固定为0。 - 分 是 数字0-59。 , - * / 时 是 数字0-23。 , - * / 日 是 每月中的一天，数字1-31。注意2月没有30日和31日，4月、6月、9月、11月没有31日。 , - * ? / L W 月 是 数字1-12，或字符串。数字与字符串的对应关系请参见表2。 假如您想在月参数中填写1月，数字“1”或字符串“JAN”都符合QuartZ Cron表达式的约定。 , - * / 周 是 数字1-7，或字符串。数字与字符串的对应关系请参见表3，QuartZ Cron表达式约定周六为每周的最后一天。 假如您想在周参数中填写周一，数字“2”或字符串“MON”都符合QuartZ Cron表达式的约定。 , - * ? / L # 表2 月参数的数字与字符串对应关系 数字 字符串 1 JAN 2 FEB 3 MAR 4 APR 5 MAY 6 JUN 7 JUL 8 AUG 9 SEP 10 OCT 11 NOV 12 DEC 表3 每周数字与字符串对应表 数字 字符串 含义 1 SUN 周日 2 MON 周一 3 TUE 周二 4 WED 周三 5 THU 周四 6 FRI 周五 7 SAT 周六

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“ArtemisMQ”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 连接地址 填写ArtemisMQ的连接IP地址和端口号。 用户名 填写连接ArtemisMQ的用户名。 密码 填写连接ArtemisMQ的用户密码。 是否开启SSL认证 ROMA Connect与ArtemisMQ的连接是否使用SSL认证加密。 SSL认证方式 仅当“是否开启SSL认证”选择“是”时需要配置。 选择使用的SSL认证方式。 单向认证：仅客户端（ROMA Connect）对服务端（ArtemisMQ）进行身份认证。 双向认证：客户端（ROMA Connect）和服务端（ArtemisMQ）相互进行身份认证。 公钥库文件 仅当“是否开启SSL认证”选择“是”时需要配置。 SSL认证过程中，客户端使用的公钥库文件，与服务端使用的私钥相匹配。 公钥库密码 仅当“是否开启SSL认证”选择“是”时需要配置。 公钥库文件对应的密码。 私钥库文件 仅当“SSL认证方式”选择“双向认证”时需要配置。 SSL双向认证过程中，客户端使用的私钥库文件，与服务端使用的公钥相匹配。 私钥库密码 仅当“SSL认证方式”选择“双向认证”时需要配置。 私钥库文件对应的密码。 私钥库私钥密码 仅当“SSL认证方式”选择“双向认证”时需要配置。 私钥库文件中私钥对应的密码。若不填写，则私钥密码跟“私钥库密码”相同。 ArtemisMQ数据源的接入配置与ActiveMQ类似，配置示例可参考图1。 完成数据源接入配置后，单击“开始检测”，检测ROMA Connect与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。

前提条件 已完成源端数据源和目标端数据源的接入，具体操作请参考接入数据源。 在源端数据源接入配置中，“数据库名”的大小写应与实际数据库名保持一致，否则会导致数据同步失败。 源端数据源已开启CDC功能，根据不同的数据源类型和CDC实现模式，具体操作请参考： 配置Oracle CDC（LogMiner）（推荐使用） 配置Oracle CDC（XStream） 配置MySQL CDC（Binlog） 配置SQL Server CDC 源端数据源中CDC归档日志的保留时间需要大于集成任务解析的日志时间，否则会造成集成任务找不到归档日志而导致增量同步失败。因此，数据集成任务停止运行的时间不宜过长。建议最少保留2天以上的归档日志。 在首次执行数据同步期间，建议不要对源端数据库做DDL操作。 如果创建组合任务个数过多，对数据库服务器、FDI插件进程均会产生资源消耗，所以建议对一个数据库，不要创建过多组合任务。 FDI支持单个CDC任务中配置多个Schema下的多个数据库表，实现统一的全量或增量采集能力。 组合任务在运行过程中支持添加表，选择重启后可对新表执行全量采集或者增量采集。 源端Oracle数据源： 大文本类型和二进制类型的字段不支持同步。 表名为小写的数据表不支持同步。 无主键的数据表不支持同步。 如果表中数据较少，建议通过每天采集一次全量数据的方式进行采集，目前PostgreSQL类型表支持写入前清空数据。对于从Oracle数据库采集数据，但表中没有主键的情况，可以利用Oracle内部的RowId作为主键，RowId一般是使用数字、字母生成18位长度的字符串。 名称为数据库自身保留字的数据表或数据字段不支持同步。 truncate方式删除的数据不支持同步，整表方式删除的数据不支持同步。 源端MySQL数据源： 如果MySQL数据库使用的是MGR集群模式，在接入源端数据源时，必须直接连接主节点，不能连接route节点。 如果MySQL数据库中数据量特别巨大，在首次执行数据同步时可能会连接数据库超时，可以通过修改MySQL数据库的超时参数interactive_timeout和wait_timeout来规避。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“自定义数据源”页签下，选择要作为自定义数据源的连接器，然后单击“下一步”。 在页面中配置数据源的连接信息。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 连接器实例 选择该连接器下已发布的连接器实例。 其他配置参数 后续的其他配置参数，是基于您在创建连接器时所定义的数据源信息而定。 您可以在ROMA Connect控制台的“资产管理”页面中，在“连接器”页签下单击连接器名称，查看连接器的“数据源定义”信息。 以接入一个读取邮件数据的自定义数据源为例，该自定义数据源的接入配置示例如下图所示。 其中，email server、protocol、user和password参数为连接器中定义的数据源参数。 图1 自定义数据源配置示例 完成数据源接入配置后，单击“创建”，完成数据源的接入。

概述 产品即设备模型，是同一类设备的服务属性集合。每个设备都有一个归属的产品，设备会继承产品的所有服务属性。 产品信息包含产品基本信息、物模型等信息，用于描述产品是什么，能做什么，可以对外提供哪些服务等。 基本信息 描述一款设备的基本信息，包括厂商名称、厂商ID、产品类型、产品型号、协议类型、设备类型等，其中产品型号和厂商ID共同标识一款产品。 例如，水表的产品型号为“NBIoTDevice”，厂商名称为“HZYB”，厂商ID为“TestUtf8ManuId”，设备类型为“WaterMeter”。 物模型 定义设备所具备的业务能力。将设备业务能力拆分成若干个物模型服务后，再定义每个物模型服务具备的属性、命令以及命令的参数。 以水表为例，水表具有多种能力，如上报水流、告警、电量、连接等各种数据，并且能够接受服务器下发的各种命令。在描述水表的能力时，可以将水表的能力划分五个物模型服务，每个物模型服务都需要定义各自的上报属性或命令，如下表所示。 表1 服务说明 物模型服务名 描述 基础（WaterMeterBasic） 用于定义水表上报的水流量、水温、水压等参数，如果需要命令控制或修改这些参数，还需要定义命令的参数。 告警（WaterMeterAlarm） 用于定义水表需要上报的各种告警场景的数据，必要的话需要定义命令。 电池（Battery） 定义水表的电压、电流强度等数据。 传输规则（DeliverySchedule） 定义水表的一些传输规则，必要的话需要定义命令。 连接（Connectivity） 定义水表连接参数。 具体定义多少个物模型服务可以非常灵活，如上面的例子可以将告警物模型服务拆分成水压告警物模型服务和流量告警物模型服务，也可以将告警物模型服务合入到水表基础物模型服务中。

操作步骤 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。 在接入数据源页面的“默认数据源”页签下，选择“SAP”类型的数据源，然后单击“下一步”。 在页面中配置数据源的连接信息。 表2 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。 编码格式 默认“utf-8”格式。 集成应用 选择数据源所归属的集成应用。 描述 填写数据源的描述信息。 主机IP地址 填写SAP系统的应用服务器地址。 实例编号 填写SAP系统的应用服务器实例号，实例号由2位字母或数字组成。 客户编号 填写SAP系统中要连接的客户端号，客户端号由3位数字组成。 用户名 填写连接SAP客户端的用户名。 密码 填写连接SAP客户端的用户密码。 SAP数据源的接入配置示例如下图所示。 图1 SAP数据源配置示例 完成数据源接入配置后，单击“开始检测”，检测ROMA Connect与数据源之间是否能够连通。 若测试结果为“数据源连接成功！”，则继续下一步。 若测试结果为“数据源连接失败！”，则检查数据源状态和数据源连接参数配置，然后单击“重新检测”，直到连接成功为止。 单击“创建”，完成数据源的接入。