调用该接口查看所有产品列表。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:QueryProductList
CurrentPage Integer 指定显示返回结果中的第几页。
PageSize Integer 指定返回结果中每页显示的产品数量,最大值是200
AliyunCommodityCode String

指定要查看的产品类型,取值:

iothub_senior:物联网平台高级版

iothub:物联网平台基础版

说明 如果不传入该参数,则返回所有产品的列表。
IotInstanceId String 公共实例不传此参数;仅独享实例需传入实例ID。
公共请求参数 - 请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 调用失败时,返回的错误码。错误码详情,请参见错误码
Data Data 调用成功时,返回的产品列表。详情参见下表Data。
表 1. Data
名称 类型 描述
PageSize Integer 每页显示的产品数。
PageCount Integer 总页数。
CurrentPage Integer 当前页号。
Total Integer 当前账号下的产品总数。
List List 产品信息列表。请参见下表ProductInfo。
说明 返回的产品信息按照产品创建时间倒序排列。
表 2. ProductInfo
名称 类型 描述
DataFormat Integer

数据格式,指设备与云端之间的数据通信协议类型,取值:

0:透传模式。使用自定义的串口数据格式。该模式下,设备可以上报原始数据(如二进制数据流),阿里云IoT平台会运行您配置在云端的数据解析脚本,将原始数据转换成Alink JSON标准数据格式。

1:Alink JSON。阿里云物联网平台定义的设备与云端的数据交换协议,采用 JSON 格式。

说明 此参数为高级版产品特有参数。
ProductKey String 产品的Key。新建产品时,物联网平台为该产品颁发的全局唯一标识。
NodeType Integer

产品的节点类型,取值:

0:设备。设备不能挂载子设备,可以直连物联网平台,也可以作为网关的子设备连接物联网平台。

1:网关。网关可以挂载子设备,具有子设备管理模块,维持子设备的拓扑关系,并且可以将拓扑关系同步到云端。

ProductName String 产品名称。
DeviceCount Integer 产品下的设备数量。
GmtCreate Long 产品的创建时间。
Description String 产品的描述信息。
AuthType String 产品下的设备接入物联网平台的认证方式。
  • secret:设备密钥
  • id2:ID²
  • x509:X.509证书

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductList
&CurrentPage=1
&PageSize=2
&公共请求参数

返回示例

  • JSON格式
    {
      "Data": {
        "PageCount": 92, 
        "PageSize": 2, 
        "List": {
          "ProductInfo": [
            {
              "DataFormat": 1, 
              "ProductKey": "a1A0D4t****", 
              "NodeType": 0, 
              "ProductName": "路灯产品", 
              "DeviceCount": 1, 
              "GmtCreate": 1569233025000, 
              "AuthType": "secret"
            }, 
            {
              "DataFormat": 1, 
              "ProductKey": "a1dEvuQ****", 
              "NodeType": 0, 
              "ProductName": "子设备custom", 
              "DeviceCount": 0, 
              "GmtCreate": 1568690432000, 
              "AuthType": "secret"
            }
          ]
        }, 
        "CurrentPage": 1, 
        "Total": 184
      }, 
      "RequestId": "4B4ECF2C-6222-42EC-A4B5-C12202E71CEA", 
      "Success": true
    }
  • XML格式
    <?xml version="1.0" encoding="UTF-8"?>
    <QueryProductListResponse>
        <Data>
            <PageCount>92</PageCount>
            <PageSize>2</PageSize>
            <List>
                <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1A0D4t****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>路灯产品</ProductName>
                    <DeviceCount>1</DeviceCount>
                    <GmtCreate>1569233025000</GmtCreate>
                    <AuthType>secret</AuthType>
                </ProductInfo>
                <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1dEvuQ****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>子设备custom</ProductName>
                    <DeviceCount>0</DeviceCount>
                    <GmtCreate>1568690432000</GmtCreate>
                    <AuthType>secret</AuthType>
                </ProductInfo>
            </List>
            <CurrentPage>1</CurrentPage>
            <Total>184</Total>
        </Data>
        <RequestId>4B4ECF2C-6222-42EC-A4B5-C12202E71CEA</RequestId>
        <Success>true</Success>
    </QueryProductListResponse>