1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
本接口(DescribeDeviceModel)用于获取设备物模型。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDeviceModel。 |
Version | 是 | String | 公共参数,本接口取值:2019-11-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Tid | 是 | String | 设备TID |
Branch | 否 | String | 物模型的分支路径 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | DeviceModelData | 设备物模型信息 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取设备物模型
输入示例
https://iotvideo.tencentcloudapi.com/?Action=DescribeDeviceModel
&Tid=********
&Branch=****
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "fcf53f95-9887-4f26-b0cf-2df2c463b06d",
"Data": {
"Tid": "xxxx",
"Branch": "",
"IotModel": "{\"Action\":{\"_otaVersion\":{\"ctlVal\":\"\",\"origin\":\"\",\"t\":0},\"_otaUpgrade\":{\"ctlVal\":0,\"origin\":\"\",\"t\":0},\"cameraOn\":{\"ctlVal\":0,\"origin\":\"\",\"t\":0},\"takePhoto\":{\"ctlVal\":0,\"origin\":\"\",\"t\":0},\"shootVideo\":{\"ctlVal\":0,\"origin\":\"\",\"t\":0},\"presetPosition\":{\"ctlVal\":0,\"origin\":\"\",\"t\":0}},\"ProConst\":{\"_productInfo\":{\"productModel\":\"\",\"productID\":\"12345\",\"funcCode\":1,\"revision\":1,\"revisionUtc\":1},\"_versionInfo\":{\"sdkVer\":0,\"swVer\":2019,\"hwVer\":2019}},\"ProWritable\":{\"_otaMode\":{\"setVal\":0,\"t\":0},\"_logLevel\":{\"setVal\":2,\"t\":1581993565},\"_cloudStoage\":{\"setVal\":{\"serviceType\":0,\"utcExpire\":0,\"pause\":0,\"serviceParm\":\"\"},\"t\":0},\"recodePlan\":{\"setVal\":{\"timeSection1\":{\"desc\":\"\",\"enable\":0,\"dayOfWeek\":0,\"begin\":0,\"end\":0},\"timeSection2\":{\"desc\":\"\",\"enable\":0,\"dayOfWeek\":0,\"begin\":0,\"end\":0},\"timeSection3\":{\"desc\":\"\",\"enable\":0,\"dayOfWeek\":0,\"begin\":0,\"end\":0},\"timeSection4\":{\"desc\":\"\",\"enable\":0,\"dayOfWeek\":0,\"begin\":0,\"end\":0},\"timeSection5\":{\"desc\":\"\",\"enable\":0,\"dayOfWeek\":0,\"begin\":0,\"end\":0},\"timeSection6\":{\"desc\":\"\",\"enable\":0,\"dayOfWeek\":0,\"begin\":0,\"end\":0},\"timeSection7\":{\"desc\":\"\",\"enable\":0,\"dayOfWeek\":0,\"begin\":0,\"end\":0},\"timeSection8\":{\"desc\":\"\",\"enable\":0,\"dayOfWeek\":0,\"begin\":0,\"end\":0}},\"t\":0},\"presetPosSetting\":{\"setVal\":{\"pos1\":{\"x\":101,\"y\":13},\"pos2\":{\"x\":100,\"y\":200},\"pos3\":{\"x\":10,\"y\":0},\"pos4\":{\"x\":122,\"y\":123},\"pos5\":{\"x\":0,\"y\":0},\"pos6\":{\"x\":0,\"y\":0}},\"t\":1582168513}},\"ProReadonly\":{\"_online\":{\"stVal\":1,\"t\":1581926411},\"_otaVersion\":{\"stVal\":\"\",\"t\":0},\"_otaUpgrade\":{\"stVal\":0,\"t\":0},\"cameraOn\":{\"stVal\":0,\"t\":0},\"takePhoto\":{\"stVal\":0,\"t\":0},\"shootVideo\":{\"stVal\":0,\"t\":0},\"presetPosition\":{\"stVal\":0,\"t\":0},\"test\":{\"stVal\":{\"attr1\":0,\"attr2\":\"\",\"attr3\":{\"attr3_1\":0,\"attr3_2\":0},\"attr4\":{\"attr4_1\":0,\"attr4_2\":\"\",\"attr4_3\":{\"attr4_3_1\":0,\"attr4_3_2\":0}}},\"t\":0}}}"
}
}
}
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 | 操作不支持。 |