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

文档中心

立即注册

导航

视频点播

查询媒资存储流量用量

最近更新时间：2023.08.02 17:46:50首次发布时间：2023.08.01 19:36:47

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

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
数据延迟：第二天 8 点前。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVideoStreamOutData`	接口名称。当前 API 的名称为 `DescribeVideoStreamOutData`。
Version	String	是	`2021-01-01`	接口版本。当前 API 的版本为 `2021-01-01`。
StartTime	String	否	`2022-01-17T00:00:00+08:00`	查询的起始时间，默认 24 小时前。
EndTime	String	否	`2022-01-18T00:00:00+08:00`	查询的结束时间，默认当前时间。说明只能查询最近 93 天数据。
SpaceNames	String	否	`test`	点播空间名称，默认查询所有空间。如果有多个用逗号 `,` 连接。
Interval	String	否	`3600`	聚合的时间粒度。单位为秒。取值如下： `3600`：（默认）1 小时。 `86400`：1 天。
Regions	String	否	`cn-north-1`	区域。如果有多个用逗号 `,` 连接。
TrafficType	String	是	`lowfreq`	流量类型。取值如下： `outpublic`：外网流出流量，是指您从互联网直接访问下载点播存储内视频源文件（未经视频点播 CDN 加速），产生的外网流出流量。说明获取点播媒资流出流量，需要申请白名单，如果有需要，请联系我们开通。 `lowfreq`：低频存储数据取回流量。 `archive`：归档数据取回量。

返回参数

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

参数	类型	示例值	描述
Total	Integer	`11604572056`	存储流量总数，单位为字节。
Detail	Array of Detail		存储流量详细数据。

Detail

参数	类型	示例值	描述
TimeStamp	String	`2022-12-06T00:00:00+08:00`	时间。
Value	Integer	`117145232`	流量，单位为字节。

示例

请求示例

GET https://vod.volcengineapi.com?Action=DescribeVideoStreamOutData&Version=2021-01-01&EndTime=2022-01-18T00%3A00%3A00%2B08%3A00&Interval=3600&Regions=cn-north-1&SpaceNames=test&StartTime=2022-01-17T00%3A00%3A00%2B08%3A00&TrafficType=lowfreq

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230801160738******FD57D0F6004A78",
        "Action": "DescribeVideoStreamOutData",
        "Version": "2021-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 11604572056,
        "Detail": [
            {
                "TimeStamp": "2023-07-25T00:00:00+08:00",
                "Value": 117145232
            }
        ]
    }
}

错误码

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