1. 接口描述
接口请求域名： iecp.tencentcloudapi.com 。
获取设备信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeIotDevice。 |
| Version | 是 | String | 公共参数，本接口取值：2021-09-14。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| DeviceId | 否 | Integer | 设备id，传0值表示此参数无效 示例值：100012 |
| ProductID | 否 | String | 无 |
| DeviceName | 否 | String | 无 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 设备id 示例值：100021 |
| Name | String | 设备名称 示例值：xxx |
| Version | String | 版本号 示例值：1.1.2 |
| Cert | String | ssl证书 示例值：xxx |
| PrivateKey | String | ssl私钥 示例值：xxx |
| Psk | String | psk认证密钥 示例值：xxx |
| Disabled | Boolean | 设备是否打开 示例值：xxx |
| LogSetting | Integer | 设备日志 示例值：1 |
| LogLevel | Integer | 设备日志级别 示例值：1 |
| UserName | String | mqtt参数 示例值：xxx |
| Password | String | mqtt参数 示例值：xxx |
| ClientID | String | mqtt参数 示例值：xxx |
| PskHex | String | 16进制的psk格式 示例值：xxx |
| Description | String | 描述 示例值：xxx |
| Status | Integer | 设备在线状态 示例值：1 |
| Region | String | 无 |
| UnitID | Integer | 无 |
| UnitName | String | 无 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeIotDevice
输入示例
POST / HTTP/1.1
Host: iecp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIotDevice
<公共请求参数>
{
"DeviceId": 100049
}输出示例
{
"Response": {
"UserName": "SA4RZ3NLIMlink01;21010406;MPWMB;1965121722",
"Psk": "TTM5RjJCRTdSQUxOQkk3SA==",
"Version": "",
"Name": "link01",
"UnitName": "ccccx",
"LogLevel": 1,
"Region": "ap-guangzhou",
"PrivateKey": "",
"ClientID": "SA4RZ3NLIMlink01",
"Status": 1,
"Disabled": true,
"Cert": "",
"PskHex": "4d3339463242453752414c4e42493748",
"LogSetting": 1,
"RequestId": "50f25270-9083-4e99-ae16-3ebd172bf89c",
"UnitID": 0,
"Password": "2dace9889aaa987ba1975d76b90eaed5cfa28d3d7337c83df56028d76e0359ba;hmacsha256",
"Id": 100049,
"Description": "测试"
}
}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签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.DBError | 数据库异常。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.DuplicateName | 名字冲突。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |