新建产品

最近更新时间:2019-12-05 19:43:27

1. 接口描述

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

为用户提供新建产品的能力,用于管理用户的设备

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateStudioProduct
Version String 公共参数,本接口取值:2019-04-23
Region String 公共参数,详见产品支持的 地域列表
ProductName String 产品名称,名称不能和已经存在的产品名称重复。命名规则:[a-zA-Z0-9:_-]{1,32}
CategoryId Integer 产品分组模板ID , ( 自定义模板填写1 , 控制台调用会使用预置的其他ID)
ProductType Integer 产品类型 填写 ( 0 普通产品 )
EncryptionType String 加密类型 加密类型,1表示证书认证,2表示签名认证。
NetType String 连接类型 可以填写 wifi cellular else
DataProtocol Integer 数据协议 (1 使用物模型)
ProductDesc String 产品描述
ProjectId String 产品的项目ID

3. 输出参数

参数名称 类型 描述
Product ProductEntry 产品描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新建产品

输入示例

https://iotcloud.tencentcloudapi.com/?Action=CreateStudioProduct
&ProductName=name
&CategoryId=10
&ProductType=0
&EncryptionType=1
&NetType=wifi
&DataProtocol=1
&ProductDesc=desc
&ProjectId=proj
&<公共请求参数>

&<公共请求参数>

输出示例

{
  "Response": {
    "Product": {
      "ProductId": "ROF2GLJ5FS",
      "ProductName": "name",
      "CategoryId": 10,
      "ProductType": 0,
      "EncryptionType": "1",
      "NetType": "wifi",
      "DataProtocol": 1,
      "ProductDesc": "desc",
      "ProjectId": "",
      "DevStatus": "dev",
      "CreateTime": 1557460361,
      "UpdateTime": 1557460361,
      "Region": "gz",
      "ModuleId": 0
    },
    "RequestId": "ef8a00e2-4166-4336-aa69-a2b5156d471f"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.DBOpertaionError DB操作错误。
InternalError.InternalRPCError 内部RPC错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ModelDefineNil 物模型为空。
InvalidParameterValue.ModelDefinePropBoolMappingError 物模型事件/属性 BOOL类型 Mapping 定义错误。
InvalidParameterValue.ModelDefinePropEnumMappingError 物模型事件/属性 Enum类型 Mapping 定义错误。
InvalidParameterValue.ModelDefinePropRangeError 物模型事件/属性 Min/Max 定义错误。
InvalidParameterValue.ModelDefinePropRangeOverflow 物模型事件/属性 Min/Max 范围超限。
InvalidParameterValue.ProductAlreadyExist 创建的产品名已存在。
InvalidParameterValue.ProductIDInvalid 产品ID非法。
InvalidParameterValue.ProductParmsError 产品参数错误。
InvalidParameterValue.ProjectParmsError 项目参数错误。
InvalidParameterValue.UserIDInvalid 用户ID非法。
LimitExceeded.StudioProductExceedLimit 产品数量超出限制。
LimitExceeded.ThingModelExceedLimit 物模型超出限制。
MissingParameter.ModelDefineEventTypeError 物模型事件 Type 错误。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoPermissionToStudioProduct 产品ACL错误。
UnsupportedOperation.DevicesExistUnderProduct 产品下还存在未删除的设备。
UnsupportedOperation.ProductDupKeyExist 存在重复产品。
UnsupportedOperation.ProductExistUnderProject 项目下有产品。