API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 实时互动-工业能源版 > 设备相关接口 > 查询设备信息

查询设备信息

最近更新时间：2024-03-12 01:58:56

我的收藏

本页目录：

1. 接口描述

接口请求域名： trro.tencentcloudapi.com 。

用于获取指定设备信息

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDeviceInfo。
Version 是 String 公共参数，本接口取值：2022-03-25。
Region 否 String 公共参数，本接口不需要传递此参数。
ProjectId 是 String 目标设备所属项目ID
示例值：f3glr49ry0i0xlm7
DeviceId 是 String 目标设备ID
示例值：dev1

3. 输出参数

参数名称 类型 描述
DeviceName String 设备名称
示例值：test device1
DeviceType String 设备类型，field为现场设备（被控方），remote为远端设备（操控方）
示例值：field
DeviceStatus String 设备状态，offline为离线，ready为在线准备，connected为会话中
示例值：offline
LastReportTime Timestamp ISO8601 设备状态最后更新时间
示例值：2022-03-12T09:20:20+08:00
ModifyTime Timestamp ISO8601 设备信息最后修改时间
示例值：2022-03-12T08:20:20+08:00
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备信息示例

输入示例

POST / HTTP/1.1
Host: trro.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceInfo
<公共请求参数>

{
    "ProjectId": "f3glr49ry0i0xlm7",
    "DeviceId": "test1"
}

输出示例

{
    "Response": {
        "DeviceName": "test device1",
        "LastReportTime": "2022-03-22T09:00:00+08:00",
        "DeviceStatus": "offline",
        "DeviceType": "field",
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
        "ModifyTime": "2022-03-22T08:00:00+08:00"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
中国站