文档

DescribeGroup - 查询业务空间

更新时间:

获取空间信息。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
Idstring

空间 ID。

337639*****224964-cn-qingdao
IncludeStatsboolean

是否返回空间设备统计信息,默认值:false。

false

返回参数

名称类型描述示例值
object
Statusstring

空间状态。

on
LazyPullboolean

是否启用按需拉流。

false
Callbackstring

空间内设备状态更新时的回调。

http://example.com/callback
RequestIdstring

请求 ID。

BEA5625F-8FCF-48F4-851B-CA63946DA664
Descriptionstring

空间描述。

上海高速监控
Appstring

空间使用的应用名称。

live
Regionstring

空间所属区域,即服务中心。

cn-qingdao
Enabledboolean

空间是否启用。

true
InProtocolstring

空间使用的接入协议,取值范围:

  • gb28181
  • rtmp
gb28181
OutProtocolstring

空间使用的播放协议,取值范围:

  • flv
  • hls
  • rtmp
说明 支持多个,用英文逗号(,)分隔。
flv,hls,rtmp
Namestring

空间名称。

上海高速监控
PushDomainstring

空间使用的推流域名。

demo.aliyundoc.com
CreatedTimestring

空间的创建时间。

2019-02-28T17:00:17Z
PlayDomainstring

空间使用的播流域名。

example.aliyundoc.com
GbPortlong

空间关联的国标信令服务器端口。

说明 仅适用于使用国标协议接入的空间。
5060
GbIdstring

空间关联的国标 ID。

说明 仅适用于使用国标协议接入的空间。
3100000*****0000001
GbIpstring

空间关联的国标信令服务器 IP 地址。

说明 仅适用于使用国标协议接入的空间。
10.10.10.10
AliasIdstring

空间 ID 别名。

337639*****24964-cn-qingdao
Idstring

空间 ID。

337639****224964-cn-qingdao
GbTcpPortsarray

空间提供的国标信令服务器 TCP 端口。

说明 仅适用于使用国标协议接入的空间。
string

空间提供的国标信令服务器 TCP 端口。

说明 仅适用于使用国标协议接入的空间。
[6060, 6160]
GbUdpPortsarray

空间提供的国标信令服务器 UDP 端口。

说明 仅适用于使用国标协议接入的空间。
string

空间提供的国标信令服务器 UDP 端口。

说明 仅适用于使用国标协议接入的空间。
[ 5060, 5160 ]
Statsobject

空间内设备的统计信息。

PlatformNumlong

空间内平台个数。

100
DeviceNumlong

空间内设备总数。

200
IpcNumlong

空间内摄像头个数。

100
IedNumlong

空间内智能设备个数。

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
  }
}

错误码

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

  • 本页导读 (1)
文档反馈