You need to enable JavaScript to run this app.
导航

查询智能字幕用量

最近更新时间2024.01.16 20:28:06

首次发布时间2023.10.16 10:38:46

此接口用于查询指定时间范围内智能字幕功能的用量。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 权限说明:当使用子账号请求接口时,接口会按照子账号进行权限校验,只返回该子账号有权限的数据。详见给子账号添加项目权限说明。
  • 数据延迟:2 小时。

请求说明

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

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringDescribeVodSpaceSubtitleStatisData接口名称。当前 API 的名称为 DescribeVodSpaceSubtitleStatisData
VersionString2023-07-01接口版本。当前 API 的版本为 2023-07-01

SpaceList

String

test

点播空间名列表。多个空间名之间用英文逗号 , 隔开。

说明

如果是 POST 请求,此参数类型为 Array of String。

StartTimeString2022-04-18T20:00:00Z查询的起始时间。日期格式要求符合 RFC3339 规范。

EndTime

String

2022-04-18T22:00:00Z

查询的结束时间。日期格式要求符合 RFC3339 规范。

说明

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

SubtitleType

String

MT

字幕类型。默认全选。取值如下:

  • ASR:语音转写
  • MT:机器翻译
  • ES:提取字幕

TaskStageList

String

busy,free

任务类型。多个任务类型之间用英文逗号 , 隔开。取值如下:

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

说明

如果是 POST 请求,此参数类型为 Array of String。

Aggregation

Long

3600

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

  • 3600:(默认)1 小时。
  • 86400:1 天

DetailFieldList

String

TaskStage

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

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

说明

  • 如果参数不为空,会返回更详细的用量数据。
  • 如果是 POST 请求,此参数类型为 Array of String。

返回参数

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

参数类型示例值描述
SpaceListArray of String["test"]点播空间名列表。
StartTimeString2022-04-18T20:00:00Z查询的起始时间。
EndTimeString2022-04-18T22:00:00Z查询的结束时间。

SubtitleType

String

MT

字幕类型。取值如下:

  • ASR:语音转写
  • MT:机器翻译
  • ES:提取字幕

TaskStageList

Array of String

["busy","free"]

任务类型。取值如下:

  • busy:正常任务;
  • free:闲时任务。

Aggregation

Long

3600

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

  • 3600:1 小时
  • 86400:1 天

DetailFieldList

Array of String

["TaskStage"]

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

  • TaskStage:任务类型
  • Space:点播空间名
TotalSubtitleUsageDataLong100所选时间段的字幕总用量。
SubtitleUsageDataListArray of SubtitleUsageDataList-字幕用量具体数据。
SubtitleUsageDataDetailListArray of SubtitleUsageDataDetailList-各种任务类型的字幕用量。

SubtitleUsageDataList

参数类型示例值描述
TimeString2022-04-18T20:00:00Z日期。符合 RFC3339 规范,例如:2022-05-06T00:00:00Z
UsageLong100用量。

SubtitleUsageDataDetailList

参数类型示例值描述
SpaceStringtest点播空间名。

TaskStage

String

busy

任务类型。取值如下:

  • busy:正常任务
  • free:闲时任务
SubtitleUsageDataListArray of SubtitleUsageDataList-字幕用量具体数据。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodSpaceSubtitleStatisData&Version=2023-07-01&Aggregation=3600&DetailFieldList=%5B%22TaskStage%22%5D&EndTime=2022-04-18T22%3A00%3A00Z&SpaceList=%5B%22test%22%5D&StartTime=2022-04-18T20%3A00%3A00Z&SubtitleType=MT&TaskStageList=%5B%22busy%22%2C%22free%22%5D

返回示例

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

{
	    "ResponseMetadata": {
        "RequestId": "20221123122***0380DAD1333",
        "Action": "DescribeVodSpaceSubtitleStatisData",
        "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"],
    "SubtitleType": "MT",
    "DetailFieldList": ["TaskStage"],
    "Aggregation": 3600,
    "TotalSubtitleUsageData": 100,
    "SubtitleUsageDataList": [
       {
          "Time": "2022-04-18T20:00:00Z",
          "Usage": 100
       }
    ],
    "SubtitleUsageDetailDataList": [
        {
            "TaskStage": "busy",
            "SubtitleUsageDataList": [
                {
                    "Time": "2022-04-18T20:00:00Z",
                    "Usage": 100
                }
            ]
        },
        {
            "TaskStage": "free",
            "SubtitleUsageDataList": [
                {
                    "Time": "2022-04-18T20:00:00Z",
                    "Usage": 100
                }
            ]
        }
    ]
  }
}

错误码

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

服务端 SDK

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