AI 助理
备案控制台
文档
输入文档关键字查找
首页 视图计算 开发参考 API参考 API目录 设备管理 DescribeDevices - 查询设备列表

DescribeDevices - 查询设备列表

更新时间：
产品详情
我的收藏

查询设备列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
vs:DescribeDevicesget
  • 全部资源
    *
    无
无

请求参数

名称类型必填描述示例值
Idstring否

设备 ID。

说明 支持多个，用英文逗号（,）分隔。
348*****380-cn-qingdao
Namestring否

设备名称。

说明 支持多个，用英文逗号（,）分隔。
摄像头A
Typestring否

按设备类型查询。取值范围：

  • ipc（摄像头）
  • platform（平台）
  • ied（智能设备）
ipc
GroupIdstring否

按设备所属空间 ID 查询。

348*****174-cn-qingdao
ParentIdstring否

按设备所属上级设备 ID 查询。

399*****774-cn-qingdao
DirectoryIdstring否

按设备所属目录 ID 查询。

399*****488-cn-qingdao
GbIdstring否

按设备国标 ID 查询。

310000000****0000002
Dsnstring否

设备序列号，唯一标识。

7D0*****4C0
Statusstring否

按设备状态查询。

on
Vendorstring否

按设备厂商查询。

8yd*****qem
SortBystring否

按给定字段排序。取值：

说明 id（默认）
id
SortDirectionstring否

排序方式。取值范围：

  • asc（升序）（默认）
  • desc（降序）
asc
PageSizelong否

分页大小，默认值：20。

20
PageNumlong否

第几个分页，默认值：1。

1
IncludeStatsboolean否

是否返回流统计信息，默认值：false。

false
IncludeDirectoryboolean否

是否返回目录信息，默认值：false。

false

返回参数

名称类型描述示例值
object
PageNumlong

第几个分页。

1
PageSizelong

分页大小。

20
RequestIdstring

请求 ID。

BEA5625F-8FCF-48F4-851B-CA63946DA664
TotalCountlong

设备总数。

77
PageCountlong

分页总数。

5
Devicesarray<object>

设备列表。

Deviceobject
Typestring

设备类型。取值范围：

  • ipc（摄像头）
  • platform（平台）
  • ied（智能设备）
ipc
Statusstring

设备状态。取值范围：

  • on（在线）
  • off（离线）
  • failed（锁定）
  • new（未注册）
on
AlarmMethodstring

订阅的国标报警方式。取值范围：

  • 0（全部）
  • 5（视频报警）
  • 7（其他报警）
说明
  • 空值表示不订阅。
  • 支持多个，用英文逗号（,）分隔。
    •
    		0
    Dsnstring

    设备序列号。

    说明 仅适用于 AUVSP、ODCAP 协议。
    		7D0*****4C0
    Portlong

    设备端口。

    		8080
    PosIntervallong

    位置订阅周期，单位：秒。

    		300
    AutoDirectoryboolean

    是否启用平台设备的目录上报。

    		true
    ParentIdstring

    上级设备 ID，比如：摄像头所属的平台 ID。

    		3238848****092995
    Passwordstring

    设备密码。

    		admin
    AutoPosboolean

    是否启用设备位置订阅。

    		false
    Paramsstring

    设备其他参数。

    		{}
    Descriptionstring

    设备描述。

    		xxx路口摄像头
    Enabledboolean

    是否启用设备。

    		true
    Namestring

    设备名称。

    		xxx路口摄像头
    ChannelSyncTimestring

    通道同步时间。

    		2019-02-28T17:01:17Z
    CreatedTimestring

    设备创建时间。

    		2019-02-28T17:00:17Z
    DirectoryIdstring

    目录 ID。

    		399*****488-cn-qingdao
    RegisteredTimestring

    设备注册时间。

    		2019-02-28T17:00:17Z
    Protocolstring

    设备协议。

    		gb28181
    Ipstring

    设备 IP。

    		10.10.10.10
    Urlstring

    设备上的流 URL。

    		rtmp://xxx/xxx
    AutoStartboolean

    是否自动启动流。

    		false
    Vendorstring

    设备厂商。

    		公司A
    GbIdstring

    设备国标 ID。

    说明 仅适用于国标协议。
    		310000000****0000002
    GroupIdstring

    设备所属空间 ID。

    		348*****174-cn-qingdao
    Longitudestring

    设备经度。

    		45.00
    Latitudestring

    设备维度。

    		119.20
    Idstring

    设备 ID。

    		348*****380-cn-qingdao
    Usernamestring

    设备用户名。

    		admin
    Statsobject

    设备流统计信息。

    FailedNumlong

    失败流数量。

    		0
    StreamNumlong

    流数量。

    		0
    ChannelNumlong

    通道数量。

    		0
    OnlineNumlong

    在线流数量。

    		0
    OfflineNumlong

    离线流数量。

    		0
    Directoryobject

    目录信息。

    ParentIdstring

    上级目录 ID。

    		399*****774-cn-qingdao
    Descriptionstring

    目录描述。

    		目录1
    GroupIdstring

    目录所属空间 ID。

    		348*****174-cn-qingdao
    Namestring

    目录名称。

    		目录1
    CreatedTimestring

    目录创建时间。

    		2019-02-28T17:00:17Z
    Idstring

    目录 ID。

    		399*****488-cn-qingdao

    示例

    正常返回示例

    JSON格式

    {
  "PageNum": 1,
  "PageSize": 20,
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "TotalCount": 77,
  "PageCount": 5,
  "Devices": [
    {
      "Type": "ipc",
      "Status": "on",
      "AlarmMethod": "0",
      "Dsn": "7D0*****4C0",
      "Port": 8080,
      "PosInterval": 300,
      "AutoDirectory": true,
      "ParentId": "3238848****092995",
      "Password": "admin",
      "AutoPos": false,
      "Params": "{}",
      "Description": "xxx路口摄像头",
      "Enabled": true,
      "Name": "xxx路口摄像头",
      "ChannelSyncTime": "2019-02-28T17:01:17Z",
      "CreatedTime": "2019-02-28T17:00:17Z",
      "DirectoryId": "399*****488-cn-qingdao",
      "RegisteredTime": "2019-02-28T17:00:17Z",
      "Protocol": "gb28181",
      "Ip": "10.10.10.10",
      "Url": "rtmp://xxx/xxx",
      "AutoStart": false,
      "Vendor": "公司A",
      "GbId": "310000000****0000002",
      "GroupId": "348*****174-cn-qingdao",
      "Longitude": "45.00",
      "Latitude": "119.20",
      "Id": "348*****380-cn-qingdao",
      "Username": "admin",
      "Stats": {
        "FailedNum": 0,
        "StreamNum": 0,
        "ChannelNum": 0,
        "OnlineNum": 0,
        "OfflineNum": 0
      },
      "Directory": {
        "ParentId": "399*****774-cn-qingdao",
        "Description": "目录1",
        "GroupId": "348*****174-cn-qingdao",
        "Name": "目录1",
        "CreatedTime": "2019-02-28T17:00:17Z",
        "Id": "399*****488-cn-qingdao"
      }
    }
  ]
}

    错误码

    访问错误中心查看更多错误码。
    上一篇：DescribeDevice - 查询设备下一篇：SyncCatalogs - 同步平台通道
    文档推荐