提供了一组与物的产品相关的服务接口,云端应用通过本组服务接口可以实现对物的产品列表及物的产品查询。

查询产品列表

定义描述

path 版本 描述 是否需要cloudToken
/cloud/thing/productList/get 1.1.0 查询物的产品列表

请求参数

参数 类型 必填 描述
pageNo int 分页查询页,从1开始
pageSize int 分页大小

返回参数

参数 类型 描述
accessMethod String 访问方式
productKey String 产品PK
dataFormat String 数据格式
netType String 入网类型
productSecret String 产品密钥
nodeType String 节点类型
domain String 领域
name String 产品名称
region String 地域
ownerDomain String 所有者领域
categoryId Long 归属品类id
accessMethod String 访问方式
status Integer 产品状态
  • 0:开发中
  • 1:已发布
gmtCreate Date 创建时间
gmtModified Date 修改时间
creator String 创建者
modifier String 修改者
productId Long 产品Id
aliyunCommodityCode String 商品码
rbacTenantId String rbac租户Id

示例

  • 请求示例
    {
        "id": 1508232047194,
        "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.1.0"
        },
        "params": {
            "pageNo" : 1,
            "pageSize" : 10 
        },
        "version": "1.0"
    }
  • 正常返回示例
    {
        "code": 200,
        "data": [{
            "accessMethod": "DATA_DIRECT",
            "gmtModified": 1517562992000,
            "productModel": "niki_test_prodcut_model",
            "modifier": "50a1al5842f9067bd97f3350201b3f85e2ff9014",
            "productKey": "a15iEO9rxCf",
            "image": "logo",
            "creator": "50a1al5842f9067bd97f3350201b3f85e2ff9014",
            "productId": 95959,
            "dataFormat": "CUSTOM_FORMAT",
            "netType": "NET_CELLULAR",
            "aliyunCommodityCode": "tmp",
            "productSecret": "Y1kNXdpAuoHICkCw",
            "nodeType": "DEVICE",
            "gmtCreate": 1517562992000,
            "domain": "a15iEO9rxCf",
            "name": "test_name",
            "tenantId": 21,
            "region": "cn-hangzhou",
            "rbacTenantId": "2BF8238E359B4C84A9859C7180BD2CF6",
            "ownerDomain": "tmp_50a1al5842f9067bd97f3350201b3f85e2ff9014",
            "categoryId": 61,
            "status": "DEVELOPMENT_STATUS"
        }],
        "id": "db13e9ae-c617-4f50-b792-a1e4f43e36ec"
    }

查询单个产品

定义描述

path 版本 描述 是否需要cloudToken
/cloud/thing/product/get 1.1.0 查询物的产品

请求参数

参数 类型 必填 描述
productKey String 物的产品key

返回参数

参数 类型 描述
tenantId Long 租户id
productKey String 产品PK
dataFormat String 数据格式
netType String 入网类型
productSecret String 产品密钥
nodeType String 节点类型
domain String 领域
name String 产品名称
region String 地域
ownerDomain String 所有者领域
categoryId Long 归属品类id
accessMethod String 访问方式
status Integer 产品状态
  • 0:开发中
  • 1:已发布
gmtCreate Date 创建时间
gmtModified Date 修改时间
creator String 创建者
modifier String 修改者
productId Long 产品Id
aliyunCommodityCode String 商品码
rbacTenantId String rbac租户Id

示例

  • 请求示例
    {
        "id": 1508232047194,
        "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.1.0"
        },
        "params": {
            "productKey": "a1dfg456ikl"
        },
        "version": "1.0"
    }
                
  • 正常返回示例
    {
        "code": 200,
        "data": {
            "accessMethod": "DATA_DIRECT",
            "gmtModified": 1517217645000,
            "modifier": "5030ala9cd2091d851a80fbdc63b454243668090",
            "productKey": "a1I0TQKlMCW",
            "creator": "5030ala9cd2091d851a80fbdc63b454243668090",
            "productId": 87634,
            "dataFormat": "ALINK_FORMAT",
            "netType": "NET_WIFI",
            "aliyunCommodityCode": "tmp",
            "productSecret": "tfbMocigfRPqPKKj",
            "nodeType": "DEVICE",
            "gmtCreate": 1517208303000,
            "domain": "a1I0TQKlMCW",
            "name": "风扇",
            "tenantId": 3312,
            "region": "cn-shanghai",
            "ownerDomain": "tmp_5030ala9cd2091d851a80fbdc63b454243668090",
            "rbacTenantId": "755ED7C7810B4255BA026BBC48BF0247",
            "categoryId": 285,
            "status": "RELEASE_STATUS"
        },
        "id": "6aad0b12-2192-4b90-8f40-08a2bc0b5c2a"
    }
                

设备量产接口(动态生成设备名称)

定义描述

path 版本 描述 是否需要cloudToken
/cloud/amount/device/generate 1.1.2 云端开放的产品量产接口(云端动态生成设备名称)

请求参数

参数 类型 必填 描述
productKey String 物的产品key
amount Int 量产的设备数量

返回参数

参数 类型 描述
batchId String 量产批次号

示例

  • 请求示例
    {
        "id": "1508232047195",
        "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.1.2"
        },
        "params": {
            "productKey": "a1dfg456ikl",
        "amount":100
        },
        "version": "1.0"
    }
                
  • 正常返回示例
    {
        "code": 200,
        "data": {
            "batchId": "1"
        },
        "id": "1508232047195"
    }
                

设备量产接口(生成批次ID)

定义描述

path 版本 描述 是否需要cloudToken
/cloud/device/name/upload 1.1.2 上传设备名称列表获取批次号
说明 该接口需要用户主动上传要量产设备的名称信息,接口会返回该批量产的批次id(batchId),但是此时还未生成设备证书信息,需要再调用“设备量产接口(生成设备证书)”接口才会真正生成设备证书。

请求参数

参数 类型 必填 描述
productKey String 物的产品key
deviceNames String 指定的设备名称列表,每批不超过1000个

返回参数

参数 类型 描述
batchId String 量产批次号

示例

  • 请求示例
    {
        "id": "1508232047196",
        "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.1.2"
        },
        "params": {
            "productKey": "a1dfg456ikl",
        "deviceNames": "["deviceName1","deviceName2"]"
        },
        "version": "1.0"
    }
                
  • 正常返回示例
    {
        "code": 200,
        "data": {
            "batchId": "1"
        },
        "id": "1508232047195"
    }
                

设备量产接口(生成设备证书)

定义描述

path 版本 描述 是否需要cloudToken
/cloud/name/device/generate 1.1.2 云端开放的产品量产接口(云端动态生成设备名称)
说明 该接口根据批次id(batchId)生成设备证书信息,配合“设备量产接口(生成批次id)”接口使用。

请求参数

参数 类型 必填 描述
productKey String 物的产品key
batchId String 量产的批次号

返回参数

参数 类型 描述
batchId String 量产批次号

示例

  • 请求示例
    {
        "id": "1508232047195",
        "request": {
            "cloudToken": "109049c80bcde4c06b15f6f62e29a3ba",
            "apiVer": "1.1.2"
        },
        "params": {
            "productKey": "a1dfg456ikl",
        "batchId": "1"
        },
        "version": "1.0"
    }
                
  • 正常返回示例
    {
        "code": 200,
        "data": {
            "batchId": "1"
        },
        "id": "1508232047195"
    }