查询产品
功能介绍
查询产品。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/link/instances/{instance_id}/products
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
|
instance_id |
是 |
String |
实例ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每页显示条目数量，最大数量999，超过999后只返回999。 |
|
app_id |
否 |
String |
应用ID。 |
|
id |
否 |
String |
产品ID。 |
|
name |
否 |
String |
产品名称。 |
|
manufacturer_id |
否 |
String |
厂商ID。 |
|
manufacturer_name |
否 |
String |
厂商名称。 |
|
model |
否 |
String |
型号。 |
|
device_type |
否 |
String |
产品的设备类型，默认Default。 |
|
product_type |
否 |
Integer |
产品类型，0-普通产品(不支持子设备) 1-网关产品。 |
|
protocol_type |
否 |
Integer |
产品的协议类型 0-mqtt 1-CoAP 2-modbus 4-opcua 5-扩展协议。 |
|
created_user_name |
否 |
String |
创建用户。 |
|
created_date_start |
否 |
Long |
创建时间起始，格式timestamp(ms)，使用UTC时区。 |
|
created_date_end |
否 |
Long |
创建时间截止，格式timestamp(ms)，使用UTC时区。 |
|
offset |
否 |
Integer |
偏移量，表示从此偏移量开始查询， offset大于等于0。 |
|
app_name |
否 |
String |
应用名称。 |
|
product_serial |
否 |
String |
产品唯一序列（系统唯一值，用于MQS的TOPIC中标记产品）。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
总数。 |
|
size |
Integer |
本次返回数量。 |
|
items |
Array of Product objects |
产品列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
permissions |
Array of strings |
权限。 |
|
id |
Integer |
产品ID。 |
|
product_serial |
String |
产品唯一序列（系统唯一值，用于MQS的TOPIC中标记产品）。 |
|
app_id |
String |
应用ID。 |
|
name |
String |
产品名称，创建产品时租户内唯一，长度最大64，仅支持中文、英文字母、数字、下划线和中划线。 |
|
manufacturer_id |
String |
产品供应商ID。 |
|
manufacturer_name |
String |
厂商名称。 |
|
model |
String |
产品型号。 |
|
product_type |
Integer |
产品类型，0-普通产品(不支持子设备) 1-网关产品。 |
|
description |
String |
产品描述，长度0-200。 |
|
protocol_type |
Integer |
产品的协议类型，0-mqtt 1-CoAP 2-modbus 4-opcua 5-扩展协议。 |
|
device_type |
String |
产品的设备类型（默认Default）。 |
|
version |
String |
产品版本。 |
|
created_user |
CreatedUser object |
创建时的用户。 |
|
last_updated_user |
LastUpdatedUser object |
最后更新时的用户。 |
|
authentication |
Authentication object |
鉴权 |
|
created_datetime |
Long |
创建时间，timestamp(ms)，使用UTC时区。 |
|
app_name |
String |
应用名称。 |
|
data_format |
Integer |
data_format 0-JSON 1-USER_DEFINED |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_name |
String |
一型一密/一机一密的用户名。 |
|
password |
String |
一型一密/一机一密的密码，输入要求：至少1个数字，1个大写字母，1个小写字母，1个特殊字符(~!@#$%^&*()-_=+|[{}];:<>/?)，长度8-32个字符。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 |
|
error_msg |
String |
错误描述。 |
|
request_id |
String |
消息ID。 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 |
|
error_msg |
String |
错误描述。 |
|
request_id |
String |
消息ID。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 |
|
error_msg |
String |
错误描述。 |
|
request_id |
String |
消息ID。 |
请求示例
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 |
错误码
请参见错误码。
