api 参考在调用roma...

应用与数据集成平台

API 参考

文档版本 06

发布日期 2021-01-04

华为技术有限公司

版权所有 © 华为技术有限公司 2021。保留一切权利。

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。商标声明

和其他华为商标均为华为技术有限公司的商标。本文档提及的其他所有商标或注册商标，由各自的所有人拥有。注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或默示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 i

目录

1 使用前必读.................................................................................................................................. 11.1 概述.............................................................................................................................................................................................. 11.2 调用说明......................................................................................................................................................................................11.3 终端节点......................................................................................................................................................................................11.4 约束与限制................................................................................................................................................................................. 21.5 基本概念......................................................................................................................................................................................2

2 API 概览...................................................................................................................................... 4

3 如何调用 API...............................................................................................................................73.1 构造请求......................................................................................................................................................................................73.2 认证鉴权................................................................................................................................................................................... 103.3 返回结果................................................................................................................................................................................... 12

4 公共资源 API............................................................................................................................ 144.1 应用管理................................................................................................................................................................................... 144.1.1 校验应用是否存在.............................................................................................................................................................. 144.1.2 查询应用列表....................................................................................................................................................................... 184.1.3 创建应用................................................................................................................................................................................ 234.1.4 查询应用详情....................................................................................................................................................................... 274.1.5 更新应用................................................................................................................................................................................ 314.1.6 删除应用................................................................................................................................................................................ 354.1.7 查询应用密钥....................................................................................................................................................................... 374.1.8 重置应用密钥....................................................................................................................................................................... 404.1.9 查询用户成员列表.............................................................................................................................................................. 434.1.10 设置用户成员.....................................................................................................................................................................464.1.11 查询候选用户成员............................................................................................................................................................ 494.2 资产管理................................................................................................................................................................................... 524.2.1 下载资产包........................................................................................................................................................................... 524.2.2 批量导出资产....................................................................................................................................................................... 554.2.3 导入资产................................................................................................................................................................................ 584.2.4 查询作业进度....................................................................................................................................................................... 604.3 字典管理................................................................................................................................................................................... 644.3.1 校验字典是否存在.............................................................................................................................................................. 644.3.2 查询字典列表....................................................................................................................................................................... 67

应用与数据集成平台API 参考目录

文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 ii

4.3.3 创建字典................................................................................................................................................................................ 724.3.4 查询字典详情....................................................................................................................................................................... 764.3.5 更新字典................................................................................................................................................................................ 794.3.6 删除字典................................................................................................................................................................................ 834.4 公共管理................................................................................................................................................................................... 854.4.1 获取服务 API 版本列表......................................................................................................................................................854.4.2 获取指定版本 ID 的 API 版本信息.................................................................................................................................. 87

5 数据集成 API............................................................................................................................ 905.1 数据源管理............................................................................................................................................................................... 905.1.1 创建数据源........................................................................................................................................................................... 905.1.2 查询数据源......................................................................................................................................................................... 1255.1.3 删除指定数据源信息........................................................................................................................................................1465.1.4 测试数据源连通性............................................................................................................................................................ 1485.2 任务监控管理........................................................................................................................................................................ 1665.2.1 查询任务监控信息列表................................................................................................................................................... 1665.2.2 查询单个任务的日志详情............................................................................................................................................... 1725.3 任务管理................................................................................................................................................................................. 1825.3.1 创建普通任务.....................................................................................................................................................................1825.3.2 查询指定任务的信息........................................................................................................................................................1885.3.3 删除指定任务.....................................................................................................................................................................1925.3.4 手工触发单个任务............................................................................................................................................................ 1945.3.5 手工停止当前执行的任务............................................................................................................................................... 1975.3.6 创建调度计划.....................................................................................................................................................................1995.3.7 查询调度计划.....................................................................................................................................................................2045.3.8 批量启动\停止任务.......................................................................................................................................................... 207

