DescribeOnlineLiveStreams

1. 接口描述

本接口(DescribeOnlineLiveStreams)用于查询指定域名或者指定域名下某个应用的所有在线流信息。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
domainName	是	String	主播流域名
appName	否	String	播流所属应用名称
streamName	否	String	播流名称
pageSize	否	Integer	返回的分页大小。 默认为20，最大为1000。
pageNum	否	Integer	返回的分页数。 默认为1。

3. 响应结果

参数名称	类型	描述
dataSet	Array of OnlineStreamInfo	在线流列表。
requestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

示例

1. 查询所有在线流信息。

POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/cdn
Content-Type: application/json
X-TC-Action: DescribeOnlineLiveStreams
<Common Request Params>

Request:
{
  "domainName": "test.livestream.com",
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
  "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
  "response": {
    "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
    "totalCount": 1,
    "dataSet": [{
        "publishTime": "2025-03-04T07:58:08Z",
        "frameRate": 30,
        "audioDataRate": 83.91,
        "appName": "live",
        "domainName": "test.livestream.com",
        "clientIp": "1.1.1.1",
        "width": 1920,
        "audioCodec": "mp3",
        "videoDataRate": 5685.2159,
        "streamName": "kg774BbEh1",
        "height": 1080,
        "videoCodec": "h265"
    }]
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
404	INVALID_DOMAIN_NOT_FOUND	指定的直播域名不存在。
403	DOMAIN_OPERATION_NO_PERMISSION	由于没有权限，操作被拒绝