调用DescribeGroups查询空间列表_视图计算(VECS)-阿里云帮助中心

查询空间列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Id	string	否	空间 ID。	33763950877224964-cn-qingdao
Name	string	否	空间名称。	我的视频监控
Region	string	否	空间所属区域，即服务中心。	cn-qingdao
InProtocol	string	否	空间使用的接入协议。取值范围： gb28181 rtmp	rtmp
Status	string	否	空间状态。取值范围： on（已启用） off（已停用）	on
SortBy	string	否	按字段排序。取值范围： Id（默认）	Id
SortDirection	string	否	排序方式。取值范围： asc（升序）（默认值） desc（降序）	asc
PageSize	long	否	分页大小。	20
PageNum	long	否	第几页。默认：1。	1
IncludeStats	boolean	否	是否返回空间设备统计信息。默认值：false。	false

返回参数

名称	类型	描述	示例值
	object
PageNum	long	第几个分页。	5
PageSize	long	分页大小。	20
RequestId	string	请求 ID。	BEA5625F-8FCF-48F4-851B-CA63946DA664
TotalCount	long	空间总数。	200
PageCount	long	分页总数。	10
Groups	object []	空间列表。
Status	string	空间状态。取值范围： on（已启用） off（已停用）	on
LazyPull	boolean	是否启用按需拉流。	false
PlayDomain	string	空间使用的播流域名。	demo.aliyundoc.com
GbPort	long	空监关联的国标信令服务器端口。说明仅适用于使用国标协议接入的空间。	5060
Callback	string	空间内设备状态更新时的回调。	http://example.com/callback
GbId	string	空间提供的国标 ID。说明仅适用于使用国标协议接入的空间。	31000000000000000001
GbIp	string	空间提供的国标信令服务器地址。说明仅适用于使用国标协议接入的空间。	10.10.10.10
Description	string	空间描述。	测试视图计算
Region	string	空间所属区域，即服务中心。	cn-qingdao
App	string	空间使用的应用名称。	live
AliasId	string	空间 ID 别名。	337639*****24964-cn-qingdao
Enabled	boolean	空间是否启用。	true
InProtocol	string	空间使用的接入协议。	gb28181
OutProtocol	string	空间使用的播放协议。	rtmp,flv,hls
PushDomain	string	空间使用的推流域名。	example.aliyundoc.com
Name	string	空间名称。	我的空间
CreatedTime	string	空间创建时间。	2019-02-28T17:00:17Z
Id	string	空间 ID。	33763950877224964-cn-qingdao
GbTcpPorts	array
	string	空间提供的国标信令服务器 TCP 端口。说明仅适用于使用国标协议接入的空间。	[6060,6160]
GbUdpPorts	array
	string	空间提供的国标信令服务器 UDP 端口。说明仅适用于使用国标协议接入的空间。	[5060,5160]
Stats	object	空间设备统计信息。
PlatformNum	long	空间内平台数量。	0
DeviceNum	long	空间内设备总数。	200
IpcNum	long	空间内摄像头数量。	200
IedNum	long	空间内智能设备数量。	0

示例

正常返回示例

JSON格式

{
  "PageNum": 5,
  "PageSize": 20,
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "TotalCount": 200,
  "PageCount": 10,
  "Groups": [
    {
      "Status": "on",
      "LazyPull": false,
      "PlayDomain": "demo.aliyundoc.com",
      "GbPort": 5060,
      "Callback": "http://example.com/callback",
      "GbId": "31000000000000000001",
      "GbIp": "10.10.10.10",
      "Description": "测试视图计算",
      "Region": "cn-qingdao",
      "App": "live",
      "AliasId": "337639*****24964-cn-qingdao",
      "Enabled": true,
      "InProtocol": "gb28181",
      "OutProtocol": "rtmp,flv,hls",
      "PushDomain": "example.aliyundoc.com",
      "Name": "我的空间",
      "CreatedTime": "2019-02-28T17:00:17Z",
      "Id": "33763950877224964-cn-qingdao",
      "GbTcpPorts": [
        "[6060,6160]"
      ],
      "GbUdpPorts": [
        "[5060,5160]"
      ],
      "Stats": {
        "PlatformNum": 0,
        "DeviceNum": 200,
        "IpcNum": 200,
        "IedNum": 0
      }
    }
  ]
}

错误码

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