6 服务集成 API.......................................................................................................................... 2126.1 API 分组管理......................................................................................................................................................................... 2136.1.1 创建 API 分组.....................................................................................................................................................................2136.1.2 修改 API 分组.....................................................................................................................................................................2186.1.3 删除 API 分组.....................................................................................................................................................................2236.1.4 查询分组详情.....................................................................................................................................................................2266.1.5 查询分组列表.....................................................................................................................................................................2316.1.6 校验 API 分组名称是否存在...........................................................................................................................................2366.2 API 管理.................................................................................................................................................................................. 2406.2.1 创建 API.............................................................................................................................................................................. 2406.2.2 修改 API.............................................................................................................................................................................. 2706.2.3 删除 API.............................................................................................................................................................................. 2976.2.4 发布或下线 API................................................................................................................................................................. 3006.2.5 查询 API 详情.....................................................................................................................................................................3046.2.6 查询 API 列表.....................................................................................................................................................................3196.2.7 批量发布或下线 API.........................................................................................................................................................3286.2.8 调试 API.............................................................................................................................................................................. 333


文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 iii

6.2.9 切换 API 版本.....................................................................................................................................................................3396.2.10 查看版本详情.................................................................................................................................................................. 3436.2.11 根据版本编号下线 API.................................................................................................................................................. 3586.2.12 查询 API 历史版本列表................................................................................................................................................. 3616.2.13 查询 API 运行时定义..................................................................................................................................................... 3656.2.14 校验 API 定义.................................................................................................................................................................. 3736.3 环境管理................................................................................................................................................................................. 3776.3.1 创建环境............................................................................................................................................................................. 3776.3.2 修改环境............................................................................................................................................................................. 3816.3.3 删除环境............................................................................................................................................................................. 3846.3.4 查询环境列表.....................................................................................................................................................................3876.4 环境变量管理........................................................................................................................................................................ 3916.4.1 新建变量............................................................................................................................................................................. 3916.4.2 删除变量............................................................................................................................................................................. 3956.4.3 查看变量详情.....................................................................................................................................................................3976.4.4 查询变量列表.....................................................................................................................................................................4006.4.5 修改变量............................................................................................................................................................................. 4046.5 域名管理................................................................................................................................................................................. 4086.5.1 绑定域名............................................................................................................................................................................. 4086.5.2 绑定域名证书.....................................................................................................................................................................4126.5.3 修改域名............................................................................................................................................................................. 4176.5.4 解绑域名............................................................................................................................................................................. 4216.5.5 删除域名证书.....................................................................................................................................................................4246.5.6 查看域名证书.....................................................................................................................................................................4276.6 流控策略管理........................................................................................................................................................................ 4316.6.1 创建流控策略.....................................................................................................................................................................4316.6.2 修改流控策略.....................................................................................................................................................................4376.6.3 删除流控策略.....................................................................................................................................................................4436.6.4 查询流控策略列表............................................................................................................................................................ 4456.6.5 查看流控策略详情............................................................................................................................................................ 4506.7 API 绑定流控策略................................................................................................................................................................ 4546.7.1 绑定流控策略.....................................................................................................................................................................4546.7.2 解除 API 与流控策略的绑定关系.................................................................................................................................. 4586.7.3 查看流控策略绑定的 API 列表...................................................................................................................................... 4616.7.4 查看流控策略未绑定的 API 列表.................................................................................................................................. 4666.7.5 查看 API 绑定的流控策略列表...................................................................................................................................... 4716.7.6 批量解绑流控策略............................................................................................................................................................ 4766.8 设置特殊流控........................................................................................................................................................................ 4806.8.1 创建特殊设置.....................................................................................................................................................................4806.8.2 修改特殊设置.....................................................................................................................................................................4846.8.3 删除特殊设置.....................................................................................................................................................................4886.8.4 查看特殊设置列表............................................................................................................................................................ 492


文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 iv

