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

查询转码详细数据

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

首次发布时间：2023.03.20 16:52:13

我的收藏

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

请求说明

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

请求参数

参数类型是否必选描述
ActionString是接口名称。当前接口取值为 DescribeVodSpaceWorkflowDetailData。
VersionString是接口版本。当前接口取值为 2022-12-01。
Regiontring是区域。当前仅支持 cn-north-1，表示华北。

Space

String

是

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

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

EndTime

String

是

查询的结束时间。RFC3339 格式的 UTC 时间，精确到秒。例如，2023-03-01T00:00:00+08:00。

说明

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

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

返回参数

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

ResponseMetadata

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

ResponseError

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

DescribeVodSpaceWorkflowDetailDataResult

参数类型描述
RegionString区域。当前仅支持 cn-north-1，表示华北。
SpaceString点播空间名称。
StartTimeString查询的起始时间。
EndTimeString查询的结束时间。
PageSizeInteger分页查询的页大小。
PageNumInteger分页查询页号。
TotalInteger总数据条数。
WorkflowDetailDataArray of WorkflowDetailData转码详细数据。

WorkflowDetailData

参数类型描述
RunIdString工作流任务 ID
VidString视频 ID
TemplateIdString工作流模板 ID
SpaceNameString点播空间名称

Status

String

执行状态。取值如下：

  • 0：成功。
  • [1000,1899]：用户错误的失败。
  • [1900,2999]：系统错误的失败。
StartTimeString执行开始时间。RFC3339 格式的 UTC 时间，精确到秒。例如，2023-03-01T00:00:00+08:00
EndTimeString执行完成时间。RFC3339 格式的 UTC 时间，精确到秒。例如，2023-03-01T00:00:00+08:00
TranscodeInfoTranscodeInfo音视频转码信息。
SnapshotInfoSnapshotInfo截图信息。
EnhanceExecInfoEnhanceExecInfo画质增强信息。
VideoAIInfoVideoAIInfo多媒体 AI 信息。

TranscodeInfo

参数类型描述

TemplateType

String

转码类型。取值如下：

  • Normal：标准转码。
  • LowCost：低成本转码。
  • ByteHD：极智超清。

FileType

String

文件类型。取值如下：

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

Codec

String

编码格式。

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

Remux

Boolean

是否是转封装。

  • true：是。
  • false：否。

Definition

String

分辨率。

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

Slice

Boolean

是否是倍速转码。

  • true：是。
  • false：否。

IsLowPriority

Boolean

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

  • true：是。
  • false：否。

SnapshotInfo

参数类型描述

TemplateType

String

截图类型。取值如下：

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

IsLowPriority

Boolean

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

  • true：是。
  • false：否。

EnhanceExecInfo

参数类型描述

TemplateType

String

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

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

IsLowPriority

Bool

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

  • true：是。
  • false：否。

VideoAIInfo

参数类型描述

TemplateType

String

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

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

IsLowPriority

Boolean

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

  • true：是。
  • false：否。

示例

请求示例

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

POST https://vod.volcengineapi.com?Action=DescribeVodSpaceWorkflowDetailData&Version=2022-12-01 HTTP/1.1
Content-Type: application/json

{
  "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
}

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

GET https://vod.volcengineapi.com?Action=DescribeVodSpaceWorkflowDetailData&Version=2022-12-01&Space=test&StartTime=2023-03-01T00%3A00%3A00%2B08%3A00&EndTime=2023-03-02T00%3A00%3A00%2B08%3A00&PageSize=100&PageNum=1 HTTP/1.1

正常返回示例

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

{
    "ResponseMetadata": {
        "RequestId": "201806041104***00100232280022D30",
        "Action": "DescribeVodSpaceWorkflowDetailData",
        "Version": "2022-12-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
                }
            }
        ]
    }
}

异常返回示例

HTTP/1.1 400 Bad Request
Content-Length: 190
Content-Type: application/json

{
  "ResponseMetadata":{
    "RequestId": "201806041104***100232280022D30",
    "Action": "DescribeVodSpaceWorkflowDetailData",
    "Version": "2022-12-01",
    "Service": "vod",
    "Region": "cn-north-1",
    "Error":{
      "Code": "InvalidParameter",
      "Message": "must have X-Top-Account-Id"
    }
  }
}

错误码

详见视频点播公共错误码。

服务端 SDK

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