首页 视频点播 API参考指南 API目录 媒体处理 转码任务 GetTranscodeSummary - 查询音视频转码摘要

GetTranscodeSummary - 查询音视频转码摘要

调用GetTranscodeSummary根据音视频ID查询音视频转码摘要,包括音视频转码状态、转码进展等汇总信息。

接口说明

  • 由于音视频可能存在多次转码,故本接口只返回最近一次的转码摘要。
  • 支持批量查询,单次最多可查询10个音视频的转码摘要。
  • 如需查询历史转码任务信息,可调用ListTranscodeTask接口查询。
  • 本接口仅支持查询一年内的转码任务数据。

QPS限制

本接口的单用户QPS限制为15次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:GetTranscodeSummaryRead
  • VOD
    acs:vod:*:{#accountId}:*

请求参数

名称类型必填描述示例值
VideoIdsstring

音/视频ID。最多支持10个ID,多个ID之间使用半角逗号(,)分隔。音/视频ID可通过以下方式获取:

  • 通过控制台上传的音/视频,可登录点播控制台,选择媒资库 > 音/视频查看音/视频ID。
  • 通过CreateUploadVideo接口获取上传地址和凭证时,音/视频ID为返回参数VideoId的值。
  • 音/视频上传后,可通过SearchMedia接口查询音/视频ID,为请求后返回参数VideoId的值。
"d4860fcc6ae9fed52e8938244****,e1db68cc586644b83e562bcd94****,hhhhhhh"

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

25818875-5F78-4A*****F6-D7393642CA58
NonExistVideoIdsarray

不存在的音/视频ID列表。

string

不存在的音/视频ID列表。

["hhhhhhh"]
TranscodeSummaryListarray

音/视频转码基础信息列表。

object
CreationTimestring

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

2019-01-23T12:35:12Z
VideoIdstring

音/视频ID。

e1db68cc586644b83e562bcd94****
CompleteTimestring

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

2019-01-23T12:40:12Z
TranscodeStatusstring

转码处理状态。取值:

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

转码使用的模板组ID。

44f9e406bbb*****736a9abe876ecc0
TranscodeJobInfoSummaryListarray

转码作业摘要信息列表。

object
CreationTimestring

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

2019-02-27T03:34:46Z
ErrorMessagestring

转码失败的错误信息。

ErrorMessage
Heightstring

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

960
TranscodeProgresslong

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

100
TranscodeTemplateIdstring

使用的转码模板ID。

57496724ae2*****0968d6e08acc8f6
Bitratestring

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

749
ErrorCodestring

转码失败的错误码。

200
CompleteTimestring

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

2019-02-27T03:40:51Z
Widthstring

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

544
Durationstring

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

12
Fpsstring

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

30
TranscodeJobStatusstring

转码作业状态。取值:

  • Transcoding:转码中。
  • TranscodeSuccess:转码成功。
  • TranscodeFail:转码失败。
Transcoding
Filesizelong

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

1144259
Formatstring

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

mp4
WatermarkIdListarray

转码使用的水印列表。

string

转码使用的水印列表。

["af2afe4761992c*****d947dae97337"]

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "NonExistVideoIds": [
    "[\"hhhhhhh\"]"
  ],
  "TranscodeSummaryList": [
    {
      "CreationTime": "2019-01-23T12:35:12Z",
      "VideoId": "e1db68cc586644b83e562bcd94****",
      "CompleteTime": "2019-01-23T12:40:12Z",
      "TranscodeStatus": "Processing",
      "TranscodeTemplateGroupId": "44f9e406bbb*****736a9abe876ecc0",
      "TranscodeJobInfoSummaryList": [
        {
          "CreationTime": "2019-02-27T03:34:46Z",
          "ErrorMessage": "ErrorMessage",
          "Height": "960",
          "TranscodeProgress": 100,
          "TranscodeTemplateId": "57496724ae2*****0968d6e08acc8f6",
          "Bitrate": "749",
          "ErrorCode": "200",
          "CompleteTime": "2019-02-27T03:40:51Z",
          "Width": "544",
          "Duration": "12",
          "Fps": "30",
          "TranscodeJobStatus": "Transcoding",
          "Filesize": 1144259,
          "Format": "mp4",
          "WatermarkIdList": [
            "[\"af2afe4761992c*****d947dae97337\"]"
          ]
        }
      ]
    }
  ]
}

错误码

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

阿里云首页 视频点播 相关技术圈