You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /
  • 视频点播

查询多媒体 AI 用量

最近更新时间：2023.07.12 17:56:39

首次发布时间：2023.04.21 18:43:59

我的收藏

此接口用于查询指定时间范围内多媒体 AI 功能的用量。

请求说明

  • 接口名称：DescribeVodSpaceAIStatisData
  • 接口地址：http://vod.volcengineapi.com/?Action=DescribeVodSpaceAIStatisData&Version=2020-08-01
  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 数据延迟：2 小时。

请求参数

参数类型是否必选描述
ActionString是接口名称。当前接口取值为 DescribeVodSpaceAIStatisData。
VersionString是接口版本。当前接口取值为 2020-08-01。

SpaceList

Array of String

否

点播空间名列表。

说明

如果是 GET 请求，此参数类型为 String，多个空间名之间用 , 隔开。

StartTimeString是查询的起始时间。日期格式要求符合 RFC3339 规范。例如：2022-04-18T20:00:00Z。

EndTime

String

是

查询的结束时间。日期格式要求符合 RFC3339 规范。例如：2022-04-18T22:00:00Z。

说明

单次查询的时间跨度不可超过 93 天。

MediaAiType

String

否

多媒体 AI 功能类型。默认全选。取值如下：

  • VideoClassification：视频分类
  • VideoSummary：精彩剪辑
  • BarrageMask：蒙版弹幕

TaskStageList

Array of String

否

任务类型。取值如下：

  • busy：正常任务
  • free：闲时任务

说明

如果是 GET 请求，此参数类型为 String，多个任务类型之间用 , 隔开。

Aggregation

Integer

否

聚合的时间粒度。单位为秒。取值如下：

  • 3600：（默认）1 小时
  • 86400：1 天

DetailFieldList

Array of String

否

详细字段列表。取值如下：

  • Space：点播空间名
  • TaskStage：任务类型

说明

如果参数不为空，会返回更详细的用量数据。

返回参数

参数类型描述
ResponseMetadataResponseMetadata响应通用信息
ResultVodDescribeVodSpaceAIStatisData响应结果

ResponseMetadata

参数类型描述
RequestIdString请求 ID
ActionString请求接口
VersionString版本
ServiceString服务
RegionString区域
ErrorResponseError异常信息

ResponseError

参数类型描述
CodeString错误码
MessageString详细错误信息

VodDescribeVodSpaceAIStatisData

参数类型描述
SpaceListArray of String点播空间列表。
StartTimeString查询的起始时间。
EndTimeString查询的结束时间。

MediaAiType

String

多媒体 AI 类型。取值如下：

  • VideoClassification：视频分类
  • VideoSummary：精彩剪辑
  • BarrageMask：蒙版弹幕

TaskStageList

Array of String

任务类型。取值如下：

  • busy：正常任务
  • free：闲时任务

Aggregation

Integer

聚合的时间粒度。单位为秒。取值如下：

  • 3600：1 小时
  • 86400：1 天

DetailFieldList

Array of String

详细字段列表。根据查询条件返回更详细的数据。取值如下：

  • Space：点播空间名
  • TaskStage：任务类型
TotalAiUsageDataFloat所选时间段的多媒体 AI 总用量。
AiUsageDataDetailListArray of AiUsageDetailData各种任务类型的多媒体 AI 用量。
AiUsageDataListArray of AiUsageData多媒体 AI 用量具体数据。

AiUsageDetailData

参数类型描述
SpaceString点播空间名

TaskStage

String

任务类型。取值如下：

  • busy：正常任务
  • free：闲时任务
AiUsageDataListArray of AiUsageData多媒体 AI 用量具体数据

AiUsageData

参数类型描述
TimeString时间
DurationFloat用量，单位为毫秒

示例

请求示例

如果用 POST 方式发起请求，示例如下：

POST http://vod.volcengineapi.com/?Action=DescribeVodSpaceAIStatisData&Version=2020-08-01 HTTP/1.1
Content-Type: application/json

{
  "SpaceList": ["test"],
  "StartTime":   "2022-04-18T20:00:00Z",
  "EndTime":     "2022-04-18T22:00:00Z",
  "TaskStageList": ["busy", "free"],
  "MediaAiType": "VideoClassification",
  "DetailFieldList": ["TaskStage"]
}

如果用 GET 方式发起请求，示例如下：

GET http://vod.volcengineapi.com/?Action=DescribeVodSpaceAIStatisData&Version=2020-08-01&SpaceList=test&StartTime=2022-04-18T20%3A00%3A00Z&EndTime=2022-04-18T20%3A00%3A00Z&TaskStageList=busy,free&DetailFieldList=TaskStage&MediaAiType=VideoClassification HTTP/1.1

返回示例

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

{
	"ResponseMetadata": 
  {
    "RequestId": "20201124165******22034080031B5",
    "Action": "DescribeVodSpaceAIStatisData",
    "Version": "2020-08-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 各语言调用的示例代码，请参考如下：