You need to enable JavaScript to run this app.
导航
查询任务详情
最近更新时间:2024.06.21 10:17:26首次发布时间:2022.03.03 12:45:34

此接口用于设置任务 ID 列表,查询指定的视频剪辑任务详情。

请求说明

  • 请求方式:POST
  • 请求地址:https://vod.volcengineapi.com?Action=GetDirectEditResult&Version=2018-01-01

调试

请求参数

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

Query

参数
类型
是否必选
示例值
描述
Action
String
GetDirectEditResult
接口名称。当前 API 的名称为 GetDirectEditResult
Version
String
2018-01-01
接口版本。当前 API 的版本为 2018-01-01

Body

参数
类型
是否必选
示例值
描述
ReqIds
String[]
["e0102ae2104a4953af14f83b3f8******"]
任务 ID 列表。您可通过 SubmitDirectEditTaskAsync 接口的返回参数获取。

返回参数

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

参数
类型
示例值
描述
Uploader
String
tob-devide-5555
任务产物的上传空间。视频剪辑任务完成后输出的产物会被上传至此空间。
EditParam
Object
-
CallbackUri
String
任务完成后回调地址。
CallbackArgs
String
自定义字段,回调时会透传返回。
Priority
Integer
0
视频剪辑任务优先级。
ReqId
String
29276c7e3aa74dc4b281c64c****4a85
任务请求 ID。
Status
String
success

任务执行结果,取值如下:

  • pending
  • start
  • success
  • failed_run
  • user_canceled
Message
String
视频剪辑测试

任务信息。

说明

Message 参数可能产生的错误任务信息,具体请参见 视频剪辑错误码

OutputVid
String
v0d5a8g10001***90ebbi8datoks0
任务产物的 Vid。
TaskId
String
367:kAtJNGI****p:default_tob
任务执行 ID。
Application
String
VideoTrackToB
编辑任务类型,值为 VideoTrackToB
CreateAt
String
2022-02-28T16:38:49+08:00
任务创建时间,RFC3339 格式。
FinishAt
String
2022-02-28T16:39:42+08:00
任务结束时间,RFC3339 格式。
TaskList
String
async_default
任务队列,用于任务限流。通常值为 async_default

请求示例

POST https://vod.volcengineapi.com?Action=GetDirectEditResult&Version=2018-01-01
{
    "ReqIds":["e0102ae2104a4953af14f83b3f8******"]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220228172***20502008CC41",
        "Action": "GetDirectEditResult",
        "Version": "2018-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": [
        {
            "Application": "VideoTrackToB",
            "CallbackArgs": "",
            "CallbackUri": "",
            "CreateAt": "2022-02-28T16:38:49+08:00",
            "EditParam": {
                "Canvas": {
                    "Height": 500,
                    "Width": 1080
                },
                "Output": {
                    "Alpha": false,
                    "Codec": {
                        "AudioBitrate": 128,
                        "AudioCodec": "aac",
                        "Crf": 23,
                        "Preset": "slow",
                        "VideoCodec": "h264"
                    },
                    "DisableAudio": false,
                    "DisableVideo": false,
                    "Fps": 30
                },
                "Track": [
                    [
                        {
                            "Extra": [
                                {
                                    "Alpha": 1,
                                    "FlipX": false,
                                    "FlipY": false,
                                    "Height": 416,
                                    "ID": "video1_transform",
                                    "PosX": 0,
                                    "PosY": 0,
                                    "Rotation": 0,
                                    "ScaleX": 1,
                                    "ScaleY": 1,
                                    "Type": "transform",
                                    "Width": 1000
                                },
                                {
                                    "ID": "video1_lut",
                                    "Intensity": 1,
                                    "Source": "your lokiId",
                                    "TargetTime": [
                                        0,
                                        10000
                                    ],
                                    "Type": "lut_filter"
                                },
                                {
                                    "Duration": 3000,
                                    "ID": "video1_transition",
                                    "Source": "your lokiId",
                                    "Type": "transition"
                                }
                            ],
                            "ID": "video1",
                            "Source": "https://demourl.mp4",
                            "TargetTime": [
                                0,
                                10000
                            ],
                            "Type": "video"
                        }
                    ],
                    [
                        {
                            "Extra": [
                                {
                                    "Alpha": 1,
                                    "FlipX": false,
                                    "FlipY": false,
                                    "FontSize": 1,
                                    "Height": 300,
                                    "ID": "a99vca123_text_transform",
                                    "PosX": 50,
                                    "PosY": 50,
                                    "Rotation": 0,
                                    "Type": "transform",
                                    "Width": 500
                                },
                                {
                                    "AnimInDuration": 3000,
                                    "AnimInRes": "your lokiId",
                                    "AnimOutDuration": 3000,
                                    "AnimOutRes": "your lokiId",
                                    "ID": "text_filter",
                                    "Type": "text_animation"
                                }
                            ],
                            "ID": "a99vca123_text",
                            "TargetTime": [
                                0,
                                15000
                            ],
                            "Text": "yyds",
                            "TextRes": "your lokiId",
                            "Type": "text"
                        }
                    ]
                ],
                "Upload": {
                    "SpaceName": "your space",
                    "VideoName": "编辑测试项目 2022年2月28日"
                },
                "Uploader": "your space"
            },
            "FinishAt": "2022-02-28T16:39:42+08:00",
            "OutputVid": "v0d5a8g1000***90ebbi8datoks0",
            "Priority": 0,
            "ReqId": "29276c7e3aa74***81c64c5a5d4a85",
            "Status": "success",
            "TaskId": "367:kAtJNGIP***default_tob",
            "TaskList": "async_default",
            "Uploader": "tob-devide-5555"
        }
    ]
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码,详见视频点播公共错误码

状态码错误码错误信息说明
5001000-内部错误
5001001-数据库写入错误
4001010-参数错误
5001014-下游服务错误

服务端 SDK

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