创建产品

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

1. 接口描述

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

本接口(CreateProduct)用于创建一个新的物联网通信产品

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateProduct
Version String 公共参数,本接口取值:2018-06-14
Region String 公共参数,本接口不需要传递此参数。
ProductName String 产品名称,名称不能和已经存在的产品名称重复。命名规则:[a-zA-Z0-9:_-]{1,32}
ProductProperties ProductProperties 产品属性
Skey String 创建CLAA产品时,需要Skey

3. 输出参数

参数名称 类型 描述
ProductName String 产品名称
ProductId String 产品 ID,腾讯云生成全局唯一 ID
ProductProperties ProductProperties 产品属性
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建产品

输入示例

https://iotcloud.tencentcloudapi.com/?Action=CreateProduct
&ProductName=fruit
&ProductProperties.ProductDescription=test
&ProductProperties.EncryptionType=1
&ProductProperties.Region=gz
&ProductProperties.ProductType=0
&ProductProperties.Format=json
&<公共请求参数>

输出示例

{
  "Response": {
    "ProductId": "ABCDE12345",
    "ProductName": "fruit",
    "ProductProperties": {
      "ProductDescription": "test",
      "EncryptionType": 1,
      "Region": "gz",
      "ProductType": 0,
      "Format": "json",
      "Platform": "DEFAULT",
      "Appeui": ""
    },
    "RequestId": "xxxxxxxxxxxxxxxxxxxxxxx"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误
InvalidParameterValue 参数取值错误
InvalidParameterValue.ProductAlreadyExist 创建的产品名已存在。
InvalidParameterValue.ProductTypeNotSupport 产品类型不支持。
LimitExceeded.ProductExceedLimit 超过产品数量限制。
ResourceNotFound.ThingModelNotExist 物模型不存在。