logologo
售前咨询
点播云
文档中心服务端API媒体处理查询任务流状态

查询任务流状态


请求参数

字段

类型

是否必填

示例

描述

Action

String

DescribeTaskDetail

公共参数,提交媒体处理任务流,取值:DescribeTaskDetail

TaskId

String


任务ID

SpaceName

String

other_space1

应用空间

默认为:default_space

返回参数

字段

类型

示例

描述

TaskType

String

Workflow

任务类型,取值:

  • Workflow:任务流任务

CreateTime

String

2021-11-09T12:00:00Z

任务的创建时间。日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

BeginProcessTime

String

2021-11-09T12:00:00Z

任务开始执行的时间,日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

FinishTime

String

2021-11-09T12:00:00Z

任务执行完毕的时间,日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

WorkflowTaskResult

WorkflowTaskResult


视频处理任务信息,仅当 TaskType 为 Workflow,该字段有值。

注意:此字段可能返回 null,表示取不到有效值


WorkflowTaskResult

字段

类型

示例

描述

TaskId

String

fjqi1203sfsd

任务Id

Status

String

任务状态,取值:

  • Waiting:等待中
  • Processing:处理中
  • Finish:已完成
  • Failed:失败

MediaId

String

1124sfsdfwee

媒资Id

Metadata

Metadata

原始音视频的元信息。

注意:此字段可能返回 null,表示取不到有效值。

MediaProcessTaskResults

Array of MediaProcessTaskResult

音视频处理任务的执行状态与结果。

Metadata

字段

类型

示例

描述

FileSize

Long

文件大小,单位:Byte

Height

Integer

视频高度,单位:px

Width

Integer

视频宽度,单位:px

Bitrate

Integer

视频文件码率,单位:Kbps

Duration

Double

视频时长,单位:s

Fps

Integer

视频流帧率,每秒包含帧数

Format

String

视频流格式

  • mp4
  • m3u8

VideoStreams

Array of VideoStream

详见VideoStream

AudioStreams

Array of AudioStream

详见AudioStream

VideoStream

参数名称

类型

描述

Duration

Double

视频流长度,单位:s

Width

Integer

视频流宽度,单位:px

Height

Integer

视频流高度,单位:px

Fps

Integer

视频流帧率,每秒包含帧数

Bitrate

Integer

视频流码率,单位:Kbps

AudioStream

参数名称

类型

描述

Duration

Double

音频流长度,单位:s

Bitrate

Integer

音频流码率,单位:Kbps

Channels

Integer

声道数

SampleRate

Integer

采样率,单位:Hz

MediaProcessTaskResult

字段

类型

示例

描述

Type

String

Transcode

任务的类型,可以取的值有:

  • Transcode:转码
  • SnapshotByTimeOffset:时间点截图
  • SampleSnapshot:采样截图
  • ImageSprite:雪碧图

TranscodeTaskResult

TranscodeTaskResult

视频转码任务的查询结果,当任务类型为 Transcode 时有效。

注意:此字段可能返回 null,表示取不到有效值。

SnapshotByTimeOffsetTaskResult

SnapshotByTimeOffsetTaskResult

对视频按时间点截图任务的查询结果,当任务类型为 SnapshotByTimeOffset 时有效。

注意:此字段可能返回 null,表示取不到有效值。

SampleSnapshotTaskResult

SampleSnapshotTaskResult

对视频采样截图任务的查询结果,当任务类型为 SampleSnapshot 时有效。

注意:此字段可能返回 null,表示取不到有效值。

ImageSpriteTaskResult

ImageSpriteTaskResult

对视频截雪碧图任务的查询结果,当任务类型为 ImageSprite 时有效。

注意:此字段可能返回 null,表示取不到有效值。

TranscodeTaskResult

字段

类型

示例

描述

Status

String

任务状态,取值:

  • Waiting:等待中;
  • Processing:处理中;
  • Finish:已完成;
  • Failed:失败

Input

TranscodeTaskInput

转码任务输入

BeginProcessTime

String

2021-11-09T12:00:00Z

任务开始执行的时间,日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

FinishTime

String

2021-11-09T12:00:00Z

任务执行完毕的时间,日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

SnapshotByTimeOffsetTaskResult

字段

类型

示例

描述

Status

String

任务状态,取值:

  • Waiting:等待中;
  • Processing:处理中;
  • Finish:已完成;
  • Failed:失败

Input

SnapshotByTimeOffsetTaskInput

指定时间点截图任务输入列表

BeginProcessTime

String

2021-11-09T12:00:00Z

任务开始执行的时间,日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

FinishTime

String

2021-11-09T12:00:00Z

任务执行完毕的时间,日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

