文档

DescribeGroups - 查询空间列表

更新时间:

查询空间列表。

调试

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

授权信息

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

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

请求参数

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

空间 ID。

33763950877224964-cn-qingdao
Namestring

空间名称。

我的视频监控
Regionstring

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

cn-qingdao
InProtocolstring

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

  • gb28181
  • rtmp
rtmp
Statusstring

空间状态。取值范围:

  • on(已启用)
  • off(已停用)
on
SortBystring

按字段排序。取值范围:

  • Id(默认)
Id
SortDirectionstring

排序方式。取值范围:

  • asc(升序)(默认值)
  • desc(降序)
asc
PageSizelong

分页大小。

20
PageNumlong

第几页。默认:1。

1
IncludeStatsboolean

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

false

返回参数

名称类型描述示例值
object
PageNumlong

第几个分页。

5
PageSizelong

分页大小。

20
RequestIdstring

请求 ID。

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

空间总数。

200
PageCountlong

分页总数。

10
Groupsarray<object>

空间列表。

object
Statusstring

空间状态。取值范围:

  • on(已启用)
  • off(已停用)
on
LazyPullboolean

是否启用按需拉流。

false
PlayDomainstring

空间使用的播流域名。

demo.aliyundoc.com
GbPortlong

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

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

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

http://example.com/callback
GbIdstring

空间提供的国标 ID。

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

空间提供的国标信令服务器地址。

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

空间描述。

测试视图计算
Regionstring

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

cn-qingdao
Appstring

空间使用的应用名称。

live
AliasIdstring

空间 ID 别名。

337639*****24964-cn-qingdao
Enabledboolean

空间是否启用。

true
InProtocolstring

空间使用的接入协议。

gb28181
OutProtocolstring

空间使用的播放协议。

rtmp,flv,hls
PushDomainstring

空间使用的推流域名。

example.aliyundoc.com
Namestring

空间名称。

我的空间
CreatedTimestring

空间创建时间。

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

空间 ID。

33763950877224964-cn-qingdao
GbTcpPortsarray
string

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

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

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

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

空间设备统计信息。

PlatformNumlong

空间内平台数量。

0
DeviceNumlong

空间内设备总数。

200
IpcNumlong

空间内摄像头数量。

200
IedNumlong

空间内智能设备数量。

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

错误码

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