跳转至

获取分发统计数据

1. 接口描述

接口请求路径:POST /prod-api/acdn/acdnStatisticsRest/describeData

describeData 用于查询海外 ACDN 分发的 CloudWatch 监控数据,支持请求数、下载流量及 HTTP 状态码分布。一次请求可在 action 中声明多个指标,返回字段与所请求的指标对应。

仅支持查询最近 360 天内的数据。Token 获取方式见 密钥鉴权

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
action Array 统计指标列表
action.metricName String 统计指标,支持以下值:
status:HTTP 状态码分布
Requests:请求总数
BytesDownloaded:下载总流量(字节)
示例值:Requests
interval Integer 统计粒度,支持以下值:
3:每 5 分钟
2:每小时
1:每天
示例值:2
params Object 时间范围
params.beginTime String 开始时间,格式 yyyy-MM-dd HH:mm:ss
示例值:2024-09-13 00:00:00
params.endTime String 结束时间,格式 yyyy-MM-dd HH:mm:ss
示例值:2024-09-20 23:59:59
distributionNames Array of String 待统计的分发 ID(CloudFront Distribution ID)列表
示例值:["E22HJMKYBSO11", "E30T0A73CZW42"]

3. 示例

示例1 查询请求数、流量与状态码

输入示例

{
  "action": [
    {
      "metricName": "Requests"
    },
    {
      "metricName": "BytesDownloaded"
    },
    {
      "metricName": "status"
    }
  ],
  "interval": 2,
  "params": {
    "beginTime": "2024-09-13 00:00:00",
    "endTime": "2024-09-20 23:59:59"
  },
  "distributionNames": ["E22HJMKYBSO11", "E30T0A73CZW42"]
}

代码调用

请将 {登录域名}token 替换为实际值。

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class DescribeAcdnDataTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/acdn/acdnStatisticsRest/describeData";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"action\":["
                + "{\"metricName\":\"Requests\"},"
                + "{\"metricName\":\"BytesDownloaded\"},"
                + "{\"metricName\":\"status\"}"
                + "],"
                + "\"interval\":2,"
                + "\"params\":{"
                + "\"beginTime\":\"2024-09-13 00:00:00\","
                + "\"endTime\":\"2024-09-20 23:59:59\""
                + "},"
                + "\"distributionNames\":[\"E22HJMKYBSO11\",\"E30T0A73CZW42\"]"
                + "}";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Authorization", "Bearer " + token);
            httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));

            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                int statusCode = response.getStatusLine().getStatusCode();
                String body = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("Status Code: " + statusCode);
                System.out.println("Body: " + body);
            }
        }
    }
}
package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://{登录域名}/prod-api/acdn/acdnStatisticsRest/describeData"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "action": [
    { "metricName": "Requests" },
    { "metricName": "BytesDownloaded" },
    { "metricName": "status" }
  ],
  "interval": 2,
  "params": {
    "beginTime": "2024-09-13 00:00:00",
    "endTime": "2024-09-20 23:59:59"
  },
  "distributionNames": ["E22HJMKYBSO11", "E30T0A73CZW42"]
}`)

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println("Status Code:", resp.StatusCode)
    fmt.Println("Body:", string(body))
}

输出示例

{
  "msg": "操作成功",
  "code": 200,
  "data": {
    "eRequests": {
      "total": 96,
      "list": [
        [1726185600000, 12],
        [1726189200000, 84]
      ]
    },
    "eBytesDownloaded": {
      "total": 1048576,
      "list": [
        [1726185600000, 524288],
        [1726189200000, 524288]
      ]
    },
    "e_4xxStatus": [
      [1726185600000, 4],
      [1726189200000, 8]
    ],
    "e_5xxStatus": [
      [1726185600000, 2],
      [1726189200000, 6]
    ],
    "e_otherStatus": [
      [1726185600000, 6],
      [1726189200000, 70]
    ],
    "e_4xxStatus_total": 12,
    "e_5xxStatus_total": 8,
    "e_otherStatus_total": 76
  }
}

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:操作成功
data Object 统计数据,字段随 action.metricName 动态返回
data.eRequests Object 请求数(请求 Requests 时返回)
data.eRequests.total Number 请求总数。示例值:96
data.eRequests.list Array 时序数据,每项为 [Unix 毫秒时间戳, 数值]
data.eBytesDownloaded Object 下载流量(请求 BytesDownloaded 时返回)
data.eBytesDownloaded.total Number 下载总字节数。示例值:1048576
data.eBytesDownloaded.list Array 时序数据,每项为 [Unix 毫秒时间戳, 字节数]
data.e_4xxStatus Array 4xx 状态码时序数据(请求 status 时返回),每项为 [Unix 毫秒时间戳, 数值]
data.e_5xxStatus Array 5xx 状态码时序数据(请求 status 时返回),每项为 [Unix 毫秒时间戳, 数值]
data.e_otherStatus Array 其他状态码时序数据(请求 status 时返回),每项为 [Unix 毫秒时间戳, 数值]
data.e_4xxStatus_total Number 4xx 请求总数。示例值:12
data.e_5xxStatus_total Number 5xx 请求总数。示例值:8
data.e_otherStatus_total Number 其他状态码请求总数。示例值:76

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
请选择时间范围 未传入 params,或缺少 beginTime / endTime
只能查询最近360天的数据 开始时间超出 360 天范围,或查询跨度超过 360 天