查询实时处理用量--视频点播-火山引擎

文档中心

立即注册

导航

查询实时处理用量

最近更新时间：2024.07.04 17:59:26首次发布时间：2024.05.16 18:41:33

此接口用于在指定空间维度下，查询在一定时间范围内的实时截图和实时获取音视频信息的访问次数。

注意事项

前提条件：在指定空间维度下，已配置完成实时处理功能。
计费说明：实时处理计费价格请参见按量计费。
请求频率：单用户请求频率限制为 10次/秒。
数据延迟：2 小时。
时间范围：查询的时间跨度不超过 93 天。

请求说明

请求地址：https://vod.volcengineapi.com?Action=DescribeVodRealtimeMediaData&Version=2023-07-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVodRealtimeMediaData`	接口名称。当前 API 的名称为 `DescribeVodRealtimeMediaData`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceList	String	否	`test`	点播空间名列表。多个空间名之间用英文逗号 `,` 隔开。说明如果是 POST 请求，该参数类型为 Array of String。
StartTime	String	是	`2024-05-08T00:00:00+08:00`	查询的起始时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ss。说明开始时间最早不早于当前时间的 366 天。
EndTime	String	是	`2024-05-09T00:00:00+08:00`	查询的结束时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ss。说明查询时间跨度不超过 93 天。
ProcessType	String	否	`Snapshot`	实时处理类型。默认为全部处理类型。取值如下： `Snapshot`：实时截图 `Metadata`：实时获取音视频信息
Aggregation	Long	否	`3600`	聚合的时间粒度，单位为秒。取值如下： `3600`：（默认）1 小时 `86400`： 1 天
DetailFieldList	String	否	`Space`	展示详细信息的维度列表。目前支持的取值为 `Space`，多个值用英文 `,` 逗号分隔。说明如果是 POST 请求，该参数类型为 Array of String。

返回参数

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

参数	类型	示例值	描述
SpaceList	String[]	`["test"]`	点播空间列表。
StartTime	String	`2024-05-08T00:00:00+08:00`	查询的起始时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ss。
EndTime	String	`2024-05-09T00:00:00+08:00`	查询的结束时间。遵循 RFC3339 格式的东八区 UTC+8 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ss。
ProcessType	String	`Snapshot`	实时处理类型。取值如下： `Snapshot`：实时截图 `Metadata`：实时获取音视频信息
Aggregation	Long	`86400`	聚合的时间粒度，单位为秒。取值如下： `3600`：1 小时 `86400`： 1 天
DetailFieldList	String[]	`["Space"]`	展示详细信息的维度列表。目前支持的取值为 `Space`。
TotalRealtimeMediaData	Long	`220`	实时处理媒资总访问次数。
RealtimeMediaDataList	Object[]	`-`	实时处理媒资信息访问次数列表。
Time	String	`2024-05-07T16:00:00Z`	结束时间，遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Count	Long	`220`	访问次数，单位为次。
RealtimeMediaDetailDataList	Object[]	`-`	实时处理媒资信息访问次数详细列表。
Space	String	`test`	点播空间名称。
RealtimeMediaDataList	Object[]	`-`	实时处理媒资信息访问次数列表。
Time	String	`2024-05-07T16:00:00Z`	结束时间，遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Count	Long	`220`	访问次数，单位为次。
Total	Long	`220`	总数据条数。

请求示例

GET https://vod.volcengineapi.com?Action=DescribeVodRealtimeMediaData&Version=2023-07-01&SpaceList=test&ProcessType=Snapshot&StartTime=2024-05-08T00:00:00+08:00&EndTime=2024-05-09T00:00:00+08:00&Aggregation=86400&DetailFieldList=Space

返回示例

HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json

{
    "ResponseMetadata": {
        "RequestId": "20240509195****51DAFC8C93096BA",
        "Action": "DescribeVodRealtimeMediaData",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "SpaceList": [
            "test"
        ],
        "StartTime": "2024-05-08T00:00:00+08:00",
        "EndTime": "2024-05-09T00:00:00+08:00",
        "ProcessType": "Snapshot",
        "Aggregation": 86400,
        "DetailFieldList": [
            "Space"
        ],
        "TotalRealtimeMediaData": 220,
        "RealtimeMediaDataList": [
            {
                "Time": "2024-05-07T16:00:00Z",
                "Count": 220
            }
        ],
        "RealtimeMediaDetailDataList": [
            {
                "Space": "test",
                "Total": 220,
                "RealtimeMediaDataList": [
                    {
                        "Time": "2024-05-07T16:00:00Z",
                        "Count": 220
                    }
                ]
            }
        ]
    }
}

错误码

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