获取产品列表

最近更新时间:2019-07-24 15:21:30

1. 接口描述

接口请求域名: iotcloud.tencentcloudapi.com 。

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

默认接口请求频率限制:100次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeProducts
Version String 公共参数,本接口取值:2018-06-14
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 分页偏移,Offset从0开始
Limit Integer 分页大小,当前页面中显示的最大数量,值范围 10-250。
Filters.N Array of Filter 过滤条件

3. 输出参数

参数名称 类型 描述
TotalCount Integer 产品总数
Products Array of ProductInfo 产品详细信息列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取产品列表

输入示例

https://iotcloud.tencentcloudapi.com/?Action=DescribeProducts
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
  "Response": {
    "Products": [
      {
        "ProductId": "ABCDEF12345",
        "ProductName": "hello",
        "ProductMetadata": {
          "CreationDate": 1529049275
        },
        "ProductProperties": {
          "ProductDescription": "test",
          "EncryptionType": "1",
          "Region": "gz",
          "ProductType": 0,
          "Format": "json"
        }
      }
    ],
    "TotalCount": 1,
    "RequestId": "69f65618-600b-4ac4-b8e3-4528a6819078"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误
InvalidParameterValue 参数取值错误