6.9 签名密钥管理........................................................................................................................................................................ 4966.9.1 创建签名密钥.....................................................................................................................................................................4966.9.2 修改签名密钥.....................................................................................................................................................................5016.9.3 删除签名密钥.....................................................................................................................................................................5056.9.4 查询签名密钥列表............................................................................................................................................................ 5076.10 签名密钥绑定关系管理.................................................................................................................................................... 5126.10.1 绑定签名密钥.................................................................................................................................................................. 5126.10.2 解除绑定........................................................................................................................................................................... 5166.10.3 查看 API 绑定的签名密钥列表.................................................................................................................................... 5206.10.4 查看签名密钥未绑定的 API 列表............................................................................................................................... 5246.10.5 查看签名密钥绑定的 API 列表.................................................................................................................................... 5296.11 ACL 策略管理......................................................................................................................................................................5346.11.1 创建 ACL 策略................................................................................................................................................................. 5346.11.2 修改 ACL 策略................................................................................................................................................................. 5386.11.3 删除 ACL 策略................................................................................................................................................................. 5436.11.4 批量删除 ACL 策略........................................................................................................................................................ 5466.11.5 查看 ACL 策略详情........................................................................................................................................................ 5506.11.6 查看 ACL 策略列表........................................................................................................................................................ 5546.12 API 绑定 ACL 策略............................................................................................................................................................. 5586.12.1 将 API 与 ACL 策略进行绑定....................................................................................................................................... 5586.12.2 解除 API 与 ACL 策略的绑定....................................................................................................................................... 5636.12.3 批量解除 API 与 ACL 策略的绑定.............................................................................................................................. 5666.12.4 查看 ACL 策略绑定的 API 列表...................................................................................................................................5706.12.5 查看 ACL 策略未绑定的 API 列表.............................................................................................................................. 5746.12.6 查看 API 绑定的 ACL 策略列表...................................................................................................................................5796.13 OpenAPI 接口.....................................................................................................................................................................5836.13.1 导出 API............................................................................................................................................................................ 5846.13.2 导入 API............................................................................................................................................................................ 5886.13.3 导出自定义后端 API...................................................................................................................................................... 5936.13.4 导入自定义后端 API...................................................................................................................................................... 5976.14 VPC 通道管理..................................................................................................................................................................... 6026.14.1 创建 VPC 通道................................................................................................................................................................. 6026.14.2 更新 VPC 通道................................................................................................................................................................. 6096.14.3 删除 VPC 通道................................................................................................................................................................. 6176.14.4 查看 VPC 通道详情........................................................................................................................................................ 6206.14.5 查询 VPC 通道列表........................................................................................................................................................ 6276.14.6 添加后端实例.................................................................................................................................................................. 6336.14.7 查看后端实例列表..........................................................................................................................................................6386.14.8 删除后端实例.................................................................................................................................................................. 6436.15 客户端配置.......................................................................................................................................................................... 6466.15.1 查询 APP 列表................................................................................................................................................................. 6466.15.2 查看 APP 详情................................................................................................................................................................. 651


文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 v

6.15.3 创建 APP Code............................................................................................................................................................... 6556.15.4 自动生成 APP Code....................................................................................................................................................... 6596.15.5 查询 APP Code 列表......................................................................................................................................................6636.15.6 查看 APP Code 详情......................................................................................................................................................6676.15.7 删除 APP Code............................................................................................................................................................... 6716.15.8 查询客户端应用关联的应用配额................................................................................................................................6746.15.9 设置 APP 的访问控制.................................................................................................................................................... 6786.15.10 查看 APP 的访问控制详情......................................................................................................................................... 6816.15.11 删除 APP 的访问控制..................................................................................................................................................6856.16 客户端配额.......................................................................................................................................................................... 6886.16.1 创建客户端配额.............................................................................................................................................................. 6886.16.2 修改客户端配额.............................................................................................................................................................. 6936.16.3 删除客户端配额.............................................................................................................................................................. 6976.16.4 获取客户端配额详情..................................................................................................................................................... 7006.16.5 获取客户端配额列表..................................................................................................................................................... 7046.16.6 客户端配额绑定客户端应用列表................................................................................................................................7086.16.7 解除客户端配额和客户端应用的绑定....................................................................................................................... 7126.16.8 查询客户端配额已绑定的客户端应用列表.............................................................................................................. 7156.16.9 查询客户端配额可绑定的客户端应用列表.............................................................................................................. 7206.17 APP 授权管理..................................................................................................................................................................... 7256.17.1 APP 授权........................................................................................................................................................................... 7256.17.2 解除授权........................................................................................................................................................................... 7306.17.3 查看 APP 已绑定的 API 列表....................................................................................................................................... 7346.17.4 查看 APP 未绑定的 API 列表....................................................................................................................................... 7396.17.5 查看 APP 下路径冲突的 api 列表............................................................................................................................... 7446.17.6 查看 API 已绑定的 APP 列表....................................................................................................................................... 7486.18 自定义后端服务................................................................................................................................................................. 7536.18.1 创建后端 API................................................................................................................................................................... 7536.18.2 修改后端 API................................................................................................................................................................... 7606.18.3 删除后端 API................................................................................................................................................................... 7676.18.4 查询后端 API 详情..........................................................................................................................................................7706.18.5 查询后端 API 列表..........................................................................................................................................................7756.18.6 创建后端 API 脚本..........................................................................................................................................................7816.18.7 测试后端 API................................................................................................................................................................... 7886.18.8 查询后端 API 测试结果................................................................................................................................................. 7936.18.9 部署后端 API................................................................................................................................................................... 7976.18.10 查询后端 API 部署历史.............................................................................................................................................. 8046.18.11 撤销后端 API................................................................................................................................................................. 8106.18.12 校验自定义后端 API 定义.......................................................................................................................................... 8136.18.13 查询自定义后端服务配额.......................................................................................................................................... 8176.18.14 查询自定义后端服务数据源列表............................................................................................................................. 8216.19 自定义认证管理................................................................................................................................................................. 825


