全部文档
当前文档

暂无内容

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

文档中心

泛域名明细流量查询

最近更新时间:2022-09-27 15:35:20

GetSubDomainsFlowData

描述

获取泛域名次级域名流量数据,包括服务流量、回源流量数据,单位:byte

  • 支持按指定的起止时间查询,两者需要同时指定(时间跨度不允许超过24小时)
  • 支持批量次级域名查询,多个域名ID用逗号(半角)分隔
  • 最多可查询最近62天范围内任意一天跨度的数据
  • 支持按照协议类型查询流量数据,协议类型ProtocolType为非必选参数,缺省则不区分协议类型,返回各个协议类型求和后的流量数据
  • 统计粒度:1天粒度;5分钟粒度;10分钟粒度;20分钟粒度;1小时粒度;4小时粒度;8小时粒度;以上粒度均取该粒度时间段的流量之和
  • 统计方式:按照server IP归属来进行统计
  • 时效性:5分钟延迟
  • 单次查询域名数量不得超过1000个,且单次查询时间跨度至少包含一个时间粒度点(如,粒度为5分钟的时候,单次查询起止时间应大于等于五分钟)。
  • 使用场景:
    • 客户查询单个域名或多域名合并后实时流量数据,用于绘制一条流量线图
    • 客户查询单个域名的详细流量数据,进行数据保存及数据分析

请求语法

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

请求参数

参数名称 是否必选 参数类型 示例值 参数说明
DomainId String 2D099E6 泛域名ID
Domains String www.cmcm.com,A.cmcm.com 可输入需要查询的次级域名,支持批量域名查询,多个次级域名间用逗号(半角)分隔 ,但查询次级域名的个数≤1000个
StartTime String 2022-07-31T21:14+0800 查询数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800
EndTime String 2022-07-31T21:14+0800 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,起始时间至结束时间的时间跨度需在24小时之内(包括24小时)
Regions String CN 区域名称,枚举类型表见使用须知,支持多区域查询,多个区域用逗号(半角)分隔,缺省为 CN缺省为 CN
ResultType Long 1 取值为0:多域名多区域数据做合并;1:每个域名每个区域的数据分别返回
Granularity Long 5 统计粒度,取值为 5(默认):5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度均取该粒度时间段的流量总和
DataType String edge 数据类型, 取值为edge:服务数据; origin:回源数据; 支持多类型选择,多个类型用逗号(半角)分隔,缺省为 edge
ProtocolType String http 协议类型, 取值为http:http协议数据; https:https协议数据;缺省默认返回全部协议数据

返回参数

参数名称 参数类型 示例值 参数说明
DomainId String 2D099E6 泛域名ID
StartTime String 2022-07-31T21:14+0800 开始时间
EndTime String 2022-07-31T23:14+0800 结束时间
Domains String www.cmcm.com,A.cmcm.com 泛域名的次级域名列表,逗号(半角)间隔
Regions String CN 区域,逗号(半角)间隔,枚举类型表见使用须知
ResultType Long 1 取值为0:多域名多区域数据做合并返回;1:每个域名每个区域的数据分别返回
Granularity Long 5 统计粒度,取值为 5:5分钟粒度;10:10分钟粒度;20:20分钟粒度;60:1小时粒度;240:4小时粒度;480:8小时粒度;1440:1天粒度;以上粒度均取该粒度时间段的流量总和
DataType String edge 数据类型, 取值为edge:服务数据; origin:回源数据; 支持多类型选择,多个类型用逗号(半角)分隔,缺省为edge
Datas FlowDataByTime[] 每个时间粒度的流量数据

FlowDataByTime

参数名称 参数类型 示例值 参数说明
Time String 2022-07-31T21:14+0800 时间点
Flow Long 8000 服务流量(单位:byte)(所选域名合并值)
SrcFlow Long 0 回源流量(单位:byte)(所选域名合并值)
Domains FlowDataByDomain[] 每个次级域名的详细流量数据(仅当ResultType取值为1时返回此项数据)

FlowDataByDomain

参数名称 参数类型 示例值 参数说明
Domain String www.cmcm.com 某个具体的次级域名
Flow Long 8000 服务流量(单位:byte)(该域名的服务流量,若选择多个区域,则返回该域名多个区域的数据合并值)
SrcFlow Long 0 回源流量(单位:byte)(该域名的回源流量,若选择多个区域,则返回该域名多个区域的数据合并值)
Regions FlowDataByRegion[] 该域名在每个区域的流量详细数据
FlowDataByRegion
参数名称 参数类型 示例值 参数说明
Region String CN 区域
Flow Long 0 服务流量(单位:byte)(该域名在该区域的服务流量数据)
SrcFlow Long 0 回源流量(单位:byte)(该域名在该区域的回源流量数据)

示例

请求示例

Get方式

GET /2016-09-01/statistics/GetSubDomainsFlowData?StartTime=2016-07-31T21:14%2b0800&EndTime=2016-07-31T21:16%2b0800&ResultType=1&Granularity=5&DataType=edge&ProtocolType=http 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetSubDomainsFlowData
x-version: 2016-09-01

Post方式

POST /2016-09-01/statistics/GetSubDomainsFlowData 1.1
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: GetSubDomainsFlowData
x-version: 2016-09-01
Content-Type: application/json
{
    "DomainId": "2D099E6",
    "Domains": "www.cmcm.com,A.cmcm.com",
    "StartTime": "2017-11-06T00:00+0800",
    "EndTime": "2017-11-06T00:05+0800",
    "Regions": "CN,NA",
    "ResultType": 1,
    "Granularity": 5,
    "DataType": "origin,edge",
    "ProtocolType":"http"
}

返回示例

返回示例1(ResultType=0)

{
    "StartTime": "2017-11-06T00:00+0800",
    "EndTime": "2017-11-06T00:05+0800",
    "DomainId": "2D099E6",
    "Domains": "www.cmcm.com,A.cmcm.com",
    "ResultType": 0,
    "Granularity": 5,
    "Regions": "CN,NA",
    "DataType": "origin,edge",
    "Datas": [
        {
            "Time": "2017-11-06T00:00+0800",
            "Flow": 300000,
            "SrcFlow": 0
        }
    ]
}

返回示例2(ResultType=1)

{
    "StartTime": "2017-11-06T00:00+0800",
    "EndTime": "2017-11-06T00:05+0800",
    "DomainId": "2D099E6",
    "Domains": "www.cmcm.com,A.cmcm.com",
    "ResultType": 1,
    "Regions": "CN,NA",
    "Granularity": 5,
    "DataType": "origin,edge",
    "Datas": [
        {
            "Time": "2017-11-06T00:00+0800",
            "Flow": 300000,
            "SrcFlow": 0,
            "Domains": [
                {
                    "Domain": "www.cmcm.com",
                    "Flow": 300000,
                    "SrcFlow": 0,
                    "Regions": [
                        {
                            "Region": "CN",
                            "Flow": 20000,
                            "SrcFlow": 0
                        },
                        {
                            "Region": "NA",
                            "Flow": 50000,
                            "SrcFlow": 0
                        }
                    ]
                },
                {
                    "Domain": "A.cmcm.com",
                    "Flow": 10000,
                    "SrcFlow": 0,
                    "Regions": [
                        {
                            "Region": "CN",
                            "Flow": 20000,
                            "SrcFlow": 0
                        },
                        {
                            "Region": "NA",
                            "Flow": 30000,
                            "SrcFlow": 0
                        }
                    ]
                }
            ]
        }
    ]
}

错误码

为了帮您快速定位问题,CDN将错误码集中归类,请到【使用须知】查看详情。

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

纯净模式

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