You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /
  • 视频点播

查询媒资存储流量用量

最近更新时间：2024.04.01 18:01:10

首次发布时间：2023.10.16 10:38:47

我的收藏

此接口用于查询点播媒资存储流量用量。

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 权限说明：当使用子账号请求接口时，接口会按照子账号进行权限校验，只返回该子账号有权限的数据。详见给子账号添加项目权限说明。
  • 数据延迟：第二天 8 点前。

请求说明

  • 请求方式：GET
  • 请求地址：https://vod.volcengineapi.com?Action=DescribeVideoStreamOutData&Version=2023-07-01

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数类型是否必选示例值描述
ActionString是DescribeVideoStreamOutData接口名称。当前 API 的名称为 DescribeVideoStreamOutData。
VersionString是2023-07-01接口版本。当前 API 的版本为 2023-07-01。

StartTime

String

否

2023-01-01T16:00:00Z

查询的起始时间，默认 24 小时前。

说明

开始时间最早不早于当前时间的 366 天。

EndTime

String

否

2023-01-02T16:00:00Z

查询的结束时间，默认当前时间。

说明

单次查询的时间跨度不可超过 93 天。

SpaceNamesString否test点播空间名称，默认查询所有空间。如果有多个用逗号 , 连接。

Interval

String

否

86400

聚合的时间粒度。单位为秒。取值如下：

  • 3600：（默认）1 小时。
  • 86400：1 天。
RegionsString否cn-north-1区域。如果有多个用逗号 , 连接。

TrafficType

String

否

archive

流量类型。取值如下：

  • outpublic：外网流出流量，是指您从互联网直接访问下载点播存储内视频源文件（未经视频点播 CDN 加速），产生的外网流出流量。

说明

获取点播媒资流出流量，需要申请白名单，如果有需要，请联系我们开通。

  • lowfreq：低频存储数据取回流量。
  • archive：归档数据取回量。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数类型示例值描述
TotalInteger39937397646存储流量总数，单位为字节。
DetailArray of Detail-存储流量详细数据。

Detail

参数类型示例值描述
TimeStampString2022-12-06T00:00:00+08:00时间。
ValueInteger915流量，单位为字节。

请求示例

GET https://vod.volcengineapi.com?Action=DescribeVideoStreamOutData&Version=2023-07-01&StartTime=2023-01-01T16:00:00Z&EndTime=2023-01-02T16:00:00Z&SpaceNames=test&Interval=86400&Regions=cn-north-1&TrafficType=archive

返回示例

HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "DescribeVideoStreamOutData",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Total": 39937397646,
    "Detail": [
      {
        "TimeStamp": "2022-12-06T00:00:00+08:00",
        "Value": 915
      }
    ]
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。