DescribeLiveTimeShiftData - 查询直播时移存储用量--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveTimeShiftData - 查询直播时移存储用量

最近更新时间：2024.12.09 11:16:50首次发布时间：2023.09.25 14:35:35

调用 DescribeLiveTimeShiftData 接口，查询指定时间范围内直播时移功能产生的存储用量。

注意事项

计费说明：时移费用请参见时移计费。
使用限制：当前接口适用于视频直播提供时移文件存储的场景；如时移文件存储于视频点播（VOD）或对象存储（TOS）时，请创建工单联系我们获取存储用量查询方法。
请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：每日 08:00 后可查询前一日数据。
数据进制：存储容量数据统计进制为 1024，例如，1 GB = 1024 MB。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeLiveTimeShiftData`	接口名称。当前 API 的名称为 `DescribeLiveTimeShiftData`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
Aggregation	Integer	否	`86400`	数据聚合的时间粒度，单位为秒，当前接口默认且仅支持按 `86400` 秒进行数据聚合。
EndTime	String	是	`2022-02-17T23:59:59+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
StartTime	String	是	`2022-02-11T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。说明单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。
Vhosts	Array of String	否	`["push.example.com"]`	域名空间列表，默认为空，表示查询您视频直播产品下所有域名产生的时移存储用量数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取域名所在的域名空间信息。

返回参数

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

参数	类型	示例值	描述
Vhosts	Array of String	`["push.example.com"]`	域名空间列表。
StartTime	String	`2022-02-16T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2022-02-17T23:59:59+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`86400`	数据聚合的时间粒度，单位为秒。
TimeShiftDataList	Array of TimeShiftDataList	`-`	所有时间粒度的数据。

TimeShiftDataList

参数	类型	示例值	描述
TimeStamp	String	`2022-02-16T00:00:00+08:00`	数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。
Storage	Float	`4503380.1`	当前数据聚合时间粒度内的时移文件存储用量，单位为 GB。

请求示例

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

返回示例

{
    "ResponseMetadata":{
        "RequestId":"20180604110420010010****",
        "Action":"DescribeLiveTimeShiftData",
        "Version":"2023-01-01",
        "Service":"live",
        "Region":"cn-north-1"
    },
    "Result":{
        "Vhosts": ["push.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
          },
          {
            "TimeStamp":"2022-02-16T00:05:00+08:00",
            "Storage":4503380
          }
      	]
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。