CDN

查询省份+运营商带宽

最近更新时间:2019-10-16 18:35:45

GetProvinceAndIspBandwidthData

描述

本接口用于获取域名在中国大陆地区各省市及各运营商的带宽数据,仅包括服务节点数据,单位bps

  • 支持按指定的起止时间查询,两者需要同时指定
  • 支持批量域名查询,多个域名ID用逗号(半角)分隔
  • 最多可获取最近一年内93天跨度的数据
  • 统计粒度:5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;1天粒度;以上粒度带宽值均取该粒度时间段的峰值
  • 时效性:5分钟延迟
  • 接口性能:接口最大吞吐量为10000,即Province个数*Isp个数*DomainId个数*(EndTime-StartTime)/统计粒度 <= 10000。 注:在获取多个域名多个省份区域多个运营商合并值时,Province个数、Isp个数和DomainId个数按照1计算
  • 使用场景:
    • 客户查询单个域名或多个域名在各个省份及运营商的合并后的实时带宽数据,用于绘制一条带宽线图
    • 客户查询单个域名的详细带宽数据,进行数据保存及数据分析
    • 客户查询某一天或某1小时的详细带宽区域分布,用于制作流量数据区域用量表

请求语法

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

请求参数:

参数名 必选 类型及范围 说明
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如: 2016-08-01T21:14+0800
CdnType String 产品类型,只允许输入一种类型,取值为file:大文件下载,video:音视频点播,page:图片小文件,live:流媒体直播
DomainIds String 域名ID,缺省为当前产品类型下的全部域名,可输入需要查询的域名ID,支持批量域名查询,多个域名ID用逗号(半角)分隔
Provinces String 省份区域名称, 枚举类型表见使用须知,支持多省份区域查询,多个省份区域用逗号(半角)分隔,缺省为全部省份区域
Isps String 运营商名称,枚举类型表见使用须知,支持多运营商查询,多个运营商用逗号(半角)分隔,缺省为全部运营商
ResultType Int 取值为0:多域名多省份区域多运营商数据做合并;1:每个域名每个省份区域的每个运营商数据分别返回。
Granularity Int 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度

返回参数

参数 类型 描述
StartTime String 开始时间
EndTime String 结束时间
CdnType String 产品类型
DomainIds String 域名ID列表,逗号(半角)间隔
Provinces String 省份区域,逗号(半角)间隔
Isps String 运营商,逗号(半角)分隔
ResultType Int 取值为0:多域名多省份区域多运营商数据做合并;1:每个域名每个省份区域的每个运营商数据分别返回
Granularity Int 统计粒度,取值为 5:5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度
Datas BwDataByTime[] 每个时间粒度的流量数据

BwDataByTime

参数 类型 描述
Time String 时间点
Bw Long 服务带宽(所选域名在所选省份区域及运营商的带宽数据合并值)
Domains BwDataByDomain[] 每个域名的详细带宽数据(仅当ResultType取值为1时返回此项数据))

BwDataByDomain

参数 类型 描述
DomainId String 域名ID
Bw Long 服务带宽(该域名的服务带宽,若选择多个省份区域多个运营商,则返回该域名多个省份区域多个运营商的数据合并值)
Provinces BwDataByProvince[] 该域名在每个省份区域的带宽详细数据

BwDataByProvince

参数 类型 描述
Province String 省份区域
Bw Long 服务带宽(该域名在该省份区域的服务带宽数据)
Isps BwDataByIsp[] 该域名在该省份每个运营商的带宽详细数据

BwDataByIsp

参数 类型 描述
Isp String 运营商
Bw Long 服务带宽(该域名在该省份区域该运营商的服务带宽数据)

示例

请求示例

GET方式:

GET /2016-09-01/statistics/GetProvinceAndIspBandwidthData?StartTime=2019-08-21T16%3A00%2B0800&EndTime=2019-08-22T18%3A00%2B0800&CdnType=download&DomainIds=&Provinces=&Isps=&ResultType=1&Granularity=1440&GroupNames=yhtest%2Ccywtest 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetProvinceAndIspBandwidthData
x-version: 2016-09-01

POST方式:

POST /2016-09-01/statistics/GetProvinceAndIspBandwidthData 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetProvinceAndIspBandwidthData 
x-version: 2016-09-01
Content-Type: application/json

{
    "StartTime": "2019-08-21T16:00+0800",
    "EndTime": "2019-08-22T18:00+0800",
    "CdnType": "download",
    "DomainIds": "",
    "Provinces": "",
    "Isps": "",
    "ResultType": 1,
    "Granularity": 1440,
    "GroupNames": "yhtest,cywtest"
}

返回示例

{
    "StartTime": "2019-08-21T16:00+0800",
    "EndTime": "2019-08-22T18:00+0800",
    "CdnType": "download",
    "DomainIds": "2D097ND,2D097NF,2D09702,2D096XT",
    "Provinces": "anhui,beijing,chongqing,fujian,gansu,guangdong,guangxi,guizhou,hainan,hebei,heilongjiang,henan,hubei,hunan,jiangsu,jiangxi,jilin,liaoning,neimenggu,ningxia,qinghai,shandong,shanghai,shaanxi,shanxi,sichuan,tianjin,yunnan,xinjiang,xizang,zhejiang",
    "Isps": "UN,CM,CT,CTT,PBS,CE,Other",
    "ResultType": 1,
    "Granularity": 1440,
    "GroupNames": "yhtest,cywtest",
    "Datas": [
        {
            "Time": "2019-08-22T00:00+0800",
            "Bw": 1097,
            "Domains": [
                {
                    "DomainId": "2D096XT",
                    "Bw": 155,
                    "Provinces": [
                        {
                            "Province": "shandong",
                            "Bw": 155,
                            "Isps": [
                                {
                                    "Isp": "CT",
                                    "Bw": 155
                                }
                            ]
                        }
                    ]
                },
                {
                    "DomainId": "2D09702",
                    "Bw": 1097,
                    "Provinces": [
                        {
                            "Province": "shandong",
                            "Bw": 1097,
                            "Isps": [
                                {
                                    "Isp": "CT",
                                    "Bw": 1097
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

金山云,开启您的云计算之旅

注册有礼