最近更新时间:2023.12.04 11:00:42
首次发布时间:2023.09.25 14:35:35
指定时间范围,查询每日直播时移功能的存储用量。
注意
该接口适用于视频直播提供时移能力的场景,如时移文件存储于视频点播 VoD 或对象存储 ToS,请联系我们,获取用量查询方法。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveTimeShiftData | 接口名称。当前 API 的名称为 DescribeLiveTimeShiftData 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Aggregation | Integer | 否 | 86400 | 时间粒度,单位为 s,支持配置为 86400,单次查询时间跨度为 93 天,历史查询时间范围为 366 天。 |
EndTime | String | 是 | 2022-02-17T23:59:59+08:00 | 结束时间,RFC3339 格式的 UTC 时间,精度为 s。 |
StartTime | String | 是 | 2022-02-11T00:00:00+08:00 | 开始时间,RFC3339 格式的 UTC 时间,精度为 s。 |
Vhosts | Array of String | 否 | ["www.example.com"] | 域名空间列表,缺省情况表示查询该用户的所有域名空间。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Vhosts | Array of String | ["www.example.com"] | 域名空间列表。 |
StartTime | String | 2022-02-16T00:00:00+08:00 | 开始时间。 |
EndTime | String | 2022-02-17T23:59:59+08:00 | 结束时间。 |
Aggregation | Integer | 86400 | 聚合时间粒度。 |
TimeShiftDataList | Array of TimeShiftDataList | - | 时移存储数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2022-02-16T00:00:00+08:00 | 时间点,默认为每日的结束时间。例如,返回 2022-02-16T00:00:00+08:00,表示取该时刻的存储用量作为 2 月 16 日的计费用量。 |
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": [ "www.example.com" ] }
{ "ResponseMetadata":{ "RequestId":"20180604110420010010****", "Action":"DescribeLiveTimeShiftData", "Version":"2023-01-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 } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
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. | 内部服务超时,请联系技术支持。 |