最近更新时间:2023.08.07 11:52:35
首次发布时间:2021.11.23 15:56:02
支持查询一定时间范围内的直播拉流的在线人数和拉流请求数,支持按拉流协议区分。支持查询删除域名的直播流请求数和在线人数。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveStreamSessionData | 接口名称。当前 API 的名称为 DescribeLiveStreamSessionData 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainList | Array of String | 否 |
| 域名列表。缺省情况表示该用户的所有域名。 说明
|
Domain | String | 否 |
| 查询流粒度数据时的域名参数,支持推流域名和拉流域名。 |
App | String | 否 |
| 查询流粒度数据时的应用名参数。 |
Stream | String | 否 |
| 查询流粒度数据时的流名称参数。 |
RefererList | Array of String | 否 | ["www.test.com"] | 请求的 Referer |
ProtocolList | Array of String | 否 |
| 推拉流协议,缺省情况下表示所有协议类型。支持的协议如下所示。
说明 如果设置推拉流协议为 QUIC,不能同时传其他协议。 |
ISPList | Array of String | 否 |
| 运营商,缺省情况下表示所有运营商。支持的运营商如下所示。
|
RegionList | Array of RegionList | 否 | - | 区域列表,缺省情况表示所有区域。 |
StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-01T00:00:00+08:00 |
EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-02T00:00:00+08:00 |
Aggregation | Integer | 否 |
| 聚合的时间粒度,单位为 s,默认值为 300。支持如下时间粒度。
|
ShowDetail | Boolean | 否 |
| 是否返回过滤字段和时间聚合后的数据,默认为 false。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Area | String | 否 | CN | 大区,映射关系请参见区域映射 |
Country | String | 否 | CN | 国家,映射关系请参见区域映射。如果按国家筛选,需要同时传入 Area 和 Country 。 |
Province | String | 否 | beijing | 国内为省,国外暂不支持该参数,映射关系请参见区域映射。如果按省筛选,需要同时传入 Area 、Country 和 Province 。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainList | Array of String | ["example.com"] | 域名列表 |
Domain | String | example.com | 域名 |
App | String | example_app | 应用名称 |
Stream | String | example_stream | 直播流名称 |
RefererList | Array of String | ["www.test.com"] | 请求的 Referer |
ProtocolList | Array of String | ["HTTP-FLV", "RTMP"] | 推拉流协议 |
ISPList | Array of String | ["telecom"] | 运营商 |
RegionList | Array of RegionList | - | 区域 |
StartTime | String | 2021-04-13T00:00:00+08:00 | 起始时间 |
EndTime | String | 2021-04-14T00:00:00+08:00 | 结束时间 |
Aggregation | Integer | 300 | 时间粒度 |
TotalRequest | Integer | 20 | 总的请求数 |
PeakOnlineUser | Integer | 20 | 在线人数峰值 |
SessionDataList | Array of SessionDataList | - | 查询范围内的汇总信息 |
SessionDetailDataList | Array of SessionDetailDataList |
| 按照搜索过滤字段和时间粒度聚合的数据 说明 请求时, |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Area | String | CN | 大区,映射关系请参见区域映射 |
Country | String | CN | 国家,映射关系请参见区域映射 |
Province | String | beijing | 国内为省,国外暂不支持该参数,映射关系请参见区域映射 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Timestamp | String | 2022-04-13T00:00:00+08:00 | 时间片起始时刻。RFC3339 时间,例如,2022-04-13T00:00:00+08:00 |
Request | Integer | 10 | 请求数 |
OnlineUser | Integer | 20 | 在线人数 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | example.com | 域名 |
Referer | String | www.test.com | 请求的 Referer |
Protocol | String | HTTP-FLV | 推拉流协议 |
ISP | String | telecom | 运营商 |
TotalRequest | Integer | 20 | 总的请求数 |
PeakOnlineUser | Integer | 20 | 在线人数峰值 |
SessionDataList | Array of SessionDataList | - | 按时间粒度聚合的数据 |
POST https://live.volcengineapi.com?Action=DescribeLiveStreamSessionData&Version=2020-08-01 { "DomainList": ["example.com"], "ProtocolList": ["HTTP-FLV", "RTMP"], "ISPList": ["telecom"], "RefererList": ["www.test.com"], "RegionList": [ { "Area": "CN", "Country": "CN", "Province": "beijing", } ], "StartTime": "2021-04-13T00:00:00+08:00", "EndTime": "2021-04-14T00:00:00+08:00", "Aggregation": 300, "ShowDetail": true }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "DescribeLiveStreamSessionData", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "DomainList": [ "example.com" ], "ProtocolList": [ "HTTP-FLV", "RTMP" ], "ISPList": [ "telecom" ], "RefererList": [ "www.test.com" ], "RegionList": [ { "Area": "CN", "Country": "CN", "Province": "beijing" } ], "StartTime": "2021-04-13T00:00:00+08:00", "EndTime": "2021-04-14T00:00:00+08:00", "Aggregation": 300, "TotalRequest": 20, "PeakOnlineUser": 20, "SessionDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "Request": 10, "OnlineUser": 20 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "Request": 10, "OnlineUser": 20 } ], "SessionDetailDataList": [ { "Protocol": "HTTP-FLV", "TotalRequest": 20, "PeakOnlineUser": 20, "SessionDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "Request": 20, "OnlineUser": 20 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "Request": 20, "OnlineUser": 20 } ] }, { "Protocol": "RTMP", "TotalRequest": 0, "PeakOnlineUser": 0, "SessionDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "Request": 0, "OnlineUser": 0 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "Request": 0, "OnlineUser": 0 } ] } ] } }
访问公共错误码获取详细信息。