文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 vi

6.19.1 创建自定义认证.............................................................................................................................................................. 8256.19.2 修改自定义认证.............................................................................................................................................................. 8316.19.3 删除自定义认证.............................................................................................................................................................. 8366.19.4 查看自定义认证详情..................................................................................................................................................... 8396.19.5 查询自定义认证列表..................................................................................................................................................... 8436.20 监控信息查询......................................................................................................................................................................8486.20.1 API 指标统计值查询-最近一段时间...........................................................................................................................8496.20.2 查询 API 指标统计值..................................................................................................................................................... 8546.21 实例管理.............................................................................................................................................................................. 8606.21.1 查看 ROMA Connect 实例详情..................................................................................................................................8606.22 实例特性管理......................................................................................................................................................................8676.22.1 查看实例特性列表..........................................................................................................................................................8676.22.2 实例配置特性.................................................................................................................................................................. 8726.23 标签管理.............................................................................................................................................................................. 8766.23.1 查询标签列表.................................................................................................................................................................. 8766.24 配置管理.............................................................................................................................................................................. 8796.24.1 查询某个实例的租户配置列表.................................................................................................................................... 8806.25 应用配置管理......................................................................................................................................................................8866.25.1 创建应用配置.................................................................................................................................................................. 8866.25.2 修改应用配置.................................................................................................................................................................. 8916.25.3 删除应用配置.................................................................................................................................................................. 8946.25.4 查看应用配置详情..........................................................................................................................................................8986.25.5 查询应用配置列表..........................................................................................................................................................901

7 消息集成 API.......................................................................................................................... 9077.1 MQS 实例管理...................................................................................................................................................................... 9077.1.1 查询 MQS 实例列表......................................................................................................................................................... 9077.1.2 查询 MQS 实例详情......................................................................................................................................................... 9147.2 主题管理................................................................................................................................................................................. 9217.2.1 查询 Topic 列表................................................................................................................................................................. 9217.2.2 创建 Topic........................................................................................................................................................................... 9247.2.3 修改 Topic........................................................................................................................................................................... 9267.2.4 批量删除 Topic.................................................................................................................................................................. 9287.2.5 批量删除 Topic.................................................................................................................................................................. 9307.2.6 导入 Topic........................................................................................................................................................................... 9317.2.7 导出 Topic........................................................................................................................................................................... 9337.3 应用权限管理........................................................................................................................................................................ 9347.3.1 更新 Topic 权限................................................................................................................................................................. 9347.3.2 查询 Topic 权限................................................................................................................................................................. 9377.4 消息管理................................................................................................................................................................................. 9397.4.1 查询消息............................................................................................................................................................................. 9397.4.2 重发消息............................................................................................................................................................................. 942

8 设备集成 API.......................................................................................................................... 944


文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 vii

