获取多个域名的省份和 ISP 的细分数据--内容分发网络-火山引擎

文档中心

导航

获取多个域名的省份和 ISP 的细分数据

最近更新时间：2024.06.28 19:18:53首次发布时间：2022.09.28 11:51:43

说明

在新版数据统计接口中，该 API 没有更新，可继续使用。

基于指定的时间段和时间粒度，对一个或多个域名统计访问请求指标的数据。指标数据是按统计时间段统计的，细分到中国省份行政区以及 ISP。参见 DescribeCdnData 文档中的统计时间段说明。

数据稳定性：受边缘节点网络波动的影响，监控数据的统计可能会发生变化。大多数情况下，监控数据的统计会在数据产生后的 12 小时内稳定下来。

指标名称	指标描述	筛选维度
流量	表示内容分发网络响应访问请求所传输的流量。该 API 对每个统计时间段的流量进行统计。	支持按应用层协议、网络层协议对这些指标进行筛选。
带宽	表示内容分发网络响应访问请求所产生的带宽，单位是 bps。如果指定的时间粒度是 1 分钟或 5 分钟，每个统计时间段的带宽按以下方式统计： `流量` * 8 / `统计时间段的时间`。`时间`的单位是秒。如果指定的时间粒度是 1 小时或 1 天，指定时间段的带宽的统计步骤如下：确定统计时间段。参见 DescribeCdnData 文档中的统计时间段说明。基于指定的时间粒度，对每个统计时间段统计带宽。带宽按以下方式统计：先以 5 分钟粒度统计一系列带宽数据，然后计算这些数据的最大值。计算这些统计时间段带宽的最大值。关于统计方式的示例，参见 DescribeEdgeNrtDataSummary 文档中的统计示例。
请求数	表示访问请求的数量。该 API 对每个统计时间段的请求数量进行统计。
QPS	表示访问请求的 QPS。如果指定的时间粒度是 1 分钟或 5 分钟，每个统计时间段的的 QPS 按以下方式统计： `请求数` / `统计时间段的时间`。`时间`的单位是秒。如果指定的时间粒度是 1 小时或 1 天，指定时间段的 QPS 的统计步骤如下：确定统计时间段。参见 DescribeCdnData 文档中的统计时间段说明。基于指定的时间粒度，对每个统计时间段统计 QPS。QPS 按以下方式统计：先以 5 分钟粒度统计一系列 QPS 数据，然后计算这些数据的最大值。计算这些统计时间段 QPS 的最大值。关于统计方式的示例，参见 DescribeEdgeNrtDataSummary 文档中的统计示例。
状态码	表示内容分发网络响应访问请求的状态码数量。该 API 对每个统计时间段的状态码数量进行统计。

使用限制

节流限制：您每秒最多可以发送 20 个 API 请求。

时间限制：系统保留最近 92 天的访问数据。您不能查询 92 天以前的访问数据。

数据延迟：访问数据延迟约为 5 分钟。

请求说明

