查询流的列表信息,支持通过流的ID,名称,空间ID,设备ID等过滤筛选。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vs:DescribeStreams | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Id | string | 否 | 流 ID。 说明
支持多个,用英文逗号(,)分隔。
| 323*****997-cn-qingdao |
GroupId | string | 否 | 按空间 ID 查询。 | 348*****174-cn-qingdao |
DeviceId | string | 否 | 按设备 ID 查询。 | 348*****380-cn-qingdao |
ParentId | string | 否 | 流所在设备的父设备 ID。 | 399*****774-cn-qingdao |
Name | string | 否 | 按名称查询。 说明
支持多个,用英文逗号(,)分隔。
| 3100000*****00000002 |
Domain | string | 否 | 按域名查询。 | example.aliyundoc.com |
App | string | 否 | 按应用查询。 | live |
SortBy | string | 否 | 按给定字段排序,取值范围:
说明
不支持填入多个字段。
| Id |
SortDirection | string | 否 | 排序方式。取值范围:
| asc |
PageSize | long | 否 | 分页大小,默认值:20。 | 20 |
PageNum | long | 否 | 第几个分页,默认值:1。 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"PageNum": 1,
"PageSize": 20,
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
"TotalCount": 100,
"PageCount": 5,
"Streams": [
{
"Status": "on",
"PlayDomain": "demo.aliyundoc.com",
"Protocol": "gb28181",
"DeviceId": "348*****380-cn-qingdao",
"Height": 720,
"GroupId": "348*****174-cn-qingdao",
"App": "live",
"Width": 1280,
"Enabled": true,
"Name": "31000000*****0000002",
"PushDomain": "example.aliyundoc.com",
"CreatedTime": "2018-12-10T17:00:00Z",
"Id": "323*****997-cn-qingdao"
}
]
}
错误码
访问错误中心查看更多错误码。