SampleSnapshotTaskResult

字段

类型

示例

描述

Status

String

任务状态,取值:

  • Waiting:等待中;
  • Processing:处理中;
  • Finish:已完成;
  • Failed:失败

Input

SampleSnapshotTaskInput

采样截图任务输入列表

BeginProcessTime

String

2021-11-09T12:00:00Z

任务开始执行的时间,日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

FinishTime

String

2021-11-09T12:00:00Z

任务执行完毕的时间,日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

ImageSpriteTaskResult

字段

类型

示例

描述

Status

String

任务状态,取值:

  • Waiting:等待中;
  • Processing:处理中;
  • Finish:已完成;
  • Failed:失败

Input

ImageSpriteTaskInput

雪碧图任务输入列表

BeginProcessTime

String

2021-11-09T12:00:00Z

任务开始执行的时间,日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

FinishTime

String

2021-11-09T12:00:00Z

任务执行完毕的时间,日期格式按照ISO8601标准表示,使用UTC时间,格式为:YYYY-MM-DDThh:mm:ssZ。

例如,2021-11-09T12:00:00Z代表北京时间2021年11月29日的20点0分0秒。

TranscodeTask

字段

类型

是否必填(创建)

示例

描述

TemplateId

String

sdfsdr21

视频转码模板 ID。

SnapshotByTimeOffsetTask

字段

类型

是否必填(创建)

示例

描述

TemplateId

String

sdfsdr21

指定时间点截图模板 ID。

SampleSnapshotTask

字段

类型

是否必填(创建)

示例

描述

TemplateId

String

sdfsdr21

采样截图模板 ID。

ImageSpriteTask

字段

类型

是否必填(创建)

示例

描述

TemplateId

String

sdfsdr21

雪碧图模板 ID。

TranscodeTaskInput

字段

类型

是否必填(创建)

示例

描述

TemplateId

String

sdfsdr21

视频转码模板 ID。

SnapshotByTimeOffsetTaskInput

字段

类型

是否必填(创建)

示例

描述

TemplateId

String

sdfsdr21

指定时间点截图模板 ID。

SampleSnapshotTaskInput

字段

类型

是否必填(创建)

示例

描述

TemplateId

String

sdfsdr21

采样截图模板 ID。

ImageSpriteTaskInput

字段

类型

是否必填(创建)

示例

描述

TemplateId

String

sdfsdr21

雪碧图模板 ID。


API示例

curl -X POST 'https://vod.streamlakeapi.com/?Action=DescribeTaskDetail \
-H 'Content-Type: application/json' \
-d '{"TaskId": "aa2e88a7e95db9f7"}' \
-H <公共请求参数>


返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMeta": {
"RequestId":"CixgpmAFOYcAAAAAAAAAAw",
"ErrorCode":"",
"ErrorMessage":""
},
"ResponseData": {
"TaskType": "Workflow",
"CreateTime": "2021-11-09T12:00:00Z",
"BeginProcessTime": "2021-11-09T13:00:00Z",
"FinishTime": "2021-11-09T14:00:00Z",
"WorkflowTaskResult": {
"TaskId": "xxx",
"Status": "Finish",
"MediaId": "s34sfsdgq",
"Metadata": {
"FileSize":61747,
"Height":852,
"Bitrate":443,
"Fps":25.0,
"Format":"mp4",
"Duration":1.1,
"Width":480,
"VideoMaxBitrate":900,
"VideoStreams":[
{
"Duration":1.1,
"Width":480,
"Height":852,
"Fps":25,
"Bitrate":419
}
],
"AudioStreams":[
{
"Duration":1.1,
"Bitrate":50,
"Channels":2,
"SampleRate":44100
}
]
},
"MediaProcessTaskResults": [
{
"Type": "Transcode",
"TranscodeTaskResult": {
"Status": "Finish",
"Input": {
"TemplateId": "xxxx"
},
"BeginProcessTime": "2021-11-09T13:00:00Z",
"FinishTime": "2021-11-09T14:00:00Z"
}
},
{
"Type": "SnapshotByTimeOffset",
"SnapshotByTimeOffsetResult": {
"Status": "Finish",
"Input": {
"TemplateId": "xxxx"
},
"BeginProcessTime": "2021-11-09T13:00:00Z",
"FinishTime": "2021-11-09T14:00:00Z"
}
}
]
}
}
}


错误码

ErrorCode

ErrorMessage

说明

状态码

ResourceNotFound

taskId:{taskId} not found

任务流不存在

404

InvalidArgument

TaskId required arguments are missing

必填参数TaskId 为空

400

上一篇:提交任务流下一篇:查询媒体处理作业
该篇文档内容是否对您有帮助?
有帮助没帮助