API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 智能视图计算平台 > 设备管理相关接口 > 获取设备列表

获取设备列表

最近更新时间：2024-04-22 01:19:06

我的收藏

本页目录：

1. 接口描述

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

用于获取对应组织下的设备列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ListDevices。
Version 是 String 公共参数，本接口取值：2023-05-17。
Region 否 String 公共参数，此参数为可选参数。
OrganizationId 是 String 组织ID
示例值：123
IsContainSubLevel 否 Boolean 是否获取当前层级及子层级的设备列表，默认false
示例值：false
IsContainUser 否 Boolean 是否包含当前用户已关联的设备，默认false
示例值：false
AccessProtocol 否 Integer 设备接入协议。1:RTMP，2:GB，3:GW，4:IVCP(私有协议)
示例值：2
Type 否 Integer 设备类型。1:IPC，2:NVR
示例值：2
Status 否 Integer 设备状态。0:未注册，1:在线，2:离线，3:禁用
示例值：1
ClusterId 否 String 服务节点ID
示例值：b2181417-03ce-4ea3-ae39-****
Keyword 否 String 模糊搜索设备的关键字
示例值：设备1
CurrentUin 否 Integer 当前用户Uin
示例值：123456789
PageNumber 否 Integer 页码，默认为1。
示例值：1
PageSize 否 Integer 每页数量，默认为20。
示例值：20

3. 输出参数

参数名称 类型 描述
Data Array of ListDeviceInfo 设备列表详情
注意：此字段可能返回 null，表示取不到有效值。
TotalCount Integer 设备总数
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 失败示例

无效的设备接入协议

输入示例

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

{
    "OrganizationId": "191",
    "AccessProtocol": 4
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameterValue.InvalidAccessProtocol",
            "Message": "无效的设备接入协议"
        },
        "RequestId": "cb4884f8-f00e-4e2f-a867-49a4d805960f"
    }
}

示例2 成功示例

无

输入示例

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

{
    "OrganizationId": "191"
}

输出示例

{
    "Response": {
        "Data": [
            {
                "AccessProtocol": 2,
                "ChannelNum": 1,
                "ClusterId": "4************************0",
                "ClusterName": "上海一区",
                "Code": "6************************4",
                "Description": "",
                "DeviceId": "2************************8",
                "Name": "gb12138",
                "OrganizationId": "191",
                "Password": "123456",
                "Status": 2,
                "TransportProtocol": 1,
                "Type": 2
            }
        ],
        "RequestId": "d217472e-ca9b-4a4d-bb4b-c45326ce8e3e",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InvalidParameterValue.InvalidAccessProtocol 无效的设备接入协议
InvalidParameterValue.InvalidDeviceStatus 无效的设备状态
InvalidParameterValue.InvalidDeviceType 无效的设备类型
InvalidParameterValue.InvalidOrganizationId 无效的组织ID
InvalidParameterValue.InvalidPageNumber 无效的PageNumber
InvalidParameterValue.InvalidPageSize 无效的PageSize
中国站