文档

DescribeStreams - 查询流列表

更新时间:

查询流的列表信息,支持通过流的ID,名称,空间ID,设备ID等过滤筛选。

调试

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

授权信息

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

请求参数

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

流 ID。

说明 支持多个,用英文逗号(,)分隔。
323*****997-cn-qingdao
GroupIdstring

按空间 ID 查询。

348*****174-cn-qingdao
DeviceIdstring

按设备 ID 查询。

348*****380-cn-qingdao
ParentIdstring

流所在设备的父设备 ID。

399*****774-cn-qingdao
Namestring

按名称查询。

说明 支持多个,用英文逗号(,)分隔。
3100000*****00000002
Domainstring

按域名查询。

example.aliyundoc.com
Appstring

按应用查询。

live
SortBystring

按给定字段排序,取值范围:

  • Id(默认)
  • GroupId
  • Name
  • DeviceId
  • Protocol
说明 不支持填入多个字段。
Id
SortDirectionstring

排序方式。取值范围:

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

分页大小,默认值:20。

20
PageNumlong

第几个分页,默认值:1。

1

返回参数

名称类型描述示例值
object
PageNumlong

第几个分页。

1
PageSizelong

分页大小。

20
RequestIdstring

请求 ID。

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

流总数。

100
PageCountlong

分页总数。

5
Streamsobject []

流列表。

Statusstring

流状态。取值范围:

  • on(在线)
  • off(离线)
on
PlayDomainstring

流所属播流域名。

demo.aliyundoc.com
Protocolstring

流协议。

gb28181
DeviceIdstring

流所属的设备 ID。

348*****380-cn-qingdao
Heightinteger

视频流分辨率高度。

720
GroupIdstring

流所属的空间 ID。

348*****174-cn-qingdao
Appstring

流所属应用。

live
Widthinteger

视频流分辨率宽度。

1280
Enabledboolean

流是否启用。

true
Namestring

流名称。

31000000*****0000002
PushDomainstring

流所属推流域名。

example.aliyundoc.com
CreatedTimestring

流创建时间。

2018-12-10T17:00:00Z
Idstring

流 ID。

323*****997-cn-qingdao

示例

正常返回示例

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

错误码

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

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