调用DescribeDevices获取设备列表-阿里云帮助中心

获取设备列表。

请求参数

参数	类型	是否必要	示例值	描述
Action	String	是	DescribeDevices	操作接口名，系统规定参数。取值：DescribeDevices。
GroupId	String	是	3238848****092994	按设备所属空间ID查询。
ParentId	String	否	3238848****092995	按设备所属上级设备ID。
Type	String	否	ipc	按设备类型查询。取值：ipc（摄像头），platform（平台），ied（智能设备）。
SortBy	String	否	id	按给定字段排序，默认按ID排序。
SortDirection	String	否	asc	排序方式，默认升序。取值：asc（升序），desc（降序）。
PageSize	Long	否	20	分页大小，默认为20。
PageNum	Long	否	1	第几个分页，默认为1。
IncludeStats	Bool	否	false	是否返回流统计信息，默认false。
IncludeDirectory	Bool	否	false	是否返回目录信息，默认false。

返回参数

参数	类型	示例值	描述
PageSize	Long	20	分页大小。
PageNum	Long	1	第几个分页。
PageCount	Long	5	分页总数。
TotalCount	Long	100	设备总数。
Devices	Device[]	Device[]	设备列表。
RequestId	String	BEA5625F-8FCF-48F4-851B-CA63946DA664	该条任务请求ID。

Device类型

参数	类型	示例值	描述
Id	String	323884877****2996	设备ID。
Name	String	xxx路口摄像头	设备名称。
Description	String	xxx路口摄像头	设备描述。
GroupId	String	3238848****092994	设备所属空间ID。
ParentId	String	3238848****092995	上级设备ID，比如摄像头所属的平台ID。
Type	String	ipc	设备类型。取值：ipc（摄像头），platform（平台），ied（智能设备）。
AutoStart	Bool	false	是否自动启动流，默认false。
Enabled	Bool	true	是否启用设备，默认true。
Protocol	String	gb28181	设备协议。取值：gb28181
Status	String	on	设备状态。取值：on（在线），off（离线），failed（锁定），new（未注册）。
GbId	String	310000000****0000002	设备国标ID。（仅适用于国标协议）
Ip	String	2.2..	设备IP。
Port	Int	8080	设备端口。
Username	String	admin	设备用户名。
Password	String	admin	设备密码。
Vendor	String		设备厂商。
Longitude	String	45.00	设备经度。
Latitude	String	119.20	设备维度。
AutoPos	Bool	false	是否启用设备位置订阅。
PosInterval	Long	300	位置订阅周期，单位秒。
AlarmMethod	String	0	订阅的国标报警方式，多值用逗号分隔。取值：0（全部），5（视频报警），7（其他报警）,空值表示不订阅。
CreatedTime	String	2019-02-28T17:00:17Z	设备创建时间。
Params	String	{}	设备其他参数。
Stats	Stat		设备流统计信息。
Directory	Directory		目录信息。

Stat类型

参数	类型	示例值	描述
ChannelNum	Long	0	通道数量。
StreamNum	Long	0	流数量。
OnlineNum	Long	0	在线流数量。
OfflineNum	Long	0	离线流数量。
FailedNum	Long	0	失败流数量。

Directory类型

参数	类型	示例值	描述
Id	String	32388487739092994	目录ID。
Name	String	目录1	目录名称。
Description	String	目录1	目录描述。
GroupId	String	32388487739092994	目录所属空间ID。
ParentId	String	32388487739092995	上级目录ID。
CreatedTime	String	2019-02-28T17:00:17Z	目录创建时间。

示例

请求示例

http://vs.aliyuncs.com?Action=DescribeDevices&<公共请求参数>

返回示例

{
    "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
    "PageSize": 20,
    "PageNum": 1,
    "PageCount": 5,
        "TotalCount": 100,
    "Devices": [
        {
            "Id": "3238848****092996 ",
            "Name": "xxx路口摄像头",
            "Description": "xxx路口摄像头",
            "GroupId": "3238848****092994",
            "ParentId": "3238848****092995",
            "Type": "ipc",
            "AutoStart": true,
            "Enabled": true,
            "Protocol": "gb28181",
            "Status": "on",
            "GbId": "31000000000****00002 ",
            "Ip": "2.2.*.*",
            "Username": "admin",
            "Password": "admin",
            "CreatedTime": "2018-12-10T17:00:00Z"
        }
    ]
}