8.1 设备分组管理........................................................................................................................................................................ 9448.1.1 创建设备分组.....................................................................................................................................................................9448.1.2 查询所有设备分组............................................................................................................................................................ 9488.1.3 删除设备分组.....................................................................................................................................................................9528.1.4 查询设备分组详情............................................................................................................................................................ 9548.1.5 修改设备分组.....................................................................................................................................................................9598.1.6 批量添加设备到设备分组............................................................................................................................................... 9638.1.7 删除设备分组内的设备................................................................................................................................................... 9668.2 设备管理................................................................................................................................................................................. 9688.2.1 创建设备............................................................................................................................................................................. 9688.2.2 查询设备............................................................................................................................................................................. 9778.2.3 设备批量下线.....................................................................................................................................................................9858.2.4 删除设备............................................................................................................................................................................. 9888.2.5 查询设备详情.....................................................................................................................................................................9918.2.6 修改设备............................................................................................................................................................................. 9988.2.7 查询设备主题.................................................................................................................................................................. 10058.2.8 添加子设备到网关..........................................................................................................................................................10098.2.9 查询子设备.......................................................................................................................................................................10158.2.10 查询设备影子................................................................................................................................................................ 10238.2.11 重置设备鉴权信息....................................................................................................................................................... 10278.2.12 查询设备鉴权信息....................................................................................................................................................... 10298.2.13 发送命令........................................................................................................................................................................ 10328.3 产品模板.............................................................................................................................................................................. 10358.3.1 创建产品模板.................................................................................................................................................................. 10358.3.2 查询产品模板.................................................................................................................................................................. 10398.3.3 删除产品模板.................................................................................................................................................................. 10448.3.4 修改产品模板.................................................................................................................................................................. 10468.4 产品管理.............................................................................................................................................................................. 10518.4.1 创建产品........................................................................................................................................................................... 10518.4.2 查询产品........................................................................................................................................................................... 10578.4.3 查询产品内设备数量..................................................................................................................................................... 10638.4.4 删除产品........................................................................................................................................................................... 10668.4.5 查询产品详情.................................................................................................................................................................. 10688.4.6 修改产品信息.................................................................................................................................................................. 10748.4.7 添加产品主题.................................................................................................................................................................. 10808.4.8 查询产品主题.................................................................................................................................................................. 10838.4.9 删除产品主题.................................................................................................................................................................. 10878.4.10 更新产品主题................................................................................................................................................................ 10908.4.11 重置产品鉴权信息....................................................................................................................................................... 10948.4.12 查询产品鉴权信息....................................................................................................................................................... 10978.4.13 导入产品........................................................................................................................................................................ 11008.4.14 导出产品........................................................................................................................................................................ 1102


文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 viii

8.5 规则引擎.............................................................................................................................................................................. 11058.5.1 创建规则........................................................................................................................................................................... 11058.5.2 查询规则........................................................................................................................................................................... 11108.5.3 批量删除规则.................................................................................................................................................................. 11158.5.4 规则调试........................................................................................................................................................................... 11188.5.5 删除规则........................................................................................................................................................................... 11208.5.6 查询规则详情.................................................................................................................................................................. 11238.5.7 修改规则........................................................................................................................................................................... 11278.5.8 添加目标数据源.............................................................................................................................................................. 11338.5.9 查询目标数据源列表..................................................................................................................................................... 11378.5.10 删除目标数据源........................................................................................................................................................... 11428.5.11 添加源数据源................................................................................................................................................................ 11448.5.12 查询源数据源列表....................................................................................................................................................... 11488.5.13 删除源数据源................................................................................................................................................................ 11538.6 服务管理.............................................................................................................................................................................. 11558.6.1 创建服务........................................................................................................................................................................... 11558.6.2 查询服务........................................................................................................................................................................... 11608.6.3 删除服务........................................................................................................................................................................... 11658.6.4 查询服务详情.................................................................................................................................................................. 11688.6.5 修改服务........................................................................................................................................................................... 11728.6.6 创建属性........................................................................................................................................................................... 11778.6.7 查询属性........................................................................................................................................................................... 11828.6.8 创建命令........................................................................................................................................................................... 11868.6.9 查询命令........................................................................................................................................................................... 11898.6.10 删除命令........................................................................................................................................................................ 11938.6.11 查询命令详情................................................................................................................................................................ 11968.6.12 修改命令........................................................................................................................................................................ 11998.6.13 创建请求属性................................................................................................................................................................ 12028.6.14 查询请求属性................................................................................................................................................................ 12078.6.15 删除请求属性................................................................................................................................................................ 12128.6.16 修改请求属性................................................................................................................................................................ 12158.6.17 创建响应属性................................................................................................................................................................ 12218.6.18 查询响应属性................................................................................................................................................................ 12268.6.19 删除响应属性................................................................................................................................................................ 12318.6.20 查询响应属性详情....................................................................................................................................................... 12338.6.21 修改响应属性................................................................................................................................................................ 1237

