获取产品列表

最近更新时间:2019-04-30 15:17:22

1. 接口描述

本接口(ListProducts)用于列出产品列表。

接口请求域名:iotcloud.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 必选 类型 描述
pageSize Int 分页大小,当前页面中显示的最大数量,值范围 10-250。
pageNum Int 分页页数,当前页面会返回第 pageNum 页的结果。

3. 输出参数

参数名称 类型 描述
code Int 公共错误码。0 表示成功,其他值表示失败详见 公共错误码 页面
message String 模块错误信息描述,格式为 "(模块错误码)模块错误信息" ,详见本页面的 模块错误码
codeDesc String 模块错误码的英文描述
totalCnt Int 产品总数
products Array 产品对象的数组

产品对象的结构如下:

参数名称 类型 描述
productMetadata Object 包含产品的其他信息,包括产品创建日期时间
productProperties Object 包含有关产品的信息,包括产品描述
productName String 产品名称
productID String 产品 ID

productProperties 部分的结构如下:

参数名称 类型 描述
productDescription String 产品描述
encryptionType String 加密类型
region String 产品所属区域
productType Int 0为普通产品,2为NB-IoT产品

productMetadata 部分的结构如下:

参数名称 类型 描述
creationDate DateTime 创建产品的时间戳

4. 示例

输入

   https://iotcloud.qcloud.com.com/v2/index.php?Action=ListProducts&pageNum=1&pageSize=100
  &<公共请求参数>

输出

{
 "totalCnt": 2,
 "products": [{
   "productMetadata": {
    "creationDate": 1509453755000
   },
   "productProperties": {},
   "productName": "Test_1",
   "productID": "ABCDE12345"
  },
  {
   "productMetadata": {
    "creationDate": 1508913066000
   },
   "productProperties": {
    "productDescription": "1yy"
   },
   "productName": "Test_2",
   "productID": "ABCDE12345"
  }
 ],
 "message": "",
 "codeDesc": "Success",
 "code": 0
}

5. 模块错误码

模块错误码 描述
1003 分页参数非法
1100 内部服务器错误,请联系技术人员
1101 请求参数非法