You need to enable JavaScript to run this app.
导航
查询直播时移存储用量
最近更新时间:2023.10.12 17:39:58首次发布时间:2022.02.24 18:33:53

指定时间范围,查询每日直播时移功能的存储用量。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询直播时移存储用量接口。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 用量查询:该接口适用于视频直播提供时移能力的场景,如时移文件存储于视频点播 VoD 或对象存储 ToS,请联系我们,获取用量查询方法。

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=DescribeLiveTimeShiftData&Version=2020-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeLiveTimeShiftData接口名称。当前 API 的名称为 DescribeLiveTimeShiftData
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述

Vhosts

Array of String

["www.example.com","www.example2.com"]

域名空间列表,缺省情况表示查询该用户的所有域名空间。
例如,["www.example.com","www.example2.com"]

StartTimeString2022-02-17T23:59:59+08:00开始时间,RFC3339 格式的 UTC 时间,精度为 s,例如:2022-04-01T00:00:00+08:00
EndTimeString2022-02-11T00:00:00+08:00结束时间,RFC3339 格式的 UTC 时间,精度为 s,例如:2022-04-01T00:00:00+08:00
AggregationInteger86400聚合时间粒度,单位秒,支持配置为 86400,支持查询最近 90 天内的数据,单次查询时间范围 90 天

返回参数

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

参数类型示例值描述
VhostsArray of String["www.example.com","www.example2.com"]域名空间列表
StartTimeString2022-02-16T00:00:00+08:00开始时间
EndTimeString2022-02-17T23:59:59+08:00结束时间天
TimeShiftDataListArray of TimeShiftDataList-时移存储数据

TimeShiftDataList

参数类型示例值描述
TimeStampString2022-02-16T00:00:00+08:00时间点,默认为每日的结束时间。例如,返回 2022-02-16T00:00:00+08:00,表示取该时刻的存储用量作为 2 月 16 日的计费用量
StorageDouble4503380存储用量,单位为 GB

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveTimeShiftData&Version=2020-08-01
{
  "Aggregation": 86400,
  "EndTime": "2022-02-17T23:59:59+08:00",
  "StartTime": "2022-02-11T00:00:00+08:00",
  "Vhosts": [
    "www.example.com"
  ]
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"20180604110420010010****",
        "Action":"DescribeLiveTimeShiftData",
        "Version":"2020-08-01",
        "Service":"live",
        "Region":"cn-north-1"
    },
    "Result":{
        "Vhosts": ["www.example.com"],
        "StartTime": "2022-02-16T00:00:00+08:00",
        "EndTime":"2022-02-17T23:59:59+08:00",
        "TimeShiftDataList":[
          {
            "TimeStamp":"2022-02-16T00:00:00+08:00",
            "Storage":4503380,     // 存储用量,单位GB
          },
          {
            "TimeStamp":"2022-02-16T00:05:00+08:00",
            "Storage":4503380,     // 存储用量,单位GB
          }
      	]
    }
}

错误码

访问公共错误码获取详细信息。