QueryProductList查询所有产品列表_云市场(Marketplace)-阿里云帮助中心

QueryProductList

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

请求参数

名称

类型

是否必选

示例值

描述

Action

String

是

QueryProductList

系统规定参数。取值：QueryProductList。

CurrentPage

Integer

是

指定显示返回结果中的第几页。

PageSize

Integer

是

指定返回结果中每页显示的产品数量，最大值是200。

重要

‼️ 注意：调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数。

返回数据

名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
Data	Struct		调用成功时，返回的产品信息。具体信息请参见以下参数。
CurrentPage	Integer	1	当前页号。
List	Array of ProductInfo		产品信息列表。
ProductInfo
AuthType	String	secret	产品下的设备接入物联网平台的认证方式。 secret：使用设备密钥进行设备身份认证。
DataFormat	Integer	1	设备与云端之间的数据通信协议类型。取值： 0：透传模式。使用自定义的串口数据格式。该模式下，设备可以上报原始数据（如二进制数据流）。物联网平台会运行您配置在云端的数据解析脚本，将原始数据转换成JSON标准数据格式。 1：JSON。阿里云物联网平台定义的设备与云端的数据交换协议，采用JSON格式。
Description	String	This is a test product.	产品描述。
DeviceCount	Integer	128	产品下的设备数量。
GmtCreate	Long	1581595942000	该产品的创建时间。毫秒值时间戳。
NodeType	Integer	0	产品的节点类型。取值： 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：表示调用失败。

示例

请求示例

curl 'https://si-d6e8d812acb848958054.tuyacloud.com:8686/?Action=QueryProductList&SignatureNonce=f91f4105bdb8450ca3d026f445d799af&PageSize=1&CurrentPage=1&AccessKeyId=xMr9wgwXQLhv5AUa65o0****&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T08%3A01%3A00Z&ProductKey=k1ymv1DuLfE&Signature=t%2FQvoavYWiHcj0aBKf9ffeQ9lk4%3D'

正常返回示例

{
    "Data": {
        "PageCount": 21,
        "PageSize": 1,
        "List": {
            "ProductInfo": [
                {
                    "AuthType": "secret",
                    "DataFormat": 1,
                    "Description": "",
                    "DeviceCount": 1,
                    "NodeType": 0,
                    "ProductKey": "xZluAsUunlbuhDdG",
                    "ProductName": "灯泡测试",
                    "GmtCreate": 1731910332416
                }
            ]
        },
        "CurrentPage": 1,
        "Total": 21
    },
    "RequestId": "6c12e6c4-34e4-4245-a4b1-0fbd4b369d07",
    "Code": "",
    "Success": true
}