DescribeGroups - 视频监控

接口描述

查询空间列表。

请求参数

参数	类型	是否必要	示例值	描述
Action	String	是	DescribeGroups	操作接口名，系统规定参数。取值：DescribeGroups
Id	String	否	32388487739092994	按空间ID查询。
Name	String	否	视频监控	按空间名称查询。
Region	String	否	cn-shanghai	按空间区域查询。
InProtocol	String	否	rtmp	按空间接入协议查询。
Status	String	否	on	按空间状态查询。
SortBy	String	否	id	按给定字段排序，默认按ID排序。
SortDirection	String	否	asc	排序方式，默认升序。取值：asc(升序),desc(降序)
PageSize	Long	否	20	分页大小，默认为20。
PageNum	Long	否	1	第几个分页，默认为1。
IncludeStats	Bool	否	false	是否包含设备统计信息，默认false。

返回参数

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

Group类型

参数	类型	示例值	描述
Id	String	32388487739092994	空间ID。
Name	String	视频监控	空间名称。
Description	String	视频监控	空间描述。
Region	String	cn-shanghai	空间所属区域，即服务中心。
App	String	live	空间使用的应用名称。
InProtocol	String	gb28181	空间使用的接入协议。
OutProtocol	String	rtmp,flv	空间使用的播放协议。
Enabled	Bool	true	空间是否启用。
Status	String	on	空间状态。
CreatedTime	String	2019-02-28T17:00:17Z	空间创建时间。
PushDomain	String	my.push.com	空间使用的推流域名。
PlayDomain	String	my.play.com	空间使用的播流域名。
LazyPull	Bool	false	是否启用按需拉流
Callback	String	my.callback.com	空间内设备状态更新时的回调
GbId	String	31000000000000000001	空间提供的国标ID。（仅适用于国标接入的空间）
GbIp	String	1.1.1.1	空间提供的的国标信令服务器地址。（仅适用于国标接入的空间）
GbUdpPort	Long	5060	空间提供的国标信令服务器UDP端口。（仅适用于国标接入的空间）
GbTcpPort	Long	6060	空间提供的国标信令服务器TCP端口。（仅适用于国标接入的空间）
Stats	Stat		空间设备统计信息。

Stat类型

参数	类型	描述
DeviceNum	Long	空间内设备总数。
IpcNum	Long	空间内摄像头数量。
IedNum	Long	空间内智能设备数量。
PlatformNum	Long	空间内平台数量。

示例

请求示例

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

返回示例

{
    "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
    "PageSize": 20,
    "PageNum": 1,
    "PageCount": 5,
    "TotalCount": 100,
    "Groups": [
        {
            "Id": "32388487739092994 ",
            "Name": "视频监控",
            "Description": "视频监控",
            "Region": "cn-shanghai",
            "App": "live",
            "InProtocl": "gb28181",
            "OutProtocol": "flv,hls,rtmp",
            "Enabled": true,
            "Status": "on",
            "CreatedTime": "2018-12-10T21:00:00Z",
            "PushDomain": "my.push.com",
            "PlayDomain": "my.play.com"
        }
    ]
}