9 附录....................................................................................................................................... 12449.1 获取项目 ID......................................................................................................................................................................... 12449.2 获取账号 ID......................................................................................................................................................................... 12459.3 状态码................................................................................................................................................................................... 12469.4 错误码................................................................................................................................................................................... 12479.4.1 公共资源 API 错误码..................................................................................................................................................... 1247


文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 ix

9.4.2 数据集成 API 错误码..................................................................................................................................................... 12549.4.3 服务集成 API 错误码..................................................................................................................................................... 12629.4.4 消息集成 API 错误码..................................................................................................................................................... 12859.4.5 设备集成 API 错误码..................................................................................................................................................... 12909.5 实例支持的 APIC 特性...................................................................................................................................................... 13179.6 数据集成参数说明............................................................................................................................................................. 13259.6.1 RawFormDataRequest................................................................................................................................................ 13259.6.2 RawFormDataResponse..............................................................................................................................................13369.7 获取数据源配置文件.........................................................................................................................................................13469.7.1 FI HDFS............................................................................................................................................................................ 13469.7.2 FI Hive...............................................................................................................................................................................13469.7.3 FI Kafka............................................................................................................................................................................ 13479.7.4 MRS Hive......................................................................................................................................................................... 13479.7.5 MRS HDFS....................................................................................................................................................................... 13489.7.6 MRS HBase......................................................................................................................................................................13489.7.7 MRS Kafka....................................................................................................................................................................... 1349

10 历史 API............................................................................................................................. 135010.1 服务集成 API（V1）...................................................................................................................................................... 135010.1.1 创建 API 分组................................................................................................................................................................ 135010.1.2 修改 API 分组................................................................................................................................................................ 135210.1.3 删除 API 分组................................................................................................................................................................ 135410.1.4 查询 API 分组详情....................................................................................................................................................... 135510.1.5 查询 API 分组列表....................................................................................................................................................... 135710.1.6 创建 API..........................................................................................................................................................................135910.1.7 修改 API..........................................................................................................................................................................136910.1.8 删除 API..........................................................................................................................................................................138010.1.9 批量删除 API................................................................................................................................................................. 138010.1.10 查询 API 详情............................................................................................................................................................. 138210.1.11 查询 API 列表............................................................................................................................................................. 138710.1.12 发布 API....................................................................................................................................................................... 139110.1.13 下线 API....................................................................................................................................................................... 139210.1.14 批量发布或下线 API................................................................................................................................................. 139310.1.15 授权............................................................................................................................................................................... 139510.1.16 解除授权...................................................................................................................................................................... 139710.1.17 查看 APP 未绑定的 API 列表.................................................................................................................................. 139810.1.18 查看 APP 已绑定的 API 列表.................................................................................................................................. 139910.1.19 查看 API 已绑定的 APP 列表.................................................................................................................................. 140210.1.20 创建自定义认证......................................................................................................................................................... 140410.1.21 修改自定义认证......................................................................................................................................................... 140610.1.22 删除自定义认证......................................................................................................................................................... 140910.1.23 查询自定义认证详情................................................................................................................................................ 141010.1.24 查询自定义认证列表................................................................................................................................................ 1411


文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 x

