查询空间列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vs:DescribeGroups | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Id | string | 否 | 空间 ID。 | 33763950877224964-cn-qingdao |
Name | string | 否 | 空间名称。 | 我的视频监控 |
Region | string | 否 | 空间所属区域,即服务中心。 | cn-qingdao |
InProtocol | string | 否 | 空间使用的接入协议。取值范围:
| rtmp |
Status | string | 否 | 空间状态。取值范围:
| on |
SortBy | string | 否 | 按字段排序。取值范围:
| Id |
SortDirection | string | 否 | 排序方式。取值范围:
| asc |
PageSize | long | 否 | 分页大小。 | 20 |
PageNum | long | 否 | 第几页。默认:1。 | 1 |
IncludeStats | boolean | 否 | 是否返回空间设备统计信息。默认值:false。 | false |
返回参数
示例
正常返回示例
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
}
}
]
}
错误码
访问错误中心查看更多错误码。