分页查询指定发布点下的在线流列表。
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/reports/online_streams
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
如果返回的 HTTP 状态码为 200,表示请求成功。响应包体中包含以下字段:
streamList
:JSON Array 型,在线流列表。一个直播流对应一个 JSON Object,包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
name |
String | 流的名称。 |
startTime |
String | 推流的时间。RFC3339 格式,例如 "2019-01-07T12:00:00Z" 。 |
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/live/reports/online_streams HTTP/1.1
响应行
HTTP/1.1 200 OK
响应 body
{
"streamList": [
{
"name": "{your_stream_name_1}",
"startTime": "2021-11-29T19:00:00+08:00"
},
{
"name": "{your_stream_name_2}",
"startTime": "2021-11-29T19:00:00+08:00"
},
]
}
获取指定在线流的信息。
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/reports/online_streams/{stream_name}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
stream_name |
String | 必填。要查询的直播流名称。 |
如果返回的 HTTP 状态码为 200,表示请求成功。响应包体中包含以下字段:
startTime
:String 型。推流开始的时间,RFC3339 格式,例如 "2019-01-07T12:00:00Z"
。如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/live/reports/online_streams/{stream_name} HTTP/1.1
响应行
HTTP/1.1 200 OK
响应 body
{
"startTime": "2021-10-11T04:08:52Z"
}
获取指定发布点下指定时间范围内的推流历史,只能查询到已经结束的流的历史。
推流历史数据有约两小时的延时,支持查询 60 天内的推流记录,单次查询范围不能超过 30 天。
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/reports/publish_history?start_time={start_time}&end_time={end_time}&stream_name={stream_name}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
参数 | 类型 | 描述 |
---|---|---|
start_time |
String | 选填。查询推流历史的开始时间,格式为 RFC3339 时间格式对应的 URL 编码,例如 2019-01-07T12:00:00+08:00 对应 2019-01-07T12%3A00%3A00%2B08%3A00 。开始时间不能早于当前时间 60 天前的时间。 |
end_time |
String | 选填。查询推流历史的结束时间,格式为 RFC3339 时间格式对应的 URL 编码,例如 2019-01-07T12:00:00+08:00 对应 2019-01-07T12%3A00%3A00%2B08%3A00 。结束时间不能晚于当前时间。 |
stream_name |
String | 可选。要查询历史的直播流名称。如果不填,代表查询指定发布点下所有的直播流。 |
start_time
和 end_time
都不填,默认查询最近 7 天的推流历史。如果返回的 HTTP 状态码为 200,表示请求成功。响应包体中包含以下字段:
publishHistory
:JSON Array 型,推流历史信息列表,按照推流结束时间从晚到早排序。一条推流记录对应一个 JSON Object,包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
name |
String | 流的名称。 |
startTime |
String | 推流开始的时间。RFC3339 格式,例如 "2019-01-07T12:00:00+08:00" 。 |
endTime |
String | 推流结束的时间。RFC3339 格式,例如 "2019-01-07T12:00:00+08:00" 。 |
duration |
Integer | 推流持续的时长,单位为秒。 |
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/live/reports/publish_history?start_time={start_time}&end_time={end_time}&stream_name={stream_name} HTTP/1.1
响应行
HTTP/1.1 200 OK
响应 body
{
"publishHistory": [
{
"name": "{your_stream_name_1}",
"startTime": "2021-08-25T12:19:23+08:00",
"endTime": "2021-08-25T14:42:58+08:00",
"duration": 8616
},
{
"name": "{your_stream_name_2}",
"startTime": "2021-08-25T10:44:40+08:00",
"endTime": "2021-08-25T11:01:49+08:00",
"duration": 1030
}
]
}
获取指定流在指定时间范围内的推流质量数据。
推流质量数据有约 3 分钟的延时,支持查询 6 天内的推流记录,单次查询范围不能超过 6 小时。
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/reports/publish_quality?start_time={start_time}&end_time={end_time}&stream_name={stream_name}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
参数 | 类型 | 描述 |
---|---|---|
start_time |
String | 选填。查询推流质量数据的开始时间,格式为 RFC3339 时间格式对应的 URL 编码,例如 2019-01-07T12:00:00+08:00 对应 2019-01-07T12%3A00%3A00%2B08%3A00 。开始时间不能早于当前时间 6 天前的时间。 |
end_time |
String | 选填。查询推流质量数据的结束时间,格式为 RFC3339 时间格式对应的 URL 编码,例如 2019-01-07T12:00:00+08:00 对应 2019-01-07T12%3A00%3A00%2B08%3A00 。结束时间不能晚于当前时间。 |
stream_name |
String | 必填。要查询推流质量的直播流名称。 |
start_time
和 end_time
都不填,默认查询最近 6 小时的推流质量数据。如果返回的 HTTP 状态码为 200,表示请求成功。响应包体中包含以下字段:
QualityHistory
:JSON Array 型,推流质量数据列表,按照推流质量数据时间从晚到早排序。一条推流记录对应一个 JSON Object,包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
name |
String | 流的名称。 |
time |
String | 推流质量数据的时间。RFC3339 格式,例如 "2019-01-07T12:00:00+08:00" 。 |
bitrate |
Integer | 推流码率,单位为 bps。 |
framerate |
Integer | 推流帧率,单位为 fps。 |
cdnIp |
String | 推流 CDN 节点的 IP 地址。 |
clientIp |
String | 推流客户端的 IP 地址。 |
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/live/reports/publish_quality?start_time={start_time}&end_time={end_time}&stream_name={stream_name} HTTP/1.1
响应行
HTTP/1.1 200 OK
响应 body
{
"QualityHistory": [
{
"name": "{your_stream_name}",
"time": "2021-08-25T12:19:00+08:00",
"bitrate": 1123388,
"framerate": 31,
"cdnIp": "58.220.74.80",
"clientIp": "218.19.252.82"
},
{
"name": "{your_stream_name}",
"time": "2021-08-25T12:18:00+08:00",
"bitrate": 1177908,
"framerate": 30,
"cdnIp": "58.220.74.80",
"clientIp": "218.19.252.82"
}
]
}
获取指定流在指定时间范围内的播流统计数据。
播流统计数据有约 3 分钟的延迟,支持查询 30 天内的播流记录,单次查询范围不能超过 2 个小时。
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/reports/stream_play_statistic?start_time={start_time}&end_time={end_time}&stream_name={stream_name}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
参数 | 类型 | 描述 |
---|---|---|
start_time |
String | 选填。查询播流统计数据的开始时间,格式为 RFC3339 时间格式对应的 URL 编码,例如 2019-01-07T12:00:00+08:00 对应 2019-01-07T12%3A00%3A00%2B08%3A00 。开始时间不能早于当前时间 30 天前的时间。 |
end_time |
String | 选填。查询播流统计数据的结束时间,格式为 RFC3339 时间格式对应的 URL 编码,例如 2019-01-07T12:00:00+08:00 对应 2019-01-07T12%3A00%3A00%2B08%3A00 。结束时间不能晚于当前时间。 |
stream_name |
String | 必填。要查询播流统计的直播流名称。 |
start_time
和 end_time
都不填,默认查询最近 2 小时的播流统计数据。如果返回的 HTTP 状态码为 200,表示请求成功。响应包体中包含以下字段:
playStatistic
:JSON Array 型,播流统计数据列表,按照播流统计数据时间从晚到早排序。一条推流记录对应一个 JSON Object,包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
name |
String | 流的名称。 |
time |
String | 播流统计数据的时间。RFC3339 格式,例如 "2019-01-07T12:00:00+08:00" 。播流统计数据按分钟统计。 |
linkNum |
Integer | 连接数,即播流客户端的数量。 |
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/live/reports/stream_play_statistic?start_time={start_time}&end_time={end_time}&stream_name={stream_name} HTTP/1.1
响应行
HTTP/1.1 200 OK
响应 body
{
"playStatistic": [
{
"name": "{your_stream_name}",
"time": "2021-08-25T12:19:00+08:00",
"linkNum": 3
},
{
"name": "{your_stream_name}",
"time": "2021-08-25T12:18:00+08:00",
"linkNum": 5
}
]
}
状态码 | 描述 |
---|---|
200 | 请求成功。 |
400 | appid 或者 entry_point 为空。 |
401 | 未经授权的(客户 ID/客户密钥匹配错误)。 |
404 | 服务器无法根据请求找到资源,即请求的发布点不存在,或者请求的 URI 路径非法。 |
500 | 服务器内部错误,无法完成请求。 |
504 | 服务器内部错误。充当网关或代理的服务器未从远端服务器获取请求。 |