10.1.25 创建后端 API.............................................................................................................................................................. 141310.1.26 创建后端 API 脚本.....................................................................................................................................................141710.1.27 修改后端 API.............................................................................................................................................................. 141910.1.28 删除后端 API.............................................................................................................................................................. 142210.1.29 查询后端 API 详情.....................................................................................................................................................142310.1.30 查询后端 API 列表.....................................................................................................................................................142610.1.31 部署后端 API.............................................................................................................................................................. 142810.1.32 撤销后端 API.............................................................................................................................................................. 143010.1.33 查询后端 API 部署历史............................................................................................................................................ 143110.1.34 测试后端 API.............................................................................................................................................................. 143210.1.35 查询后端 API 测试结果............................................................................................................................................ 143410.1.36 创建数据源.................................................................................................................................................................. 143610.1.37 修改数据源.................................................................................................................................................................. 143810.1.38 删除数据源.................................................................................................................................................................. 144010.1.39 查询数据源详情......................................................................................................................................................... 144110.1.40 查询数据源列表......................................................................................................................................................... 144210.1.41 测试数据源.................................................................................................................................................................. 144410.2 设备集成 API（V1）...................................................................................................................................................... 144510.2.1 创建产品........................................................................................................................................................................ 144510.2.2 查询产品列表................................................................................................................................................................ 144710.2.3 创建设备........................................................................................................................................................................ 144810.2.4 创建设备自定义 Topic................................................................................................................................................ 145010.2.5 查询设备列表................................................................................................................................................................ 145210.2.6 查询设备 Topic 列表................................................................................................................................................... 145410.2.7 查询实例信息................................................................................................................................................................ 145510.2.8 创建规则引擎源端....................................................................................................................................................... 145610.2.9 创建规则引擎目的端................................................................................................................................................... 1458

11 修订记录............................................................................................................................. 1461


文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 xi

1 使用前必读概述

调用说明

终端节点

约束与限制

基本概念

1.1 概述ROMA Connect是一个全栈式的应用与数据集成平台，提供消息、数据、API、设备等集成能力，简化企业上云，支持云上云下、跨区域集成，帮助企业实现数字化转型。

您可以使用本文档提供的API对ROMA Connect进行相关操作，如创建、删除、变更API、添加自定义后端等。支持的全部操作请参见API概览。

在调用ROMA Connect API之前，请确保已经充分了解ROMA Connect相关概念，详细信息请参见产品介绍。

1.2 调用说明ROMA Connect提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。

1.3 终端节点终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。

ROMA Connect的终端节点如表1-1所示。

应用与数据集成平台API 参考 1 使用前必读

文档版本 06 (2021-01-04) 版权所有 © 华为技术有限公司 1

https://support.huaweicloud.com/productdesc-roma/what-is-ROMA.htmlhttps://developer.huaweicloud.com/endpoint?ROMA%20Connect

表 1-1 ROMA Connect 的终端节点

区域名称区域终端节点（Endpoint）

华北-北京一

cn-north-1 roma.cn-north-1.myhuaweicloud.com

华北-北京四

cn-north-4 roma.cn-north-4.myhuaweicloud.com

华东-上海一

cn-east-3 roma.cn-east-3.myhuaweicloud.com

华东-上海二

cn-east-2 roma.cn-east-2.myhuaweicloud.com

华南-广州 cn-south-1 roma.cn-south-1.myhuaweicloud.com

亚太-新加坡

ap-southeast-3

roma.ap-southeast-3.myhuaweicloud.com

1.4 约束与限制● 您能创建的ROMA Connect资源数量与配额有关系，具体请参见使用限制。● 更详细的限制请参见具体API的说明。

1.5 基本概念● 账号

用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。

● 用户由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。

通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。● 区域（Region）

从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。详情请参见区域和可用区。

● 可用区（AZ，Availability Zone）一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。

● 项目



https://support.huaweicloud.com/productdesc-roma/usage-limits.htmlhttps://support.huaweicloud.com/usermanual-iaas/zh-cn_topic_0184026189.html

华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。

图 1-1 项目隔离模型

● 企业项目企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。



https://support.huaweicloud.com/usermanual-em/em_am_0006.htmlhttps://support.huaweicloud.com/usermanual-em/em_am_0006.html

2 API 概览功能 API分类说明

公共资源API 应用管理集成应用相关API，包括集成应用的创建、修改、查询、删除等操作。

资产管理资产相关API，包括资产的导入、导出、下载等操作。

字典管理字典相关API，包括字典的创建、修改、查询、删除等操作。

公共管理接口版本相关API，可查询接口版本的信息。

数据集成API 数据源管理数据源相关API，包括数据源的创建、修改、查询、删除等操作。

