查询媒资存储流量用量--视频点播-火山引擎

文档中心

立即注册

导航

查询媒资存储流量用量

最近更新时间：2024.07.04 21:56:00首次发布时间：2023.10.16 10:38:47

此接口用于在指定空间维度下，查询一定时间范围内的点播媒资存储流量用量。

注意事项

前提条件：在指定空间维度下，在系统设置 > 上传存储设置下，设置外网访问。具体操作请见外网访问设置
计费说明：媒资存储流量计费价格请参见按量计费
请求频率：单用户请求频率限制为 10 次/秒。
数据延迟：第二天 8 点前。
权限说明：当使用子账号请求接口时，接口会按照子账号进行权限校验，只返回该子账号有权限的数据。详见给子账号添加项目权限说明。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVideoStreamOutData`	接口名称。当前 API 的名称为 `DescribeVideoStreamOutData`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
StartTime	String	否	`2023-01-01T16:00:00Z`	查询的起始时间，默认 24 小时前。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	否	`2023-01-02T16:00:00Z`	查询的结束时间，默认当前时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。说明只能查询最近 93 天数据。
SpaceNames	String	否	`test`	点播空间名称，默认查询所有空间。如果有多个用逗号 `,` 连接。
Interval	String	否	`86400`	聚合的时间粒度。单位为秒。取值如下： `3600`：（默认）1 小时。 `86400`：1 天。
Regions	String	否	`cn-north-1`	区域。如果有多个用逗号 `,` 连接。
TrafficType	String	否	`archive`	流量类型。取值如下： `outpublic`：外网流出流量，是指您从互联网直接访问下载点播存储内视频源文件（未经视频点播 CDN 加速），产生的外网流出流量。 `lowfreq`：低频存储数据取回流量。 `archive`：归档数据取回量。

返回参数

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

参数	类型	示例值	描述
Total	Integer	`39937397646`	存储流量总数，单位为字节。
Detail	Object[]	`-`	存储流量详细数据。
TimeStamp	String	`2022-12-06T00:00:00+08:00`	时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Value	Integer	`915`	流量，单位为字节。

请求示例

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": "20230604110***0232280022D31",
    "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
      }
    ]
  }
}

错误码

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