查询多媒体 AI 用量--视频点播-火山引擎

文档中心

立即注册

导航

查询多媒体 AI 用量

最近更新时间：2024.06.26 09:59:41首次发布时间：2023.10.16 10:38:46

此接口用于在指定空间维度下，查询一定时间范围内多媒体 AI 功能的用量。

注意事项

计费说明：多媒体 AI 计费价格请参见按量计费。
请求频率：单用户请求频率限制为 10 次/秒。
数据延迟：2 小时。
时间范围：查询的时间跨度不超过 93 天。
权限说明：当使用子账号请求接口时，接口会按照子账号进行权限校验，只返回该子账号有权限的数据。详见给子账号添加项目权限说明。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVodSpaceAIStatisData`	接口名称。当前 API 的名称为 `DescribeVodSpaceAIStatisData`。
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 天。
MediaAiType	String	否	`VideoClassification`	多媒体 AI 类型。默认全选。取值如下： `VideoClassification`：视频分类 `VideoSummary`：精彩剪辑 `BarrageMask`：蒙版弹幕
TaskStageList	String	否	`busy`	任务类型。多个任务类型之间用英文逗号 , 隔开。取值如下： `busy`：正常任务 `free`：闲时任务说明如果是 POST 请求，此参数类型为 Array of String。
Aggregation	Long	否	`3600`	聚合的时间粒度。单位为秒。取值如下： `3600`：（默认）1 小时。 `86400`：1 天。
DetailFieldList	String	否	`TaskStage`	详细字段列表。取值如下： `Space`：点播空间名 `TaskStage`：任务类型说明如果参数不为空，会返回更详细的用量数据。如果是 POST 请求，此参数类型为 Array of String。

返回参数

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

参数	类型	示例值	描述
SpaceList	String[]	`["test"]`	点播空间列表。
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。
MediaAiType	String	`VideoClassification`	多媒体 AI 类型。取值如下： `VideoClassification`：视频分类 `VideoSummary`：精彩剪辑 `BarrageMask`：蒙版弹幕
TaskStageList	String[]	`["busy","free"]`	任务类型。取值如下： `busy`：正常任务 `free`：闲时任务
Aggregation	Long	`3600`	聚合的时间粒度。单位为秒。取值如下： `3600`：1 小时 `86400`：1 天
DetailFieldList	String[]	`["TaskStage"]`	详细字段列表。取值如下： `Space`：点播空间名 `TaskStage`：任务类型
TotalAiUsageData	Long		所选时间段的多媒体 AI 总用量。
AiUsageDataList	Object[]	`-`	多媒体 AI 用量具体数据。
Time	String	`2022-04-18T20:00:00Z`	数据所在时间区间的开始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Duration	Long	`100`	用量，单位为毫秒。
AiUsageDataDetailList	Object[]	`-`	各种任务类型的多媒体 AI 用量。
Space	String	`test`	点播空间名。
TaskStage	String	`busy`	任务类型。取值如下： `busy`：正常任务 `free`：闲时任务
AiUsageDataList	Object[]	`-`	多媒体 AI 用量具体数据。
Time	String	`2022-04-18T20:00:00Z`	数据所在时间区间的开始时间。遵循 RFC3339 格式的 UTC 时间，精度为秒，格式为：yyyy-MM-ddTHH:mm:ssZ。
Duration	Long	`100`	用量，单位为毫秒。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodSpaceAIStatisData&Version=2023-07-01&Aggregation=3600&DetailFieldList=["TaskStage"]&EndTime=2022-04-18T22:00:00Z&MediaAiType=VideoClassification&SpaceList=["test"]&StartTime=2022-04-18T20:00:00Z&TaskStageList=["busy","free"]

返回示例

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

{
	"ResponseMetadata": {
        "RequestId": "20201124165******22034080031B5",
        "Action": "DescribeVodSpaceAIStatisData",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
  },
  "Result": {
    "SpaceList": ["test"],
    "StartTime":   "2022-04-18T20:00:00Z",
    "EndTime":     "2022-04-18T22:00:00Z",
    "TaskStageList": ["busy", "free"],
    "MediaAiType": "VideoClassification",
    "DetailFieldList": ["TaskStage"],
    "Aggregation": 3600,
    "TotalAiData": 100,
    "AiUsageDataList": [
       {
          "Time": "2022-04-18T20:00:00Z",
          "Duration": 100
       }
    ],
    "AiUsageDetailDataList": [
        {
            "TaskStage": "busy",
            "AiUsageDataList": [
                {
                    "Time": "2022-04-18T20:00:00Z",
                    "Duration": 100
                }
            ]
        },
        {
            "TaskStage": "free",
            "AiUsageDataList": [
                {
                    "Time": "2022-04-18T20:00:00Z",
                    "Duration": 100
                }
            ]
        }
    ]
 }
}

错误码

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

服务端 SDK

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