全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

查询流量

最近更新时间:2024-03-27 15:08:36

查询流量(GetFlowData

接口描述

本接口用于获取域名流量数据,包括服务流量、回源流量数据,单位:byte

  • 支持按指定的起止时间查询,两者需要同时指定

  • 支持批量域名查询,多个域名ID用逗号(半角)分隔

  • 最多可获取最近一年内93天跨度的数据

  • 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度流量值均取该粒度时间段的流量之和

  • 时效性:5分钟延迟

  • 统计方式:按照server IP归属来进行统计

  • 接口性能:接口最大吞吐量为10000,即Region个数*DomainId个数*(EndTime-StartTime)/统计粒度 <= 10000。注:在获取多个域名多个区域合并值时,Region个数和DomainId个数按照1计算

  • 单次查询域名数量不得超过1000个,且单次查询时间跨度至少包含一个时间粒度点(如,粒度为5分钟的时候,单次查询起止时间应大于等于五分钟)。

  • 使用场景:

    • 客户查询单个域名或多域名合并后实时流量数据,用于绘制一条流量线图

    • 客户查询单个域名的详细流量数据,进行数据保存及数据分析

  • 签名机制

    • Service取值:cdn

  • 接入地址:cdn.api.ksyun.com︎

请求语法

本接口请求需要包含指定目录/2016-09-01/statistics/GetFlowData、公共请求header和该接口所特有的请求参数,具体请求语句参照下文请求示例。

请求参数

参数名

类型

是否必须

描述

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

CdnType

String

Y

产品类型,live:流媒体直播

DomainIds

String

N

域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔

Regions

String

N

区域名称,枚举类型表见使用须知,支持多区域查询,多个区域用逗号(半角)分隔,缺省为 CN缺省为 CN

ResultType

Long

Y

取值为0:多域名多区域数据做合并;1:每个域名每个区域的数据分别返回

Granularity

Long

N

统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度流量值均取该粒度时间段的流量总和

DataType

String

N

数据类型,取值为edge:服务数据; origin:回源数据(push:直播推流加速暂不支持查询回源数据); 支持多类型选择,多个类型用逗号(半角)分隔,缺省为edge

ProtocolType

String

N

协议类型, 取值为http:htts协议数据; https:https协议数据;缺省默认返回全部协议数据

返回参数

参数名

类型

描述

StartTime

String

开始时间

EndTime

String

结束时间

CdnType

String

产品类型

DomainIds

String

域名ID列表,逗号(半角)间隔

Regions

String

区域,逗号(半角)间隔,枚举类型表见使用须知

ResultType

Int

取值为0:多域名多区域数据做合并返回;1:每个域名每个区域的数据分别返回

Granularity

Int

统计粒度,取值为 5:5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度流量值均取该粒度时间段的流量总和

DataType

String

数据类型, 取值为edge:服务数据; origin:回源数据; 支持多类型选择,多个类型用逗号(半角)分隔,缺省为edge

Datas

FlowDataByTime[]

每个时间粒度的流量数据

FlowDataByTime

参数名

类型

说明

Time

String

时间点

Flow

Long

服务流量(单位:byte)(所选域名合并值)

SrcFlow

Long

回源流量(单位:byte)(所选域名合并值)

Domains

FlowDataByDomain[]

每个域名的详细流量数据(仅当ResultType取值为1时返回此项数据)

FlowDataByDomain

参数名

类型

描述

DomainId

String

域名ID

Flow

Long

服务流量(单位:byte)(该域名的服务流量,若选择多个区域,则返回该域名多个区域的数据合并值)

SrcFlow

Long

回源流量(单位:byte)(该域名的回源流量,若选择多个区域,则返回该域名多个区域的数据合并值)

Regions

FlowDataByRegion[]

该域名在每个区域的流量详细数据

FlowDataByRegion

参数名

类型

描述

Region

String

区域

Flow

Long

服务流量(单位:byte)(该域名在该区域的服务流量数据)

SrcFlow

Long

回源流量(单位:byte)(该域名在该区域的回源流量数据)

请求示例

GET方式:

GET /2016-09-01/statistics/GetFlowData?StartTime=2016-07-31T21%3A14%2B0800&EndTime=2016-07-31T21%3A16%2B0800&CdnType=live&ResultType=1&Granularity=5&DataType=edge 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetFlowData
x-version: 2016-09-01

POST方式:

POST /2016-09-01/statistics/GetFlowData 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetFlowData
x-version: 2016-09-01
Content-Type: application/json
{
 "StartTime": "2016-07-31T21:14+0800",
 "EndTime": "2016-07-31T21:16+0800",
 "CdnType": "live",
 "ResultType": 1,
 "Granularity": 5,
 "DataType": "edge"
}

返回示例

{
    "StartTime": "2016-07-31T21:14+0800",
    "EndTime": "2016-07-31T21:16+0800",
    "CdnType": "live",
    "DomainIds": "2D09X50,2D09X20",
    "Regions": "CN",
    "ResultType": 1,
    "Granularity": 5,
    "DataType": "edge",
    "Datas": [
        {
            "Time": "2016-07-31T21:15+0800",
            "Flow": 461836768090,
            "Domains": [
                {
                    "DomainId": "2D09X20",
                    "Flow": 461836768090,
                    "Regions": [
                        {
                            "Region": "CN",
                            "Flow": 461836768090
                        }
                    ]
                },
                {
                    "DomainId": "2D09X50",
                    "Flow": 0,
                    "Regions": [
                        {
                            "Region": "CN",
                            "Flow": 0
                        }
                    ]
                }
            ]
        }
    ]
}

错误码

此接口为CDN接口,请到使用须知查看错误码详情。

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