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

查询转码详细数据

最近更新时间：2024.01.16 20:28:07

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

我的收藏

此接口用于查询指定时间范围内的点播转码详细数据。

注意事项

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

请求说明

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

调试

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

请求参数

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

参数类型是否必选示例值描述
ActionString是DescribeVodSpaceWorkflowDetailData接口名称。当前 API 的名称为 DescribeVodSpaceWorkflowDetailData。
VersionString是2023-07-01接口版本。当前 API 的版本为 2023-07-01。
RegionString是cn-north-1区域。当前仅支持 cn-north-1，表示华北。

Space

String

是

test

空间名称。您可通过以下方式获取空间名称：

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。
StartTimeString是2023-03-01T00:00:00+08:00查询的起始时间。最早可查询的时间是当前时间的 186 天之前。RFC3339 格式的 UTC 时间，精确到秒。

EndTime

String

是

2023-03-02T00:00:00+08:00

查询的结束时间。RFC3339 格式的 UTC 时间，精确到秒。

说明

起始时间和结束时间的间隔不能超过 1 天，即一次可查询的时间范围是 1 天。

PageSizeLong否100分页查询的页大小。默认为 100，最大值为 1000。
PageNumLong否1分页查询页号。从 1 开始，默认为 1。

返回参数

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

参数类型示例值描述
RegionStringcn-north-1区域。当前仅支持 cn-north-1，表示华北。
SpaceStringtest点播空间名。
StartTimeString2023-03-01T00:00:00+08:00查询的起始时间。
EndTimeString2023-03-02T00:00:00+08:00查询的结束时间。
PageSizeLong100分页查询的页大小。
PageNumLong1分页查询页号。
TotalLong1总数据条数。
WorkflowDetailDataArray of WorkflowDetailData-转码详细数据。

WorkflowDetailData

参数类型示例值描述
RunIdString1243234***5345345工作流任务 ID。
VidString34563465***464视频 ID。
TemplateIdString345***654654工作流模板 ID。
SpaceNameStringtest点播空间名称。

Status

String

0

执行状态。取值如下：

  • 0：成功。
  • [1000,1899]：用户错误的失败。
  • [1900,2999]：系统错误的失败。
StartTimeString2023-03-01T00:00:00+08:00执行开始时间。RFC3339 格式的 UTC 时间，精确到秒。例如，2023-03-01T00:00:00+08:00
EndTimeString2023-03-01T00:01:00+08:00执行完成时间。RFC3339 格式的 UTC 时间，精确到秒。例如，2023-03-01T00:00:00+08:00
TranscodeInfoObject of TranscodeInfo-音视频转码信息。
SnapshotInfoObject of SnapshotInfo-截图信息。
EnhanceExecInfoObject of EnhanceExecInfo-画质增强信息。
VideoAIInfoObject of VideoAIInfo-多媒体 AI 信息。

TranscodeInfo

参数类型示例值描述

TemplateType

String

Normal

转码类型。取值如下：

  • Normal：标准转码。
  • LowCost：低成本转码。
  • ByteHD：高清低码。

FileType

String

Video

文件类型。取值如下：

  • Video：视频。
  • Audio：音频。
DurationLong123转码输出文件的时长，单位为毫秒。

Codec

String

h265

编码格式。

  • 当 FileType 参数取值为 Video 时，取值如下：
    • h264
    • h265
    • h266
  • 当 FileType 参数取值为 Audio 时，返回的值为空。

Remux

Boolean

true

是否是转封装。取值如下：

  • true：是。
  • false：否。

Definition

String

1080p

分辨率。

  • 当 FileType 参数取值为 Video 时，取值如下：
    • 240p
    • 360p
    • 480p
    • 540p
    • 720p
    • 1080p
    • 2k
    • 4k
    • 8k
  • 当 FileType 参数取值为 Audio 时，返回的值为空。
WidthLong234宽度，单位为 px。
HeightLong345高度，单位为 px。

Slice

Boolean

true

是否是倍速转码。取值如下：

  • true：是。
  • false：否。

IsLowPriority

Boolean

true

是否是闲时任务。取值如下：

  • true：是。
  • false：否。

SnapshotInfo

参数类型示例值描述

TemplateType

String

Poster

截图类型。取值如下：

  • Poster：静态图。
  • Sample：采样截图。
  • Dynpost：动图。
  • Animated：反复循环图。
  • AIDynpost：智能封面（AI 动图）。
  • Sprite：雪碧图。
NumberLong10截图张数。

IsLowPriority

Boolean

true

是否是闲时任务。取值如下：

  • true：是。
  • false：否。

EnhanceExecInfo

参数类型示例值描述

TemplateType

String

SR

画质增强类型。取值如下：

  • SR：智能超分。
  • VFI：智能插帧。
  • SDREnhance：SDR 增强。
  • SDR2HDR：SDR2HDR 增强。
  • AudioDenoise：音频降噪。
DurationLong100画质增强输出文件的时长，单位为毫秒。

IsLowPriority

Boolean

false

是否是闲时任务。取值如下：

  • true：是。
  • false：否。

VideoAIInfo

参数类型示例值描述

TemplateType

String

VQScore

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

  • VQScore：画质检测-VQScore。
  • WatermarkDetect：水印检测。
  • VideoClassification：视频分类。
  • VideoSummary：精彩剪辑。
  • ASR：语音转写。
  • MT：机器翻译。
DurationLong320多媒体 AI 输出文件的时长，单位为毫秒。
NumberLong4048机器翻译字幕的字符数。

IsLowPriority

Boolean

false

是否是闲时任务。取值如下：

  • true：是。
  • false：否。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodSpaceWorkflowDetailData&Version=2023-07-01&EndTime=2023-03-02T00%3A00%3A00%2B08%3A00&PageNum=1&PageSize=100&Region=cn-north-1&Space=test&StartTime=2023-03-01T00%3A00%3A00%2B08%3A00

返回示例

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

{
  "ResponseMetadata": {
    "RequestId": "201806041104***00100232280022D30",
    "Action": "DescribeVodSpaceWorkflowDetailData",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "Region": "cn-north-1",
    "Space": "test",
    "StartTime": "2023-03-01T00:00:00+08:00",
    "EndTime": "2023-03-02T00:00:00+08:00",
    "PageSize": 100,
    "PageNum": 1,
    "WorkflowDetailData": [
      {
        "RunId": "1243234***5345345",
        "Vid": "34563465***464",
        "TemplateId": "345***654654",
        "SpaceName": "test",
        "Status": "0",
        "StartTime": "2023-03-01T00:00:00+08:00",
        "EndTime": "2023-03-01T00:01:00+08:00",
        "TranscodeInfo": {
          "TemplateType": "Normal",
          "FileType": "Video",
          "Duration": 123,
          "Codec": "h265",
          "Remux": true,
          "Definition": "1080p",
          "Width": 234,
          "Height": 345,
          "Slice": true,
          "IsLowPriority": true
        }
      }
    ]
  }
}

错误码

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

服务端 SDK

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