调用DescribeDevices查询设备列表_视图计算(VECS)-阿里云帮助中心

查询设备列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Id	string	否	设备 ID。说明支持多个，用英文逗号（,）分隔。	348*****380-cn-qingdao
Name	string	否	设备名称。说明支持多个，用英文逗号（,）分隔。	摄像头A
Type	string	否	按设备类型查询。取值范围： ipc（摄像头） platform（平台） ied（智能设备）	ipc
GroupId	string	否	按设备所属空间 ID 查询。	348*****174-cn-qingdao
ParentId	string	否	按设备所属上级设备 ID 查询。	399*****774-cn-qingdao
DirectoryId	string	否	按设备所属目录 ID 查询。	399*****488-cn-qingdao
GbId	string	否	按设备国标 ID 查询。	310000000****0000002
Dsn	string	否	设备序列号，唯一标识。	7D0*****4C0
Status	string	否	按设备状态查询。	on
Vendor	string	否	按设备厂商查询。	8yd*****qem
SortBy	string	否	按给定字段排序。取值：说明 id（默认）	id
SortDirection	string	否	排序方式。取值范围： asc（升序）（默认） desc（降序）	asc
PageSize	long	否	分页大小，默认值：20。	20
PageNum	long	否	第几个分页，默认值：1。	1
IncludeStats	boolean	否	是否返回流统计信息，默认值：false。	false
IncludeDirectory	boolean	否	是否返回目录信息，默认值：false。	false

返回参数

名称	类型	描述	示例值
	object
PageNum	long	第几个分页。	1
PageSize	long	分页大小。	20
RequestId	string	请求 ID。	BEA5625F-8FCF-48F4-851B-CA63946DA664
TotalCount	long	设备总数。	77
PageCount	long	分页总数。	5
Devices	object []	设备列表。
Type	string	设备类型。取值范围： ipc（摄像头） platform（平台） ied（智能设备）	ipc
Status	string	设备状态。取值范围： on（在线） off（离线） failed（锁定） new（未注册）	on
AlarmMethod	string	订阅的国标报警方式。取值范围： 0（全部） 5（视频报警） 7（其他报警）说明空值表示不订阅。支持多个，用英文逗号（,）分隔。	0
Dsn	string	设备序列号。说明仅适用于 AUVSP、ODCAP 协议。	7D0*****4C0
Port	long	设备端口。	8080
PosInterval	long	位置订阅周期，单位：秒。	300
AutoDirectory	boolean	是否启用平台设备的目录上报。	true
ParentId	string	上级设备 ID，比如：摄像头所属的平台 ID。	3238848****092995
Password	string	设备密码。	admin
AutoPos	boolean	是否启用设备位置订阅。	false
Params	string	设备其他参数。	{}
Description	string	设备描述。	xxx路口摄像头
Enabled	boolean	是否启用设备。	true
Name	string	设备名称。	xxx路口摄像头
ChannelSyncTime	string	通道同步时间。	2019-02-28T17:01:17Z
CreatedTime	string	设备创建时间。	2019-02-28T17:00:17Z
DirectoryId	string	目录 ID。	399*****488-cn-qingdao
RegisteredTime	string	设备注册时间。	2019-02-28T17:00:17Z
Protocol	string	设备协议。	gb28181
Ip	string	设备 IP。	10.10.10.10
Url	string	设备上的流 URL。	rtmp://xxx/xxx
AutoStart	boolean	是否自动启动流。	false
Vendor	string	设备厂商。	公司A
GbId	string	设备国标 ID。说明仅适用于国标协议。	310000000****0000002
GroupId	string	设备所属空间 ID。	348*****174-cn-qingdao
Longitude	string	设备经度。	45.00
Latitude	string	设备维度。	119.20
Id	string	设备 ID。	348*****380-cn-qingdao
Username	string	设备用户名。	admin
Stats	object	设备流统计信息。
FailedNum	long	失败流数量。	0
StreamNum	long	流数量。	0
ChannelNum	long	通道数量。	0
OnlineNum	long	在线流数量。	0
OfflineNum	long	离线流数量。	0
Directory	object	目录信息。
ParentId	string	上级目录 ID。	399*****774-cn-qingdao
Description	string	目录描述。	目录1
GroupId	string	目录所属空间 ID。	348*****174-cn-qingdao
Name	string	目录名称。	目录1
CreatedTime	string	目录创建时间。	2019-02-28T17:00:17Z
Id	string	目录 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"
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。