查询视频剪辑用量--视频点播-火山引擎

文档中心

立即注册

导航

查询视频剪辑用量

最近更新时间：2024.10.29 11:57:32首次发布时间：2023.10.16 10:38:47

此接口用于查询指定空间下指定时间范围内视频剪辑功能的用量。

注意事项

计费说明：视频剪辑计费价格请参见按量计费。
数据延迟：2 小时。
时间范围：查询的时间跨度不超过 93 天。
权限说明：当使用子账号请求接口时，接口会根据子账号的权限进行校验，仅返回该子账号有权限的数据。详见创建子账号并授权。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVodSpaceEditStatisData`	接口名称。当前 API 的名称为 `DescribeVodSpaceEditStatisData`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceList	String	否	`test`	空间名列表。多个空间名之间用 `,` 分隔。说明如果是 POST 请求，此参数类型为 Array of String。
StartTime	String	是	`2022-04-18T20:00:00Z`	查询的起始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	是	`2022-04-18T22:00:00Z`	查询的结束时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。说明单次查询的时间跨度不可超过 93 天。
Specification	String	否	`h.264_360P`	输出视频规格。取值格式为 `codec_definition`。其中： `codec` 取值可为 h.264、h.265、vp9。 `definition` 取值可为 360P、480P、540P、720P、1080P、2K、4K。说明高于 4K 的会归为 4K 档位，低于 360P 的会归为 360P 档位。
Aggregation	Long	否	`3600`	聚合的时间粒度。单位为秒。取值如下： `3600`：（默认）1 小时 `86400`：1 天
DetailFieldList	String	否	`Space`	详细字段列表。可设为 `Space`（空间）。说明如果 `DetailFieldList` 不为空，会返回更详细的用量数据。如果是 POST 请求，此参数类型为 Array of String。

返回参数

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

参数	类型	示例值	描述
SpaceList	String[]	`["test1","test2"]`	空间名列表。
StartTime	String	`2022-04-18T20:00:00Z`	查询的起始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EndTime	String	`2022-04-18T22:00:00Z`	查询的结束时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Specification	String	`h.264_360P`	输出视频规格。取值格式为 `codec_definition`。其中： `codec` 取值可为 h.264、h.265、vp9。 `definition` 取值可为 360P、480P、540P、720P、1080P、2K、4K。说明高于 4K 的会归为 4K 档位，低于 360P 的会归为 360P 档位。
Aggregation	Long	`3600`	聚合的时间粒度。单位为秒。取值如下： `3600`：1 小时 `86400`：1 天
DetailFieldList	String[]	`["Space"]`	详细字段列表。根据查询条件返回更详细的数据。取值为 `Space`（空间）。
TotalEditUsageData	Long	`100`	所选时间段的视频剪辑总用量，单位为毫秒。
TotalEditUsageDataList	Object[]	`-`	各种分辨率的用量。
Name	String	`h.264_360P`	输出视频规格。取值格式为 `codec_definition`。其中： `codec` 取值可为 h.264、h.265、vp9。 `definition` 取值可为 360P、480P、540P、720P、1080P、2K、4K。说明高于 4K 的会归为 4K 档位，低于 360P 的会归为 360P 档位。
Duration	Long	`10`	时长，单位为毫秒。
EditUsageDataDetailList	Object[]	`-`	视频剪辑用量具体数据。
Space	String	`test`	点播空间名称。
EditUsageDataList	Object[]	`-`	视频剪辑用量的具体数据。
Time	String	`2022-04-18T20:00:00Z`	数据所在时间区间的开始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
EditUsageItemList	Object[]	`-`	各种分辨率的用量。
Name	String	`h.264_360P`	输出视频规格。取值格式为 `codec_definition`。其中： `codec` 取值可为 h.264、h.265、vp9。 `definition` 取值可为 360P、480P、540P、720P、1080P、2K、4K。说明高于 4K 的会归为 4K 档位，低于 360P 的会归为 360P 档位。
Duration	Long	`10`	时长，单位为毫秒。
RegionList	String[]	`-`	区域，多个区域用逗号分隔。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodSpaceEditStatisData&Version=2023-07-01&StartTime=2022-04-18T20:00:00Z&EndTime=2022-04-18T22:00:00Z

返回示例

{
    "Result": {
        "EndTime": "2022-04-18T22:00:00Z",
        "SpaceList": [
            "test1",
            "test2"
        ],
        "StartTime": "2022-04-18T20:00:00Z",
        "RegionList": [
            ""
        ],
        "Aggregation": 3600,
        "Specification": "h.264_360P",
        "DetailFieldList": [
            "Space"
        ],
        "TotalEditUsageData": 100,
        "TotalEditUsageDataList": [
            {
                "Name": "h.264_360P",
                "Duration": 10
            }
        ],
        "EditUsageDataDetailList": [
            {
                "Space": "test",
                "EditUsageDataList": [
                    {
                        "Time": "2022-04-18T20:00:00Z",
                        "EditUsageItemList": [
                            {
                                "Name": "h.264_360P",
                                "Duration": 10
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "ResponseMetadata": {
        "Action": "DescribeVodSpaceEditStatisData",
        "Region": "cn-north-1",
        "Service": "vod",
        "Version": "2023-07-01",
        "RequestId": "20230604110420****100232280022D31"
    }
}

错误码

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

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码，请参考如下：