调用DescribeGroup查询业务空间_视图计算(VECS)-阿里云帮助中心

获取空间信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vs:DescribeGroup	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Id	string	是	空间 ID。	337639*****224964-cn-qingdao
IncludeStats	boolean	否	是否返回空间设备统计信息，默认值：false。	false

返回参数

名称	类型	描述	示例值
	object
Status	string	空间状态。	on
LazyPull	boolean	是否启用按需拉流。	false
Callback	string	空间内设备状态更新时的回调。	http://example.com/callback
RequestId	string	请求 ID。	BEA5625F-8FCF-48F4-851B-CA63946DA664
Description	string	空间描述。	上海高速监控
App	string	空间使用的应用名称。	live
Region	string	空间所属区域，即服务中心。	cn-qingdao
Enabled	boolean	空间是否启用。	true
InProtocol	string	空间使用的接入协议，取值范围： gb28181 rtmp	gb28181
OutProtocol	string	空间使用的播放协议，取值范围： flv hls rtmp 说明支持多个，用英文逗号（,）分隔。	flv,hls,rtmp
Name	string	空间名称。	上海高速监控
PushDomain	string	空间使用的推流域名。	demo.aliyundoc.com
CreatedTime	string	空间的创建时间。	2019-02-28T17:00:17Z
PlayDomain	string	空间使用的播流域名。	example.aliyundoc.com
GbPort	long	空间关联的国标信令服务器端口。说明仅适用于使用国标协议接入的空间。	5060
GbId	string	空间关联的国标 ID。说明仅适用于使用国标协议接入的空间。	3100000*****0000001
GbIp	string	空间关联的国标信令服务器 IP 地址。说明仅适用于使用国标协议接入的空间。	10.10.10.10
AliasId	string	空间 ID 别名。	337639*****24964-cn-qingdao
Id	string	空间 ID。	337639****224964-cn-qingdao
GbTcpPorts	array	空间提供的国标信令服务器 TCP 端口。说明仅适用于使用国标协议接入的空间。
Port	string	空间提供的国标信令服务器 TCP 端口。说明仅适用于使用国标协议接入的空间。	[6060, 6160]
GbUdpPorts	array	空间提供的国标信令服务器 UDP 端口。说明仅适用于使用国标协议接入的空间。
Port	string	空间提供的国标信令服务器 UDP 端口。说明仅适用于使用国标协议接入的空间。	[ 5060, 5160 ]
Stats	object	空间内设备的统计信息。
PlatformNum	long	空间内平台个数。	100
DeviceNum	long	空间内设备总数。	200
IpcNum	long	空间内摄像头个数。	100
IedNum	long	空间内智能设备个数。	0

示例

正常返回示例

JSON格式

{
  "Status": "on",
  "LazyPull": false,
  "Callback": "http://example.com/callback",
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "Description": "上海高速监控",
  "App": "live",
  "Region": "cn-qingdao",
  "Enabled": true,
  "InProtocol": "gb28181",
  "OutProtocol": "flv,hls,rtmp",
  "Name": "上海高速监控",
  "PushDomain": "demo.aliyundoc.com",
  "CreatedTime": "2019-02-28T17:00:17Z",
  "PlayDomain": "example.aliyundoc.com",
  "GbPort": 5060,
  "GbId": "3100000*****0000001",
  "GbIp": "10.10.10.10",
  "AliasId": "337639*****24964-cn-qingdao",
  "Id": "337639****224964-cn-qingdao",
  "GbTcpPorts": [
    "[6060, 6160]"
  ],
  "GbUdpPorts": [
    "[\n      5060,\n      5160\n]"
  ],
  "Stats": {
    "PlatformNum": 100,
    "DeviceNum": 200,
    "IpcNum": 100,
    "IedNum": 0
  }
}

错误码

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