设备接入 IoTDA设备接入 IoTDA

更新时间:2021/09/06 GMT+08:00
分享

查询产品列表

接口说明

应用服务器可调用此接口查询拥有的产品信息列表。

URI

请求方法

GET

URI

/api/v3.0/products

传输协议

HTTPS

请求参数

名称

必选/可选

类型

位置

说明

app_key

必选

String

Header

已鉴权应用的appId。

Authorization

必选

String

Header

请求的认证信息,值为“Bearer ******”,其中******为Auth鉴权接口返回的accessToken。

ownerAppId

可选

String

Query

资源所属应用的appId,访问其他应用所持有的资源时需要填写。

pageNo

可选

Integer

Query

查询结果分页时的页码数。

pageSize

可选

Integer

Query

查询结果分页时的每页结果数量。

响应参数

名称

类型

说明

products

List<QueryProductDTOCloud2NA>

产品列表信息。

pageNo

Integer

页码。

pageSize

Integer

每页展示记录条数。

totalCount

Integer

总记录数。

表1 QueryProductDTOCloud2NA

名称

类型

说明

productId

String

产品ID。

deviceType

String

设备类型。

manufacturerId

String

厂商ID。

manufacturerName

String

厂商名。

model

String

设备型号。

protocolType

String

协议类型。

description

String

产品描述。

请求示例

GET https://{host}:{port}/api/v3.0/products?ownerAppId={ownerAppId}&pageNo={pageNo}&pageSize={pageSize}
Content-Type: application/json
app_key: ********
Authorization: ********

响应示例

Status Code: 200 OK

Content-Type: application/json

{
  "products" : [ {
    "deviceType" : "string",
    "productId" : "string",
    "manufacturerName" : "string",
    "manufacturerId" : "string",
    "description" : "string",
    "model" : "string",
    "protocolType" : "string"
  } ],
  "pageNo" : 0,
  "pageSize" : 0,
  "totalCount" : 0
}

错误码

HTTP状态码

HTTP状态码说明

错误码

错误码描述

200

OK

-

-

401

Unauthorized

100025

App for auth not exist.

处理建议:确认App是否已经创建并获取权限。

403

Forbidden

100203

The application is not existed.

处理建议:确认App是否已经创建。

100217

The application hasn't been authorized.

处理建议:确认App是否获取权限。

分享:

    相关文档

    相关产品