最近更新时间:2023.09.25 21:09:59
首次发布时间:2022.04.19 20:40:35
创建拉流转推任务成功后,调用该接口查询拉流转推任务详细,如任务时长等。
说明
该接口数据历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询拉流转推时长用量接口。
请求频率:单用户请求频率限制为 1 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribePullToPushData | 接口名称。当前 API 的名称为 DescribePullToPushData 。 |
Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s, |
EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s, |
Aggregation | Integer | 是 |
| 聚合时间粒度。默认值为 60,单位为 s,支持的取值如下所示。
|
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Summary | Object of Summary | - | 拉流转推时长汇总信息 |
List | Array of Datapoint | - | 各时间片详细数据 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalDuration | Float | 6 | 查询范围内拉流转推总时长,单位分钟,保留小数点后 2 位 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Time | String | 2021-04-13T00:00:00+08:00 | 时间片起始时刻。RFC3339 格式的 UTC 时间,精度为 s,例如,2022-04-13T00:00:00+08:00 |
Value | Float | 99 | 该时间片内的拉流转推总时长,单位分钟,保留小数点后 2 位 |
POST https://live.volcengineapi.com?Action=DescribePullToPushData&Version=2020-08-01 { "StartTime": "2021-04-13T00:00:00+08:00", "EndTime": "2021-04-14T00:00:00+08:00", "Aggregation": 60 }
{ "ResponseMetadata": { "RequestId": "201806041104200100****", "Action": "DescribePullToPushData", "Version": "2020-08-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "Summary": { "TotalDuration": 6 }, "List": [ { "Time": "2021-04-13T00:00:00+08:00", "Value": 99 } ] } }
访问公共错误码获取详细信息。