1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
创建产品
默认接口请求频率限制:5000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateProduct。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProductName | 是 | String | 产品名称 示例值:test |
DeviceType | 是 | Integer | 产品设备类型 1.普通设备 2.NVR设备 示例值:1 |
ProductVaildYears | 是 | Integer | 产品有效期 示例值:1 |
Features.N | 是 | Array of String | 设备功能码 ypsxth音频双向通话 spdxth视频单向通话 sxysp双向音视频 注意:此字段只支持创建'摄像头'和'儿童手表',摄像头传["ypsxth","spdxth"],儿童手表传["ypsxth","spdxth","sxysp"],创建其它品类的产品需要传递CategoryId字段,通过云api调用此接口时,如果传了CategoryId字段,将忽略Features字段,但Features仍需传值(可传任意字符串数组) |
ChipManufactureId | 是 | String | 芯片厂商id,通用设备填default 示例值:x86 |
ChipId | 是 | String | 芯片id,通用设备填default 示例值:chip1 |
ProductDescription | 是 | String | 产品描述信息 示例值:test |
ChipOs | 是 | String | 设备操作系统,通用设备填default 示例值:linux |
EncryptionType | 否 | Integer | 认证方式 只支持取值为2 psk认证 示例值:2 |
CategoryId | 否 | Integer | 产品品类id,113:摄像头,567:儿童手表,595:可视对讲门锁 注意:通过云api调用此接口时,如果传了CategoryId字段,将忽略Features字段,但Features仍需传值(可传任意字符串数组) 示例值:113 |
NetType | 否 | String | 连接类型,wifi表示WIFI连接,cellular表示4G连接 示例值:wifi |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | VideoProduct | 产品详情 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建产品
输入示例
POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateProduct
<公共请求参数>
{
"ProductVaildYears": "5",
"ProductDescription": "binky_test",
"EncryptionType": "2",
"ChipId": "default",
"ProductName": "test_lock6",
"DeviceType": "1",
"NetType": "cellular",
"ChipManufactureId": "default",
"ChipOs": "default",
"CategoryId": "595",
"Features": [
"xxx"
]
}
输出示例
{
"Response": {
"Data": {
"ProductId": "L5N2BC8Q04",
"ProductName": "test_lock6",
"DeviceType": 1,
"ProductVaildYears": 5,
"EncryptionType": 2,
"Features": [
"unused"
],
"CategoryId": 595,
"ChipOs": "default",
"ChipManufactureId": "default",
"ChipId": "default",
"ProductDescription": "binky_test",
"NetType": "cellular",
"CreateTime": 1661152125,
"UpdateTime": 1661152125
},
"RequestId": "210e261e-5ab9-4b47-bfdf-68c63fb26a20"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
UnsupportedOperation | 操作不支持。 |