有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateStudioProduct。
Version String 公共参数,本接口取值:2019-04-23。
Region String 公共参数,详见产品支持的 地域列表
ProductName String 产品名称,名称不能和已经存在的产品名称重复。命名规则:[a-zA-Z0-9:_-]{1,32}
示例值:name
CategoryId Integer 产品分组模板ID , ( 自定义模板填写1 , 控制台调用会使用预置的其他ID)
示例值:10
ProductType Integer 产品类型 填写 ( 0 普通产品 , 5 网关产品)
示例值:0
EncryptionType String 加密类型 ,1表示证书认证,2表示秘钥认证,21表示TID认证-SE方式,22表示TID认证-软加固方式
示例值:1
NetType String 连接类型 可以填写 wifi、wifi-ble、cellular、5g、lorawan、ble、ethernet、wifi-ethernet、else、sub_zigbee、sub_ble、sub_433mhz、sub_else、sub_blemesh
示例值:wifi
DataProtocol Integer 数据协议 (1 使用物模型 2 为自定义)
示例值:1
ProductDesc String 产品描述
示例值:desc
ProjectId String 产品的项目ID
示例值:prj-zunfat46

3. 输出参数

参数名称 类型 描述
Product ProductEntry 产品描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新建产品

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateStudioProduct
<公共请求参数>

{
    "EncryptionType": "1",
    "DataProtocol": "1",
    "ProjectId": "prj-zunfat46",
    "ProductName": "name",
    "ProductDesc": "desc",
    "NetType": "wifi",
    "ProductType": "0",
    "CategoryId": "10"
}

输出示例

{
    "Response": {
        "Product": {
            "DevStatus": "xx",
            "EncryptionType": "xx",
            "DataProtocol": 1,
            "ProjectId": "xx",
            "Region": "xx",
            "ModuleId": 0,
            "EnableProductScript": "xx",
            "UpdateTime": 1,
            "ProductName": "xx",
            "CreateUserId": 0,
            "ProductDesc": "xx",
            "NetType": "xx",
            "ProductType": 0,
            "CreatorNickName": "xx",
            "CreateTime": 1,
            "BindStrategy": 0,
            "CategoryId": 10,
            "ProductId": "xx"
        },
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.DBOpertaionError DB操作错误。
InternalError.InternalRPCError 内部RPC错误。
InternalError.InternalServerExceptionDB 内部DB错误。
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.ProductExceedLimit 超过产品数量限制。
LimitExceeded.StudioProductExceedLimit 产品数量超出限制。
LimitExceeded.ThingModelExceedLimit 物模型超出限制。
MissingParameter.ModelDefineEventTypeError 物模型事件 Type 错误。
ResourceNotFound.InstanceNotExist 实例未创建或是已删除。
ResourceNotFound.ProjectNotExist 项目不存在。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoPermissionToProject 项目ACL错误。
UnauthorizedOperation.NoPermissionToStudioProduct 产品ACL错误。
UnsupportedOperation.DevicesExistUnderProduct 产品下还存在未删除的设备。
UnsupportedOperation.InstanceIsolated 由于实例到期已被禁用,请续费后使用。
UnsupportedOperation.ProductDupKeyExist 存在重复产品。
UnsupportedOperation.ProductExistUnderProject 项目下有产品。