1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
本接口(CreateProduct)用于创建一个新的物联网智能视频产品。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateProduct。 |
Version | 是 | String | 公共参数,本接口取值:2019-11-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProductModel | 是 | String | 产器型号(APP产品,为APP包名) |
ProductName | 是 | String | 产品名称 仅支持中文、英文、数字、下划线,不超过32个字符 |
ProductDescription | 是 | String | 产品描述信息 不支持单引号、双引号、退格符、回车符、换行符、制表符、反斜杠、下划线、“%”、“#”、“$”,不超过128字符 |
Features.N | 否 | Array of String | 设备功能码(ypsxth:音频双向通话 ,spdxth:视频单向通话) |
ChipManufactureId | 否 | String | 主芯片产商ID |
ChipId | 否 | String | 主芯片ID |
ProductRegion | 否 | String | 地域: China-Mainland(中国大陆) China-Hong Kong, Macao and Taiwan(港澳台地区) America(美国) Europe(欧洲) India(印度) Other-Overseas(其他境外地区) |
ProductCate | 否 | Integer | 设备类型, 0-普通视频设备,1-NVR设备 |
AccessMode | 否 | Integer | 接入模型,bit0是0:公版小程序未接入,bit0是1:公版小程序已接入 |
Os | 否 | String | Linux,Android,Liteos等系统 |
ChipArch | 否 | String | 芯片架构,只是针对操作系统为android的 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | ProductBase | 产品详细信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建产品
输入示例
https://iotvideo.tencentcloudapi.com/?Action=CreateProduct
&ProductModel=test
&ProductName=TEST_001
&ProductDescription=TestProduct
&Features.0=spdxth
&Features.1=ypsxth
&<公共请求参数>
输出示例
{
"Response": {
"Data": {
"ProductRegion": "xx",
"ProductDescription": "xx",
"ProductModel": "xx",
"ProductName": "xx",
"SecretKey": "xx",
"FuncCode": [
"xx"
],
"IotModelRevision": 1,
"ProductCate": 0,
"CreateTime": 1,
"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。
- 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.SignatureFailure | 签名校验失败。 |
AuthFailure.TokenFailure | 获取token为空。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
FailedOperation.PermissionDenied | 无相关操作权限。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Tid | tid非法。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |