查询直播中的流信息 - ListLiveStreamsOnline
功能介绍
查询直播中的流信息
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
live:stream:listLiveStreamsOnline
List
-
-
-
-
URI
GET /v1/{project_id}/realtime/streams
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID，获取方法请参考获取项目ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
publish_domain | 是 | String | 推流域名 |
app | 否 | String | 应用名 |
offset | 否 | Integer | 偏移量，表示从此偏移量开始查询，offset大于等于0 |
limit | 否 | Integer | 每页记录数，取值范围[1,100]，默认值10 取值范围： 1~100 默认取值： 10 |
stream | 否 | String | 流名，用于单流查询，携带stream参数时app必须配置。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 用户Token，使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
Authorization | 否 | String | 使用AK/SK方式认证时必填，携带的鉴权信息。 |
X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必填，请求的发生时间。 |
X-Project-Id | 否 | String | 使用AK/SK方式认证时必填，携带项目ID信息。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
total_page | Long | 总页数 |
total_num | Long | 总条目数 |
offset | Long | 偏移量 |
limit | Long | 每页条目数 |
request_id | String | 请求唯一标识 |
streams | Array of OnlineInfo objects | 推流统计 |
参数 | 参数类型 | 描述 |
|---|---|---|
publish_domain | String | 域名 |
app | String | 应用名 |
stream | String | 流名 |
video_codec | String | 视频编码方式 |
audio_codec | String | 音频编码方式：AAC |
video_frame_rate | Long | 视频帧率（单位：fps） |
audio_frame_rate | Long | 音频帧率（单位：fps） |
video_bitrate | Long | 视频码率（单位：Kbps） |
audio_bitrate | Long | 音频码率（单位：Kbps） |
resolution | String | 视频分辨率 |
client_ip | String | 推流设备的ip |
start_time | String | 开始推流的时间，UTC格式：2006-01-02T15:04:05Z |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
请求示例
GET https://{endpoint}/v1/{project_id}/realtime/streams?publish_domain=push.example.com&app=live&offset=0&limit=10 响应示例
状态码：200
查询直播中的流信息数据成功
{
"total_page" : 1,
"total_num" : 10,
"offset" : 0,
"limit" : 10,
"request_id" : "56b9f4dc-b282-48e0-a1a9-c50ffb06b687",
"streams" : [ {
"publish_domain" : "push.example.com",
"app" : "live",
"stream" : "test",
"video_codec" : "H264",
"audio_codec" : "AAC",
"video_frame_rate" : 15,
"audio_frame_rate" : 43,
"video_bitrate" : 588,
"audio_bitrate" : 68,
"resolution" : "640x360",
"client_ip" : "192.168.0.100",
"start_time" : "2006-01-02T15:04:05Z"
} ]
} 状态码：400
查询直播中的流信息数据失败
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
} 状态码
状态码 | 描述 |
|---|---|
200 | 查询直播中的流信息数据成功 |
400 | 查询直播中的流信息数据失败 |
错误码
请参见错误码。