任务监控管理任务监控相关API，可查询任务的运行信息。

任务管理数据集成任务相关API，包括任务的创建、修改、查询、删除、启动等操作。

服务集成API API分组管理 API分组相关API，包括分组的创建、修改、查询、删除等操作。

API管理 API管理相关API，包括API的创建、修改、查询、删除、发布等操作。

环境管理环境相关API，包括环境的创建、修改、查询、删除等操作。

环境变量管理环境变量相关API，包括环境变量的创建、修改、查询、删除等操作。

域名管理域名相关API，包括域名的绑定、修改、查询、删除等操作。

流控策略管理流控策略相关API，包括策略的创建、修改、查询、删除等操作。

API绑定流控策略

流控策略绑定相关API，包括策略的绑定、解绑等操作。

应用与数据集成平台API 参考 2 API 概览


功能 API分类说明

设置特殊流控特殊流控策略相关API，包括特殊流控策略的创建、修改、查询、删除等操作。

签名密钥管理签名密钥相关API，包括签名密钥的创建、修改、查询、删除等操作。

签名密钥绑定关系管理

签名密钥绑定相关API，包括签名密钥的绑定、解绑等操作。

ACL策略管理 ACL策略相关API，包括策略的创建、修改、查询、删除等操作。

API绑定ACL策略

ACL策略绑定相关API，包括策略的绑定、解绑等操作。

OpenAPI接口

API导入导出相关API，包括前后端API的导入导出操作。

VPC通道管理 VPC通道相关API，包括VPC通道的创建、修改、查询、删除等操作。

客户端配置客户端配置相关API，包括APP Code的创建、查询、删除等操作。

客户端配额客户端配额相关API，包括客户端配额的创建、修改、查询、删除等操作。

APP授权管理 APP授权相关API，包括APP的授权、解授权、授权查询等操作。

自定义后端服务

自定义后端相关API，包括自定义后端的创建、修改、查询、删除、部署等操作。

自定义认证管理

自定义认证相关API，包括自定义认证的创建、修改、查询、删除等操作。

监控信息查询监控信息查询相关API，可查询不同监控信息。

实例管理实例相关API，可查询ROMA Connect的实例信息。

实例特性管理实例特性配置相关API，包括特性配置、特性查询等操作。

标签管理标签相关API，可查询标签信息。

配置管理配置查询相关API，可查询实例的用户配置。

应用配置管理应用配置相关API，包括应用配置的创建、修改、查询、删除等操作。

消息集成API MQS实例管理

MQS实例相关API，可查询实例相关信息。

主题管理消息Topic相关API，包括Topic查询、删除等操作。

应用权限管理消息Topic权限相关API，包括Topic权限更新、查询等操作。



功能 API分类说明

消息管理消息相关API，包括消息的查询、重发等操作。

设备集成API 设备分组管理设备分组相关API，包括设备分组的创建、修改、查询、删除等操作。

设备管理设备相关API，包括设备的创建、修改、查询、删除等操作。

产品模板产品模板相关API，包括产品模板的创建、修改、查询、删除等操作。

产品管理产品相关API，包括产品的创建、修改、查询、删除等操作。

规则引擎规则引擎相关API，包括规则的创建、修改、查询、删除等操作。

服务管理设备服务相关API，包括设备服务和属性的创建、修改、查询、删除等操作。



3 如何调用 API构造请求

认证鉴权

返回结果

3.1 构造请求本节介绍REST API请求的组成，并以调用IAM的获取用户Token接口说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。

请求 URI请求URI由如下部分组成。

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

表 3-1 URI 中的参数说明

参数描述

URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。

Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。

resource-path 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。

应用与数据集成平台API 参考 3 如何调用 API


https://support.huaweicloud.com/api-iam/iam_30_0001.htmlhttps://developer.huaweicloud.com/endpoint

参数描述

query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。多个查询参数之间使用“&”隔开。

例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。

https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

图 3-1 URI 示意图

说明

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。

表 3-2 HTTP 方法

方法说明

GET 请求服务器返回指定资源。

PUT 请求服务器更新指定资源。

POST 请求服务器新增资源或执行特殊操作。

DELETE 请求服务器删除指定资源，

api 参考在调用roma...

Documents