批量查询设备详情

最近更新时间:2025-08-20 01:57:47

我的收藏

1. 接口描述

接口请求域名: iss.tencentcloudapi.com 。

用于批量查询设备详细信息。

默认接口请求频率限制:5次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUserDeviceList。
Version String 公共参数,本接口取值:2023-05-17。
Region String 公共参数,此参数为可选参数。
DeviceIds.N Array of String 设备Id列表
示例值:["cf40269b-324b-464b-b2aa-****","9e05af80-edbd-4115-a706-****"]

3. 输出参数

参数名称 类型 描述
Data DescribeDeviceListData 返回结果
示例值:
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功

输入示例

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

{
    "DeviceIds": [
        "da238a8c-****-4a5b-****-************"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "423da921-fd90-4b07-a1a4-a17b8df24e37",
        "Data": {
            "List": [
                {
                    "DeviceId": "da238a8c-****-4a5b-****-************",
                    "Name": "rxxxxx2710",
                    "Code": "xxxxx",
                    "Status": 0,
                    "Region": "ap-shanghai",
                    "Type": 1,
                    "TransportProtocol": 0,
                    "AccessProtocol": 1,
                    "OrganizationId": "1",
                    "Manufacturer": "",
                    "Description": "",
                    "ClusterId": "41xxxxxxxad-4c16-xxx-dxxx3axxxxx90",
                    "ClusterName": "xxxx区",
                    "SipId": "",
                    "SipDomain": "",
                    "SipIp": "",
                    "SipPort": 0,
                    "Password": "",
                    "PushStreamUrl": "",
                    "GatewayId": "",
                    "GatewayName": "",
                    "ProtocolType": 0,
                    "ProtocolTypeName": "",
                    "Ip": "",
                    "Port": 0,
                    "Username": "",
                    "AudioSwitch": 1,
                    "SubscribeSwitch": 0,
                    "AppName": "tesxxxxxx",
                    "StreamName": "testsxxxxx",
                    "SilentFrameSwitch": 0
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InvalidParameter 无效的输入参数
LimitExceeded.DeiceIdQuantityExceededLimit 查询的设备数量不能超过200个