全部文档
当前文档

暂无内容

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

文档中心

查询带宽环比

最近更新时间:2024-08-02 11:43:20

GetBandwidthPeriodRatioData

描述

本接口用于获取域名带宽环比数据,单位bps

  • 支持指定两组起止时间查询环比,需要同时指定,两组起止时间时间跨度需相同

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

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

  • 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;
    以上粒度的带宽值均取该粒度时间段的带宽峰值,即每5分钟有效带宽值的最高带宽

  • 时效性:5分钟延迟

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

  • 接口性能:接口最大吞吐量为10000,即Region个数*DomainId个数*(EndTime-StartTime)/统计粒度 <= 10000。

  • 注:在获取多个域名多个区域合并值时,Region个数和DomainId个数按照1计算

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

  • 使用场景:

    • 客户查询单个域名或多个域名合并后实时带宽数据,用于绘制两条带宽环比图线

    • 客户查询单个域名的详细带宽环比数据,进行数据保存及数据分析

请求语法

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

请求参数

参数名

必选

类型及范围

说明

CurrentPeriodStartTime

String

获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800

CurrentPeriodEndTime

String

结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800。
注:CurrentPeriodStartTime至CurrentPeriodEndTime的时间段长度应与PriorPeriodStartTime至PriorPeriodEndTime的时间段长度保持一致

PriorPeriodStartTime

String

获取数据起始时间点,不可与CurrentPeriodStartTime相同,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800

PriorPeriodEndTime

String

结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
注:CurrentPeriodStartTime至CurrentPeriodEndTime的时间段长度应与PriorPeriodStartTime至PriorPeriodEndTime的时间段长度保持一致

CdnType

String

产品类型,允许输入多个产品类型,取值为file:大文件下载,video:音视频点播,page:小文件下载,live:流媒体直播

DomainIds

String

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

Regions

String

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

Granularity

Long

统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度的带宽值均取该粒度时间段的带宽峰值,即每5分钟有效带宽值的最高带宽

DataType

String

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

ProtocolType

String

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

返回参数

参数名

类型及范围

说明

CurrentPeriodStartTime

String

开始时间

CurrentPeriodEndTime

String

结束时间

PriorPeriodStartTime

String

开始时间

PriorPeriodEndTime

String

结束时间

CdnType

String

产品类型

DomainIds

String

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

Regions

String

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

Granularity

Long

统计粒度,取值为 5:5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度的带宽值均取该粒度时间段的带宽峰值,即每5分钟有效带宽值的最高带宽

DataType

String

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

Datas

BpsDataByTime[]

每个时间粒度的带宽数据

BpsDataByTime

参数名

类型及范围

说明

CurrentPeriodTime

String

时间点

PriorPeriodTime

String

时间点

CurrentPeriodBw

Long

带宽(单位bps)(所选域名、区域合并值)

PriorPeriodBw

Long

带宽(单位bps)(所选域名、区域合并值)

PeriodRatio

Long

环比百分数,单位“%”

示例

请求示例

GET方式:

GET /2016-09-01/statistics/GetBandwidthPeriodRatioData?CurrentPeriodStartTime=2016-07-31T21:17%2b0800& CurrentPeriodEndTime=2016-07-31T21:26%2b0800&PriorPeriodStartTime=2016-07-31T21:07%2b0800&PriorPeriodEndTime=2016-07-31T21:16%2b0800&CdnType=video&Granularity=5&DataType=edge 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetBandwidthPeriodRatioData
x-version: 2016-09-01

POST方式:

POST /2016-09-01/statistics/GetBandwidthPeriodRatioData 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetBandwidthPeriodRatioData
x-version: 2016-09-01
Content-Type: application/json
{
   "CurrentPeriodStartTime": "2016-07-31T21:17+0800",
   "CurrentPeriodEndTime": "2016-07-31T21:26+0800",
   "PriorPeriodStartTime": "2016-07-31T21:07+0800",
   "PriorPeriodEndTime": "2016-07-31T21:16+0800",
   "CdnType": "video",
   "Granularity": 5,
   "DataType": "edge"
}

返回示例

{    
  "CurrentPeriodStartTime": "2016-07-31T21:17+0800",
  "CurrentPeriodEndTimeEndTime": "2016-07-31T21:26+0800",
  "PriorPeriodStartTime": "2016-07-31T21:07+0800",
  "PriorPeriodEndTime": "2016-07-31T21:16+0800",    
  "CdnType": "video",    
  "DomainIds": "2D09X50,2D09X20",    
  "Regions": "CN",    
  "Granularity": 5,    
  "DataType": "edge",   
  "Datas": [       
      {            
          "CurrentPeriodTime": "2016-07-31T21:20+0800",            
          "PriorPeriodTime": "2016-07-31T21:10+0800",            
          "CurrentPeriodBw": 5480,
          "PriorPeriodBw": 4480,            
          "PeriodRatio": 18.25
      }
      {
          "CurrentPeriodTime": "2016-07-31T21:25+0800",            
          "PriorPeriodTime": "2016-07-31T21:15+0800",            
          "CurrentPeriodBw": 5670,
          "PriorPeriodBw": 5560,            
          "PeriodRatio": 1.98       
      }
   ]
}

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

纯净模式

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