调用GetTranscodeSummary查询音视频转码摘要_视频点播(VOD)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vod:GetTranscodeSummary	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
VideoIds	string	是	音/视频 ID。最多支持 10 个 ID，多个 ID 之间使用半角逗号（,）分隔。音/视频 ID 可通过以下方式获取：通过控制台上传的音/视频，可登录点播控制台，选择媒资库 > 音/视频查看音/视频 ID。通过 CreateUploadVideo 接口获取上传地址和凭证时，音/视频 ID 为返回参数 VideoId 的值。音/视频上传后，可通过 SearchMedia 接口查询音/视频 ID，为请求后返回参数 VideoId 的值。	"d4860fcc6ae9fed52e8938244**,e1db68cc586644b83e562bcd94**,hhhhhhh"

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	25818875-5F78-4A*****F6-D7393642CA58
NonExistVideoIds	array	不存在的音/视频 ID 列表。
VideoId	string	不存在的音/视频 ID 列表。	["hhhhhhh"]
TranscodeSummaryList	array<object>	音/视频转码基础信息列表。
TranscodeSummary	object
CreationTime	string	转码任务创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2019-01-23T12:35:12Z
VideoId	string	音/视频 ID。	e1db68cc586644b83e562bcd94****
CompleteTime	string	转码任务完成时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2019-01-23T12:40:12Z
TranscodeStatus	string	转码处理状态。取值： Processing：处理中。 Partial：部分转码完成。 CompleteAllSucc：全部处理完成，且全部转码成功。 CompleteAllFail：全部处理完成，且全部转码失败，如果源片有问题，则不会发起任何转码作业，整个转码任务失败。 CompletePartialSucc：全部转码完成，但仅部分转码成功。	Processing
TranscodeTemplateGroupId	string	转码使用的模板组 ID。	44f9e406bbb*****736a9abe876ecc0
TranscodeJobInfoSummaryList	array<object>	转码作业摘要信息列表。
TranscodeJobInfoSummary	object
CreationTime	string	转码作业创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2019-02-27T03:34:46Z
ErrorMessage	string	转码失败的错误信息。	ErrorMessage
Height	string	转码输出视频的画面高。单位：px。	960
TranscodeProgress	long	转码进度。取值范围：`[0,100]`。	100
TranscodeTemplateId	string	使用的转码模板 ID。	57496724ae2*****0968d6e08acc8f6
Bitrate	string	转码输出视频的平均码率。单位：Kbps。	749
ErrorCode	string	转码失败的错误码。	200
CompleteTime	string	转码作业完成时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2019-02-27T03:40:51Z
Width	string	转码输出视频的画面宽。单位：px。	544
Duration	string	转码输出视频时长。单位：秒。	12
Fps	string	转码输出视频的帧率。单位：帧/秒。	30
TranscodeJobStatus	string	转码作业状态。取值： Transcoding：转码中。 TranscodeSuccess：转码成功。 TranscodeFail：转码失败。	Transcoding
Filesize	long	转码输出视频的文件大小。单位：Byte。	1144259
Format	string	转码输出视频的封装格式。	mp4
WatermarkIdList	array	转码使用的水印列表。
WatermarkId	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\"]"
          ]
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史