| 调用QueryProductList接口查看所有产品列表 | 您所在的位置：网站首页 › 中沃所有产品名称 › 调用QueryProductList接口查看所有产品列表 |
|
使用说明
调用本接口时，如果指定页数“CurrentPage”大于查询结果的总页数“PageCount”，返回的“ProductInfo”会为空。此时，您可以根据返回结果总条数“Total”，重新指定“CurrentPage”和“PageSize”，再次调用接口查看产品信息。 例如：假设查询结果共20条，请求参数“PageSize”为5，查询结果总页数“PageCount”会为20÷5=4页，“CurrentPage”设置为1、2、3或4时，“ProductInfo”才会有产品具体信息。如果“CurrentPage”大于4，例如为5，第5页是没有数据的，此时“ProductInfo”就会为空。 返回示例如下： { "RequestId": "62F56B4D-9CBC-518A-8414-CC91BB83FD04", "Data": { "PageCount": 4, "PageSize": 5, "CurrentPage": 5, "Total": 20, "List": { "ProductInfo": [] } }, "Code": "", "Success": true } QPS限制单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。 说明 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。当请求参数CurrentPage与PageSize的值相乘结果大于或等于100000时，会降低调用该接口的QPS。 此时，单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为2。 调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。 请求参数名称 类型 是否必选 示例值 描述 Action String 是 QueryProductList系统规定参数。取值：QueryProductList。 CurrentPage Integer 是 1指定显示返回结果中的第几页。 PageSize Integer 是 2指定返回结果中每页显示的产品数量，最大值是200。 IotInstanceId String 否 iot_instc_pu****_c*-v64********实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。 重要 若有ID值，必须传入该ID值，否则调用会失败。 若无ID值，则无需传入。实例的更多信息，请参见实例概述。 ResourceGroupId String 否 rg-acfmxazb4ph****资源组ID。 重要 目前，物联网平台仅支持实例维度的资源组管理。请求参数ResourceGroupId配置已无效，无需再传入。 AliyunCommodityCode String 否 iothub_senior指定要查看的产品类型，取值： iothub_senior：使用物模型版产品。 iothub：不使用物模型版产品。 说明 如果不传入该参数，则返回所有产品的列表。调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。 返回数据名称 类型 示例值 描述 Code String iot.system.SystemException调用失败时，返回的错误码。更多信息，请参见错误码。 Data Struct调用成功时，返回的产品信息。具体信息请参见以下参数。 CurrentPage Integer 1当前页号。 List Array of ProductInfo产品信息列表。 说明 返回的产品信息按照产品创建时间倒序排列。 ProductInfo AuthType String secret产品下的设备接入物联网平台的认证方式。 secret：使用设备密钥进行设备身份认证。 id2：使用物联网设备身份认证ID²。 x509：使用设备X.509证书进行设备身份认证。 DataFormat Integer 1设备与云端之间的数据通信协议类型。该参数为使用物模型的产品（AliyunCommodityCode=iothub_senior）的特有参数。 取值： 0：透传模式。使用自定义的串口数据格式。该模式下，设备可以上报原始数据（如二进制数据流）。阿里云物联网平台会运行您配置在云端的数据解析脚本，将原始数据转换成Alink JSON标准数据格式。 1：Alink JSON。阿里云物联网平台定义的设备与云端的数据交换协议，采用JSON格式。 Description String This is a test product.产品描述。 DeviceCount Integer 128产品下的设备数量。 GmtCreate Long 1581595942000该产品的创建时间。毫秒值时间戳。 NodeType Integer 0产品的节点类型。该参数为使用物模型的产品（AliyunCommodityCode=iothub_senior）的特有参数。取值： 0：设备。设备不能挂载子设备，可以直连IoT Hub，也可以作为网关的子设备连接IoT Hub。 1：网关。网关可以挂载子设备，具有子设备管理模块，维持子设备的拓扑关系，并且可以将拓扑关系同步到云端。 ProductKey String a1T27vz****产品的ProductKey。创建产品时，物联网平台为该产品颁发的全局唯一标识。 ProductName String 路灯产品名称。 PageCount Integer 92总页数。 PageSize Integer 2每页显示的产品数。 Total Integer 184产品总数。 ErrorMessage String 系统异常调用失败时，返回的出错信息。 RequestId String 4B4ECF2C-6222-42EC-A4B5-C12202E71CEA阿里云为该请求生成的唯一标识符。 Success Boolean true是否调用成功。 true：表示调用成功。 false：表示调用失败。 示例请求示例 https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductList &CurrentPage=1 &PageSize=2 &ResourceGroupId=rg-acfmxazb4ph**** &正常返回示例 XML格式 92 2 1 a1A0D4t**** 0 路灯产品 1 1569233025000 secret 1 a1dEvuQ**** 0 子设备custom 0 1568690432000 secret 1 184 4B4ECF2C-6222-42EC-A4B5-C12202E71CEA trueJSON格式 { "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 } |
| CopyRight 2018-2019 实验室设备网 版权所有 |