1. 接口描述
接口请求域名: iotcloud.tencentcloudapi.com 。
本接口(CreateProduct)用于创建一个新的物联网通信产品
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateProduct。 |
Version | 是 | String | 公共参数,本接口取值:2021-04-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProductName | 是 | String | 产品名称,名称不能和已经存在的产品名称重复。命名规则:[a-zA-Z0-9:_-]{1,32} 示例值:dev-01 |
ProductProperties | 否 | ProductProperties | 产品属性 |
Skey | 否 | String | 创建CLAA产品时,需要Skey 示例值:adferdfwe |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ProductName | String | 产品名称 示例值:dev-01 |
ProductId | String | 产品 ID,腾讯云生成全局唯一 ID 示例值:EQPOKD5111 |
ProductProperties | ProductProperties | 产品属性 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建产品
输入示例
https://iotcloud.tencentcloudapi.com/?Action=CreateProduct
&ProductName=dev-01
&ProductProperties.ProductDescription=adfsdd13
&ProductProperties.EncryptionType=1
&ProductProperties.Region=gz
&ProductProperties.ProductType=1
&ProductProperties.Format=json
&<公共请求参数>
输出示例
{
"Response": {
"ProductId": "UTY5QRLMQY",
"ProductName": "dev02",
"ProductProperties": {
"AppEUI": "",
"DeviceLimit": 0,
"EncryptionType": "1",
"ForbiddenStatus": 0,
"Format": "json",
"ModelId": "-1",
"ModelName": "",
"OriginProductId": "",
"OriginUserId": 0,
"Platform": "EQPOKD5111",
"PrivateCAName": "",
"ProductDescription": "",
"ProductKey": "",
"ProductSecret": "",
"ProductType": 0,
"Region": "",
"RegisterLimit": 10000,
"RegisterType": 0
},
"RequestId": "5186e731-d43c-43ef-956c-12ff9b0ce8f2"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.AccountIsolated | 操作失败,账号已欠费隔离。 |
InternalError | 内部错误。 |
InternalError.DBOperationError | 数据库内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.ProductAlreadyExist | 创建的产品名已存在。 |
InvalidParameterValue.ProductTypeNotSupport | 产品类型不支持。 |
InvalidParameterValue.TidProductAlreadyExist | 该TID产品已存在。 |
LimitExceeded.ProductExceedLimit | 超过产品数量限制。 |
ResourceNotFound.ThingModelNotExist | 物模型不存在。 |
UnauthorizedOperation.UserNotAuthenticaed | 用户未通过实名认证。 |