调用GetTranscodeSummary根据视频ID查询视频转码摘要,包括视频转码状态、转码进展等汇总信息。由于可能存在多次转码,故该接口只返回最近一次的转码摘要。

说明 如要查询历史转码任务信息,可调用ListTranscodeTask接口。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetTranscodeSummary

系统规定参数。取值:GetTranscodeSummary

VideoIds String "d4860fcc6a*****e9fed52e893824,e1db68cc58664*****4b83e562bcd9,hhhhhhh"

视频ID。多个ID使用英文逗号(,)分隔,最多支持10个。

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-4A*****F6-D7393642CA58

请求ID。

NonExistVideoIds Array of String ["hhhhhhh"]

不存在的视频ID列表。

TranscodeSummaryList Array of TranscodeSummary

视频转码基础信息列表。

CreationTime String 2019-01-23T12:35:12Z

转码任务创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

VideoId String e1db68cc58664*****4b83e562bcd9

视频ID。

CompleteTime String 2019-01-23T12:40:12Z

转码任务完成时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

TranscodeStatus String Processing

转码处理状态。取值:

  • Processing:处理中。
  • Partial:部分转码完成。
  • CompleteAllSucc:全部处理完成,且全部转码成功。
  • CompleteAllFail:全部处理完成,且全部转码失败,如果源片有问题,则不会发起任何转码作业,整个转码任务失败。
  • CompletePartialSucc:全部转码完成,但仅部分转码成功。
TranscodeTemplateGroupId String 44f9e406bbb*****736a9abe876ecc0

转码使用的模板组ID。

TranscodeJobInfoSummaryList Array of TranscodeJobInfoSummary

转码作业摘要信息列表。

CreationTime String 2019-02-27T03:34:46Z

转码作业创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

ErrorMessage String ErrorMessage

转码失败的错误信息。

Height String 960

转码输出视频的画面高。单位:px。

TranscodeProgress Long 100

转码进度。取值范围:[0,100]

TranscodeTemplateId String 57496724ae2*****0968d6e08acc8f6

使用的转码模板ID。

Bitrate String 749

转码输出视频的平均码率。单位:kbps。

ErrorCode String 200

转码失败的错误码。

CompleteTime String 2019-02-27T03:40:51Z

转码作业完成事件。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Width String 544

转码输出视频的画面宽。单位:px。

Duration String 12

转码输出视频时长。单位:秒。

Fps String 30

转码输出视频的帧率。单位:帧/秒。

TranscodeJobStatus String Transcoding

转码作业状态。取值:

  • Transcoding:转码中。
  • TranscodeSuccess:转码成功。
  • TranscodeFail:转码失败。
Filesize Long 1144259

转码输出视频的文件大小。单位:Byte。

Format String mp4

转码输出视频的封装格式。

WatermarkIdList Array of String ["af2afe4761992c*****d947dae97337"]

转码使用的水印列表。

示例

请求示例

https://vod.{ApiRegion}.aliyuncs.com/?Action=GetTranscodeSummary
&VideoIds="d4860fcc6a*****e9fed52e893824,e1db68cc58664*****4b83e562bcd9,hhhhhhh"
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetTranscodeSummaryResponse>
<RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
	<TranscodeSummaryList>
		<VideoId>e1db68cc58664*****4b83e562bcd9</VideoId>
		<TranscodeStatus>Processing</TranscodeStatus>
		<TranscodeTemplateGroupId>44f9e406bbb*****736a9abe876ecc0</TranscodeTemplateGroupId>
		<CreationTime>2019-01-23T12:35:12Z</CreationTime>
		<CompleteTime>2019-01-23T12:40:12Z</CompleteTime>
		<TranscodeJobInfoSummaryList>
			<Format>mp4</Format>
			<Encryption>{}</Encryption>
			<TranscodeProgress>100</TranscodeProgress>
			<Height>960</Height>
			<CreationTime>2019-02-27T03:34:46Z</CreationTime>
			<CompleteTime>2019-02-27T03:40:51Z</CompleteTime>
			<TranscodeJobStatus>TranscodeSuccess</TranscodeJobStatus>
			<Filesize>1144259</Filesize>
			<WatermarkIdList>af2afe4761992c*****d947dae97337</WatermarkIdList>
			<Duration>12</Duration>
			<TranscodeTemplateId>57496724ae2*****0968d6e08acc8f6</TranscodeTemplateId>
			<Width>544</Width>
			<Fps>30</Fps>
			<Bitrate>749</Bitrate>
			<Definition>LD</Definition>
		</TranscodeJobInfoSummaryList>
		<TranscodeJobInfoSummaryList>
			<Format>m3u8</Format>
			<Encryption>{&quot;EncryptType&quot;:&quot;AliyunVoDEncryption&quot;}</Encryption>
			<TranscodeProgress>100</TranscodeProgress>
			<Height>640</Height>
			<CreationTime>2019-02-27T03:34:46Z</CreationTime>
			<CompleteTime>2019-02-27T03:40:50Z</CompleteTime>
			<TranscodeJobStatus>TranscodeSuccess</TranscodeJobStatus>
			<Filesize>759520</Filesize>
			<Duration>12</Duration>
			<TranscodeTemplateId>4733b3a55b27*****82dae36ac22d34</TranscodeTemplateId>
			<Width>360</Width>
			<Fps>25</Fps>
			<Bitrate>499</Bitrate>
			<Definition>LD</Definition>
		</TranscodeJobInfoSummaryList>
	</TranscodeSummaryList>
	<NonExistVideoIds>hhhhhhh</NonExistVideoIds>
</GetTranscodeSummaryResponse>

JSON格式

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

{
  "RequestId" : "25818875-5F78-4A*****F6-D7393642CA58",
  "TranscodeSummaryList" : [ {
    "VideoId" : "e1db68cc58664*****4b83e562bcd9",
    "TranscodeStatus" : "Processing",
    "TranscodeTemplateGroupId" : "44f9e406bbb*****736a9abe876ecc0",
    "CreationTime" : "2019-01-23T12:35:12Z",
    "CompleteTime" : "2019-01-23T12:40:12Z",
    "TranscodeJobInfoSummaryList" : [ {
      "Format" : "mp4",
      "Encryption" : "{}",
      "TranscodeProgress" : 100,
      "Height" : "960",
      "CreationTime" : "2019-02-27T03:34:46Z",
      "CompleteTime" : "2019-02-27T03:40:51Z",
      "TranscodeJobStatus" : "TranscodeSuccess",
      "Filesize" : 1144259,
      "WatermarkIdList" : [ "af2afe4761992c*****d947dae97337" ],
      "Duration" : "12",
      "TranscodeTemplateId" : "57496724ae2*****0968d6e08acc8f6",
      "Width" : "544",
      "Fps" : "30",
      "Bitrate" : "749",
      "Definition" : "LD"
    }, {
      "Format" : "m3u8",
      "Encryption" : "{\"EncryptType\":\"AliyunVoDEncryption\"}",
      "TranscodeProgress" : 100,
      "Height" : "640",
      "CreationTime" : "2019-02-27T03:34:46Z",
      "CompleteTime" : "2019-02-27T03:40:50Z",
      "TranscodeJobStatus" : "TranscodeSuccess",
      "Filesize" : 759520,
      "Duration" : "12",
      "TranscodeTemplateId" : "4733b3a55b27*****82dae36ac22d34",
      "Width" : "360",
      "Fps" : "25",
      "Bitrate" : "499",
      "Definition" : "LD"
    } ]
  } ],
  "NonExistVideoIds" : [ "hhhhhhh" ]
}

错误码

访问错误中心查看更多错误码。