# 查询CDN用量数据

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getCdnUsageData

该接口用于查询点播 CDN 的流量数据。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/sec/vod/getcdnusagedata?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：153

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "start_time",
    "类型": "number",
    "必填": "是",
    "说明": "起始时间戳。"
  },
  {
    "参数名": "end_time",
    "类型": "number",
    "必填": "是",
    "说明": "截止时间戳。"
  },
  {
    "参数名": "data_interval",
    "类型": "string",
    "必填": "是",
    "说明": "用量数据的时间粒度，单位：分钟，取值有：5：5 分钟粒度，返回指定查询时间内5分钟粒度的明细数据。60：小时粒度，返回指定查询时间内1小时粒度的数据。1440：天粒度，返回指定查询时间内1天粒度的数据。默认值为1440，返回天粒度的数据。"
  },
  {
    "参数名": "query_type",
    "类型": "number",
    "必填": "否",
    "说明": "查询类型，0：通用播放流量和短剧播放器定向流量；1：短剧播放器定向流量；2：通用播放流量。默认值为0。"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "示例": "-",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "示例": "ok",
    "说明": "错误信息"
  },
  {
    "参数名": "data_interval",
    "类型": "number",
    "示例": "-",
    "说明": "时间粒度，单位：分钟。"
  },
  {
    "参数名": "item_list",
    "类型": "objarray",
    "示例": "-",
    "说明": "CDN 统计数据。"
  }
]
```

">

### Res.item_list(Array) `Object Payload`

CDN 统计数据。

```json
[
  {
    "参数名": "time",
    "类型": "number",
    "说明": "数据所在时间区间的开始时间戳。"
  },
  {
    "参数名": "value",
    "类型": "number",
    "说明": "数据大小，单位：字节。"
  }
]
```

## 4. 注意事项

1. 可以查询最近365天内的 CDN 用量数据。
2. 查询时间跨度不超过90天。
3. 可以指定用量数据的时间粒度，支持5分钟、1小时、1天的时间粒度。
4. 流量为查询时间粒度内的总流量。
5. 流量进制换算规则：1GB=1000MB、1MB=1000KB

## 5. 代码示例

请求示例

```json
{
    "start_time": 1682870400,
    "end_time": 1682956800,
    "data_interval": 5
}
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "ok",
    "data_interval": 5,
    "item_list": [
        {
            "time": 1682870400,
            "value": 123
        },
        ...
    ]
}

```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-2",
    "错误描述": "初始化未完成，请稍后再试"
  },
  {
    "错误码": "-1",
    "错误描述": "系统错误"
  },
  {
    "错误码": "43002",
    "错误描述": "HTTP请求必须使用POST方法"
  },
  {
    "错误码": "44002",
    "错误描述": "POST内容为空"
  },
  {
    "错误码": "47001",
    "错误描述": "输入格式错误"
  },
  {
    "错误码": "47003",
    "错误描述": "参数不符合要求"
  },
  {
    "错误码": "10090001",
    "错误描述": "视频类型不支持"
  },
  {
    "错误码": "10090002",
    "错误描述": "图片类型不支持"
  },
  {
    "错误码": "10090003",
    "错误描述": "图片URL无效"
  },
  {
    "错误码": "10090005",
    "错误描述": "resource_type无效"
  },
  {
    "错误码": "10090038",
    "错误描述": "被授权账号没有【文娱-微短剧】类目"
  },
  {
    "错误码": "10090039",
    "错误描述": "已经被解除授权"
  },
  {
    "错误码": "10090040",
    "错误描述": "剧集已经被占用"
  },
  {
    "错误码": "10090041",
    "错误描述": "剧目名称不符合规范"
  },
  {
    "错误码": "10090042",
    "错误描述": "剧集名称不符合规范"
  },
  {
    "错误码": "10090043",
    "错误描述": "不存在授权关系"
  },
  {
    "错误码": "10093011",
    "错误描述": "操作失败"
  },
  {
    "错误码": "10093014",
    "错误描述": "参数错误（包括参数格式、类型等错误）"
  },
  {
    "错误码": "10093023",
    "错误描述": "操作过于频繁"
  },
  {
    "错误码": "10093030",
    "错误描述": "资源不存在"
  }
]
```

## 7. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。