- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 开始使用ROMA Connect
- 实例管理
- 集成应用管理
-
数据源管理
- ROMA Connect支持的数据源
- 接入API数据源
- 接入ActiveMQ数据源
- 接入ArtemisMQ数据源
- 接入DB2数据源
- 接入DIS数据源
- 接入DWS数据源
- 接入DM数据源
- 接入Gauss100数据源
- 接入FTP数据源
- 接入HL7数据源
- 接入HANA数据源
- 接入HIVE数据源
- 接入LDAP数据源
- 接入IBM MQ数据源
- 接入Kafka数据源
- 接入MySQL数据源
- 接入MongoDB数据源
- 接入MQS数据源
- 接入MRS Hive数据源
- 接入MRS HDFS数据源
- 接入MRS HBase数据源
- 接入MRS Kafka数据源
- 接入OBS数据源
- 接入Oracle数据源
- 接入PostgreSQL数据源
- 接入Redis数据源
- 接入RabbitMQ数据源
- 接入RocketMQ数据源
- 接入SAP数据源
- 接入SNMP数据源
- 接入SQL Server数据源
- 接入GaussDB(for MySQL)数据源
- 接入WebSocket数据源
- 接入自定义数据源
- 数据集成指导
- 服务集成指导
- 服务集成指导(旧版界面)
- 消息集成指导
- 设备集成指导
- 应用业务模型使用指导
- 扩大资源配额
- 查看审计日志
- 查看监控指标
- 权限管理
- 用户指南(新版)
- 最佳实践
-
开发指南
- 数据集成开发指导
-
服务集成开发指导
- 开发说明
- API调用认证开发(APP认证)
- API调用认证开发(IAM认证)
-
自定义后端开发(函数后端)
- 函数后端脚本开发说明
- AesUtils类说明
- APIConnectResponse类说明
- Base64Utils类说明
- CacheUtils类说明
- CipherUtils类说明
- ConnectionConfig类说明
- DataSourceClient类说明
- DataSourceConfig类说明
- ExchangeConfig类说明
- HttpClient类说明
- HttpConfig类说明
- JedisConfig类说明
- JSON2XMLHelper类说明
- JSONHelper类说明
- JsonUtils类说明
- JWTUtils类说明
- KafkaConsumer类说明
- KafkaProducer类说明
- KafkaConfig类说明
- MD5Encoder类说明
- Md5Utils类说明
- QueueConfig类说明
- RabbitMqConfig类说明
- RabbitMqProducer类说明
- RedisClient类说明
- RomaWebConfig类说明
- RSAUtils类说明
- SapRfcClient类说明
- SapRfcConfig类说明
- SoapClient类说明
- SoapConfig类说明
- StringUtils类说明
- TextUtils类说明
- XmlUtils类说明
- 自定义后端开发(数据后端)
- 后端服务签名校验开发
- 消息集成开发指导
- 设备集成开发指导
-
API参考
- 使用前必读
- API概览
- 如何调用API
- 公共资源API
- 数据集成API
- 服务集成API
- 消息集成API
- 设备集成API
- 应用示例
- 权限和授权项
- 附录
- 历史API
- 修订记录
- SDK参考
-
常见问题
- 实例管理
-
数据集成
-
数据集成普通任务
- FDI各类数据库支持哪些数据类型?
- 跟踪号是什么,能跟踪到数据吗?
- FDI任务是否支持清空目标表?
- FDI任务只能采集单张表到单张表吗?
- 用户创建的FDI任务,同一账号的其他用户可见吗?
- FDI通过公网对接其他租户的MRS HIVE如何配置?
- 从OBS解析文件到RDS数据库,采集过一次后,后面采集会进行更新吗?
- OBS源端的CSV文件解析到关系型数据库时,列的值不对怎么办?
- MRS Hive目标字段和源端字段数据类型不匹配时,数据是否能集成到目标端?
- MRS Hive、MRS HBase和MongoDB的Mapping映射手动输入时,是否区分大小写?
- MRS Hive是否支持分区?
- 源端API类型数据源自定义周期如何设置?
- SAP是否支持分页读取视图?
- 数据集成组合任务
-
数据集成普通任务
- 服务集成
- 消息集成
- 设备集成
-
故障排除
-
数据集成任务
- MRS Hive目标端写入时出现数据乱码
- MRS Hive写入时数据全部写在第一个字段里
- 目标端任务报任务运行超时
- MySQL到MRS Hive时目标端报“could only be written to 0 of the 1 minReplication nodes. There are 2 datanode(s) running and 2 node(s) are excluded in this operation”错误
- Mysql到Mysql时源端报“Illegal mix of collations for operation 'UNION'”错误
- 源端Mysql增量采集每小时执行一次时部分数据丢失
- API到MySQL时源端报“401 unauthorized”错误
- Kafka集到Mysql目标端报“cannot find record mapping field”错误
- API到MySQL的定时任务时会出现源端报“connect timeout”错误
- Kafka到Mysql的实时任务时,MQS中的Topic下有数据,但是FDI任务没有采集到数据。
- Mysql到Mysql的定时任务,源端有类型为tinyint(1),值为2的字段,但是采集到目标端值就变成了1
- 目标端数据源为公网Kafka时,定时任务目标端报“The task executes failed.Writer data to kafka failed”错误
- 数据集成组合任务
- 数据源
- 服务集成
- 设备集成
-
数据集成任务
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询产品
功能介绍
查询产品。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/link/instances/{instance_id}/products
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 最小长度:0 最大长度:32 |
instance_id |
是 |
String |
实例ID。 最小长度:0 最大长度:36 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页显示条目数量,最大数量999,超过999后只返回999。 最小值:1 最大值:9999 缺省值:10 |
app_id |
否 |
String |
应用ID。 最小长度:0 最大长度:36 |
id |
否 |
String |
产品ID。 最小长度:0 最大长度:64 |
name |
否 |
String |
产品名称。 最小长度:0 最大长度:64 |
manufacturer_id |
否 |
String |
厂商ID。 最小长度:0 最大长度:64 |
manufacturer_name |
否 |
String |
厂商名称。 最小长度:0 最大长度:64 |
model |
否 |
String |
型号。 最小长度:0 最大长度:64 |
device_type |
否 |
String |
产品的设备类型,默认Default。 最小长度:0 最大长度:64 |
product_type |
否 |
Integer |
产品类型,0-普通产品(不支持子设备) 1-网关产品。 最小值:0 最大值:10 |
protocol_type |
否 |
Integer |
产品的协议类型 0-mqtt 1-CoAP 2-modbus 4-opcua 5-扩展协议。 最小值:0 最大值:10 |
created_user_name |
否 |
String |
创建用户。 最小长度:0 最大长度:64 |
created_date_start |
否 |
Long |
创建时间起始,格式timestamp(ms),使用UTC时区。 最小值:1 最大值:99999999999999999 |
created_date_end |
否 |
Long |
创建时间截止,格式timestamp(ms),使用UTC时区。 最小值:1 最大值:99999999999999999 |
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询, offset大于等于0。 最小值:0 最大值:999999 缺省值:0 |
app_name |
否 |
String |
应用名称。 最小长度:0 最大长度:256 |
product_serial |
否 |
String |
产品唯一序列(系统唯一值,用于MQS的TOPIC中标记产品)。 最小长度:0 最大长度:64 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
总数。 最小值:1 最大值:9999999999 |
size |
Integer |
本次返回数量。 最小值:1 最大值:999 |
items |
Array of Product objects |
产品列表。 数组长度:0 - 9999 |
参数 |
参数类型 |
描述 |
---|---|---|
permissions |
Array of strings |
权限。 |
id |
Integer |
产品ID。 最小值:1 最大值:99999999999999999 |
product_serial |
String |
产品唯一序列(系统唯一值,用于MQS的TOPIC中标记产品)。 最小长度:0 最大长度:64 |
app_id |
String |
应用ID。 最小长度:0 最大长度:64 |
name |
String |
产品名称,创建产品时租户内唯一,长度最大64,仅支持中文、英文字母、数字、下划线和中划线。 最小长度:0 最大长度:64 |
manufacturer_id |
String |
产品供应商ID。 最小长度:0 最大长度:64 |
manufacturer_name |
String |
厂商名称。 最小长度:0 最大长度:64 |
model |
String |
产品型号。 最小长度:0 最大长度:64 |
product_type |
Integer |
产品类型,0-普通产品(不支持子设备) 1-网关产品。 最小值:0 最大值:10 |
description |
String |
产品描述,长度0-200。 最小长度:0 最大长度:200 |
protocol_type |
Integer |
产品的协议类型,0-mqtt 1-CoAP 2-modbus 4-opcua 5-扩展协议。 最小值:0 最大值:10 |
device_type |
String |
产品的设备类型(默认Default)。 最小长度:0 最大长度:64 |
version |
String |
产品版本。 最小长度:0 最大长度:64 |
created_user |
CreatedUser object |
创建时的用户。 |
last_updated_user |
LastUpdatedUser object |
最后更新时的用户。 |
authentication |
Authentication object |
鉴权 |
created_datetime |
Long |
创建时间,timestamp(ms),使用UTC时区。 最小值:1 最大值:99999999999999999 |
app_name |
String |
应用名称。 最小长度:0 最大长度:256 |
data_format |
Integer |
data_format 0-JSON 1-USER_DEFINED 最小值:1 最大值:99999999999999999 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
用户ID(保留字段,未使用)。 最小长度:0 最大长度:64 |
user_name |
String |
用户名。 最小长度:0 最大长度:64 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
用户ID(保留字段,未使用)。 最小长度:0 最大长度:64 |
user_name |
String |
用户名。 最小长度:0 最大长度:64 |
参数 |
参数类型 |
描述 |
---|---|---|
user_name |
String |
一型一密/一机一密的用户名。 最小长度:0 最大长度:64 |
password |
String |
一型一密/一机一密的密码,输入要求:至少1个数字,1个大写字母,1个小写字母,1个特殊字符(~!@#$%^&*()-_=+|[{}];:<>/?),长度8-32个字符。 最小长度:0 最大长度:64 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述。 最小长度:0 最大长度:200 |
request_id |
String |
消息ID。 最小长度:0 最大长度:64 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述。 最小长度:0 最大长度:200 |
request_id |
String |
消息ID。 最小长度:0 最大长度:64 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述。 最小长度:0 最大长度:200 |
request_id |
String |
消息ID。 最小长度:0 最大长度:64 |
请求示例
GET /{project_id}/link/instances/{instance_id}/products
响应示例
状态码: 200
OK
{ "total" : 1, "size" : 1, "items" : [ { "permissions" : [ "read", "access", "delete", "modify" ], "id" : 120671, "product_serial" : "Dd1bRt122894", "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98", "name" : "pro-opcua", "manufacturer_id" : "pro-opcua", "manufacturer_name" : "pro-opcua", "model" : "pro-opcua", "product_type" : 0, "description" : "opcua product", "protocol_type" : 4, "device_type" : "default", "version" : "version", "created_datetime" : 1607481372416, "last_updated_datetime" : 1607481372416, "app_name" : "app-link", "data_format" : 0, "created_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "last_updated_user" : { "user_id" : "6546435432432", "user_name" : "user1" }, "authentication" : { "user_name" : "4MjxbCl4q461", "password" : "********" } } ] }
状态码: 400
Bad Request
{ "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-product.search]. Parameter is [product_type]. Processor is [query].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" }
状态码: 404
Not Found
{ "error_code" : "SCB.00000000", "error_msg" : "Not Found", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" }
状态码: 500
Internal Server Error
{ "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。