查询流列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeStreams

操作接口名,系统规定参数。

取值:DescribeStreams

DeviceId String 348*****380-cn-qingdao

按设备ID查询。

GroupId String 348*****174-cn-qingdao

按空间ID查询。

Domain String example.aliyundoc.com

按域名查询。

App String live

按应用查询。

Name String 3100000*****00000002

按名称查询,多值用逗号分隔。

SortBy String id

按给定字段排序,默认按ID排序。

SortDirection String asc

排序方式,默认升序。取值:

  • asc(升序)
  • desc(降序)
PageSize Long 20

分页大小,默认为20。

PageNum Long 1

第几个分页,默认为1。

Id String 323*****997-cn-qingdao

流Id,支持多个,用英文逗号(,)分割。

ParentId String 399*****774-cn-qingdao

流所在设备的父设备Id。

返回数据

名称 类型 示例值 描述
RequestId String BEA5625F-8FCF-48F4-851B-CA63946DA664

请求ID。

PageSize Long 20

分页大小。

PageNum Long 1

第几个分页。

TotalCount Long 100

流总数。

PageCount Long 5

分页总数。

Streams Array of Stream

流列表。

App String live

流所属应用。

CreatedTime String 2018-12-10T17:00:00Z

流创建时间。

DeviceId String 348*****380-cn-qingdao

流所属的设备ID。

Enabled Boolean true

流是否启用。

GroupId String 348*****174-cn-qingdao

流所属的空间ID。

Height Integer 720

视频流分辨率高度。

Id String 323*****997-cn-qingdao

流ID。

Name String 31000000*****0000002

流名称。

PlayDomain String demo.aliyundoc.com

流所属播流域名。

Protocol String gb28181

流协议。

PushDomain String example.aliyundoc.com

流所属推流域名。

Status String on

流状态。取值:

  • on(在线)
  • off(离线)
Width Integer 1280

视频流分辨率宽度。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeStreams
&<公共请求参数>

正常返回示例

JSON格式

{
    "TotalCount": "100",
    "PageCount": "5",
    "PageNum": "1",
    "PageSize": "20",
    "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
    "Streams": [
        {
            "Status": "on",
            "App": "live",
            "CreatedTime": "2018-12-10T17:00:00Z",
            "DeviceId": "348*****380-cn-qingdao",
            "PlayDomain": "demo.aliyundoc.com",
            "Enabled": "true",
            "Height": "720",
            "Id": "323*****997-cn-qingdao",
            "Protocol": "gb28181",
            "PushDomain": "example.aliyundoc.com",
            "Width": "1280",
            "GroupId": "348*****174-cn-qingdao",
            "Name": "31000000*****0000002"
        }
    ]
}

错误码

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