请求方式：POST
请求地址：https://cdn.volcengineapi.com/?Action=DescribeDistrictIspData&Version=2021-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeDistrictIspData`。
Version	String	是	接口版本。当前 API 的版本为 `2021-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
StartTime	Long	是	指定一个开始时间。时间格式是 Unix 时间戳，精度是秒。`StartTime` 必须早于或者等于 `EndTime`。同时，`StartTime` 与 `EndTime` 所指定的时间段不能超过 7 天。您必须同时指定 `StartTime` 和 `EndTime`，或者都不指定。如果您不指定这 2 个参数，默认统计最近 1 小时的数据。 `StartTime`、`EndTime`、`Interval` 这三个参数决定了该 API 对哪些时间段做数据统计。参见 DescribeCdnData 文档中的统计时间段说明。	`1641844915`
EndTime	Long	是	指定一个结束时间。时间格式是 Unix 时间戳，精度是秒。	`1641845373`
Metric	String	是	指定一个指标。该参数的可用值如下： `flux`：表示访问数据的流量。单位是 Byte。 `bandwidth`：表示访问数据的带宽。单位是bps。 `pv`：表示访问的请求数。单位是个。 `qps`：表示访问请求的 QPS 峰值。单位是次/秒。 `status_2xx`：表示数字 2 开头的所有状态码的数量，以及数字 2 开头且数量不为 0 的每个状态码的数量。 `status_3xx`：表示数字 3 开头的所有状态码的数量，以及数字 3 开头且数量不为 0 的每个状态码的数量。 `status_4xx`：表示数字 4 开头的所有状态码的数量，以及数字 4 开头且数量不为 0 的每个状态码的数量。 `status_5xx`：表示数字 5 开头的所有状态码的数量，以及数字 5 开头且数量不为 0 的每个状态码的数量。	`flux`
Domain	String	是	指定一个或多个域名进行统计。最多可以指定 50 域名。多个域名使用英文逗号（,）分隔。	`www.example.com,www.test.com`
Interval	String	否	指定一个时间粒度。基于这个粒度，对访问数据进行细分统计。 `StartTime`、`EndTime`、`Interval` 这三个参数决定了该 API 对哪些时间段做数据统计。参见 DescribeCdnData 文档中的统计时间段说明。该参数的可用值如下： `1min`：表示以 1 分钟为时间粒度。 `5min`：表示以 5 分钟为时间粒度。 `hour`：表示以 1 小时为时间粒度。 `day`：表示以 1 天为时间粒度。您可以指定的时间粒度与`StartTime` 和 `EndTime` 指定的时间范围的关系如下：如果时间范围 <= 10 分钟，您可以指定的时间粒度有 `1min`、`5min`。如果时间范围 > 10 分钟并且 <= 1 小时，您可以指定的时间粒度有 `5min`。如果时间范围 > 1 小时并且 <= 12 小时，您可以指定的时间粒度有 `hour`。如果时间范围 > 12 小时并且 <= 7 天，您可以指定的时间粒度有 `day`。如果不指定该参数，该参数使用默认值 `5min`。如果默认值不匹配时间范围，API 请求会失败。	`1min`
Protocol	String	否	指定请求的一个应用层协议。该参数的可用值如下： `http`：表示 HTTP 协议。 `https`：表示 HTTPS 协议。 `quic`：表示 QUIC 协议。如果不指定该参数，表示包含所有支持的应用层协议。	`http`
IpVersion	String	否	指定请求的一个网络层协议。该参数的可用值如下： `ipv4`：表示 IPv4 访客的请求。 `ipv6`：表示 IPv6 访客的请求。如果不指定该参数，表示包含所有支持的网络层协议。	`ipv6`
Aggregate	String	否	指定是否汇总所有域名的指标。该参数适用于指定多个域名场景。该参数的可用值如下： `aggregate`：API 仅返回所有域名的汇总指标。 `disaggregate`：API 返回每个域名的指标。如果不指定该参数，该参数的取值是 `aggregate`。	`disaggregate`

响应正文

参数名称	数据类型	参数说明	示例
Resources	Object[]	表示返回的结果对象。

请求示例

POST https://cdn.volcengineapi.com/?Action=DescribeDistrictIspData&Version=2021-03-01
{
  "StartTime": 1664273781,
  "EndTime": 1664275781,
  "Domain": "www.example.com,www.test.com",
  "Metric": "bandwidth",
  "Aggregate": "disaggregate"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2022092721124501017424914801885697",
    "Action": "DescribeDistrictIspData",
    "Version": "2021-03-01",
    "Service": "cdn",
    "Region": "cn-north-1"
  },
  "Result": {
    "Resources": [
      {
        "DataDetails": [
          {
            "Isp": "CT",
            "Metrics": [
              {
                "Metric": "bandwidth",
                "Values": [
                  {
                    "Timestamp": 1664273700,
                    "Value": 776052.3456
                  },
                  {
                    "Timestamp": 1664274000,
                    "Value": 768363.5808
                  },
                  {
                    "Timestamp": 1664274300,
                    "Value": 791435.8944
                  },
                  {
                    "Timestamp": 1664274600,
                    "Value": 791435.0304
                  },
                  {
                    "Timestamp": 1664274900,
                    "Value": 806817.6576
                  },
                  {
                    "Timestamp": 1664275200,
                    "Value": 799129.6992
                  },
                  {
                    "Timestamp": 1664275500,
                    "Value": 783782.928
                  }
                ]
              }
            ],
            "Region": "BJ"
          }
        ],
        "Name": "www.example.com"
      },
      {
        "DataDetails": [
          {
            "Isp": "CT",
            "Metrics": [
              {
                "Metric": "bandwidth",
                "Values": [
                  {
                    "Timestamp": 1664273700,
                    "Value": 576591.12
                  },
                  {
                    "Timestamp": 1664274000,
                    "Value": 553514.4
                  },
                  {
                    "Timestamp": 1664274300,
                    "Value": 591973.5168
                  },
                  {
                    "Timestamp": 1664274600,
                    "Value": 576590.1984
                  },
                  {
                    "Timestamp": 1664274900,
                    "Value": 561206.88
                  },
                  {
                    "Timestamp": 1664275200,
                    "Value": 599664.2688
                  },
                  {
                    "Timestamp": 1664275500,
                    "Value": 530457.8976
                  }
                ]
              }
            ],
            "Region": "BJ"
          }
        ],
        "Name": "www.test.com"
      }
    ]
  }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。更多关于错误码的信息，参见错误码。