全部产品
云市场

DescribeStreams

更新时间:2019-10-22 19:03:35

接口描述

查询流列表。

请求参数

参数 类型 是否必要 示例值 描述
Action String DescribeStreams 操作接口名,系统规定参数。
取值:DescribeStreams
DeviceId String 32388487739092996 按设备ID查询。
GroupId String 32388487739092994 按空间ID查询。
Domain String my.push.com 按域名查询。
App String live 按应用查询。
Name String 31000000000000000002 按名称查询,多值用逗号分隔。
SortBy String id 按给定字段排序,默认按ID排序。
SortDirection String asc 排序方式,默认升序。
取值:asc(升序),desc(降序)
PageSize Long 20 分页大小,默认为20。
PageNum Long 1 第几个分页,默认为1。

返回参数

参数 类型 示例值 描述
PageSize Long 20 分页大小。
PageNum Long 1 第几个分页。
PageCount Long 5 分页总数。
TotalCount Long 100 流总数。
Streams Stream[] 流列表。
RequestId String BEA5625F-8FCF-48F4-851B-CA63946DA664 该条任务请求ID。

Stream类型

参数 类型 示例值 描述
Id String 32388487739092997 流ID。
Name String 31000000000000000002 流名称。
PushDomain String my.push.com 流所属推流域名。
PlayDomain String my.play.com 流所属播流域名。
App String live 流所属应用。
Protocol String gb28181 流协议。
GroupId String 32388487739092994 流所属的空间ID。
DeviceId String 32388487739092995 流所属的设备ID。
Enabled Bool true 流是否启用。
Status String on 流状态。
取值:on(在线),off(离线)
CreatedTime String 2018-12-10T17:00:00Z 流创建时间。

示例

请求示例

  1. http://vs.aliyuncs.com?Action=DescribeStreams&<公共请求参数>

返回示例

  1. {
  2. "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  3. "PageSize": 20,
  4. "PageNum": 1,
  5. "PageCount": 5,
  6. "TotalCount": 100,
  7. "Streams": [
  8. {
  9. "Id": "32388487739092997",
  10. "Name": "31000000000000000002",
  11. "PushDomain": "my.push.com",
  12. "PlayDomain": "my.play.com",
  13. "App": "live",
  14. "Protocol": "gb28181",
  15. "GroupId": "32388487739092994",
  16. "DeviceId": "32388487739092995",
  17. "Enabled": true,
  18. "Status": "on",
  19. "CreatedTime": "2018-12-10T17:00:00Z"
  20. }
  21. ]
  22. }