全部文档
当前文档
最近更新时间：2024-03-27 15:08:36
用于获取按域名维度的直播在线人数数据，单位：个
支持按指定的起止时间查询，两者需要同时指定
支持批量域名查询，多个域名ID用逗号（半角）分隔
最多可获取一年内93天跨度的数据
统计粒度：1分钟粒度；5分钟粒度；10分钟粒度；20分钟粒度；1小时粒度；4小时粒度；8小时粒度；1天粒度；以上粒度的在线人数均取该粒度时间段的在线人数的峰值
时效性：3-8分钟延迟
接口性能：接口最大吞吐量为10000，即Region个数*App个数*DomainName个数(EndTime-StartTime) /统计粒度<= 10000。注：在获取多个域名多个区域合并值时，Region个数、App个数和DomainName个数按照1计算
只支持直播业务（HLS域名也支持）
使用场景：
• 客户查询单个域名或多域名合并后在线人数数据，用于绘制一条在线人数线图
• 客户查询单个域名或多个域名的详细在线人数数据，进行数据保存及数据分析
签名机制：
Service取值：cdn
接入地址：cdn.api.ksyun.com︎
参数名 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
StartTime | String | Y | 获取数据起始时间点，日期格式按ISO8601表示法，北京时间，格式为：YYYY-MM-DDThh:mm+0800，例如： 2016-08-01T21:14+0800 |
EndTime | String | Y | 结束时间需大于起始时间；获取日期格式按照ISO8601表示法，北京时间，格式为：YYYY-MM-DDThh:mm+0800，例如： 2016-08-01T21:14+0800 |
DomainNames | String | N | 域名名称，缺省为当前产品类型下的全部域名，支持批量域名查询，多个域名用逗号（半角）分隔 |
Apps | String | N | 应用名，不填默认传对应域名下的所有app，支持多选，用逗号分隔 |
Regions | String | N | 区域名称， 取值为CN：中国大陆，AS：亚洲（除中国大陆），NA：北美洲，SA：南美洲，EU：欧洲，AU：大洋洲,非洲：AF，支持多计费区域查询，多个区域用逗号（半角）分隔，缺省为 CN |
DomainType | String | Y | 域名类型，Push：推流域名，Pull拉流域名， |
ResultType | Int | Y | 0：多域名多区域数据做合并；1：每个域名每个区域的数据分别返回 |
Granularity | Int | N | 统计粒度，1：1分钟粒度；5：5分钟粒度；10：10分钟粒度；20：20分钟粒度；60：1小时力度；240：4小时粒度；480：8小时粒度；1440：1天粒度；以上粒度均取该粒度时间段的在线人数峰值 |
参数名 | 类型 | 描述 |
|---|---|---|
StartTime | String | 开始时间 日期格式按ISO8601表示法，北京时间，格式为：YYYY-MM-DDThh:mm+0800，例如： 2016-08-01T21:10+0800 |
EndTime | String | 结束时间 日期格式按ISO8601表示法，北京时间，格式为：YYYY-MM-DDThh:mm+0800，例如： 2016-08-01T21:10+0800 |
DomainType | String | 域名类型 |
DomainName | String | 域名名称，逗号（半角）间隔 |
App | String | 应用名 |
Regions | String | 区域，逗号（半角）间隔 |
ResultType | Int | 取值为0：多域名多区域数据做合并返回；1：每个域名每个区域的数据分别返回 |
Granularity | Int | 统计粒度，取值为 1（默认）：1分钟粒度；5：5分钟粒度；10：10分钟粒度；20：20分钟粒度；60：1小时力度；240：4小时粒度；480：8小时粒度；1440：1天粒度；以上粒度均取该粒度时间段的在线人数峰值 |
Datas | OnlineUserDataByTime[] | 每个时间粒度的在线人数数据 |
参数名 | 类型 | 描述 |
|---|---|---|
Time | String | 时间点 |
OnlineUser | Long | 在线人数（所选域名合并值） |
Domains | OnlineUserDataByDomain[] | 每个域名的详细请求数数据(仅当ResultType取值为1时返回此数据) |
参数名 | 类型 | 描述 |
|---|---|---|
DomainName | String | 域名 |
OnlineUser | Long | 在线人数（所选域名合并值） |
Apps | OnlineUserDataByByApp[] | 该域名在每个区域的详细数据 |
参数名 | 类型 | 描述 |
|---|---|---|
App | String | 应用名 |
OnlineUser | Long | 在线人数（所选域名合并值） |
Regions | OnlineUserDataByByRegion[] | 该域名在每个区域的详细数据 |
参数 | 类型 | 描述 |
|---|---|---|
Region | String | 区域 |
OnlineUser | Long | 在线人数（所选域名合并值） |
POST /?Action=GetLiveOnlineUserDataByDomain&Version=2020-09-01&StartTime=2016-09-18T09:14+0800&EndTime=2016-09-19T10:20+0800&ResultType=1&Granularity=1440&DomainNames=&Apps=&Regions=CN HTTP/1.1
Content-Type: application/x-www-form-urlencoded
X-Amz-Date: YOURDATE
Authorization: authorization string
Host: cdn.api.ksyun.com{
"StartTime": "2016-09-18T09:14+0800",
"EndTime": "2016-09-19T10:20+0800",
"DomainType":"Pull",
"DomainNames": "",
"Apps": "",
"Regions": "CN",
"ResultType": "1",
"Granularity": 1440,
"Datas": [
{
"Time": "2016-09-18 00:00:00",
"OnlineUser": 1834130,
"Domains": [
{
"DomainName": "abc.com",
"OnlineUser": 1834130,
"Apps": [
{
"App": "live1",
"OnlineUser": 1834130,
"Regions":[
{
"Region": "CN",
"OnlineUser": 1834130
}]
}
]
}
]
},
{
"Time": "2016-09-18 00:05:00",
"OnlineUser": 406447,
"Domains": [
{
"DomainName": "abc.com",
"OnlineUser": 406447,
"Apps": [
{
"App": "live1",
"OnlineUser": 406447,
"Regions":[
{
"Region": "CN",
"OnlineUser": 406447
}
]
}
]
}
]
}
]
}此接口为CDN接口，请到使用须知查看错误码详情。
纯净模式