全部产品
Search

搜索本产品

    视频点播：ListTranscodeTask - 查询转码任务列表

    文档中心

    视频点播：ListTranscodeTask - 查询转码任务列表

    更新时间：Nov 04, 2024

    调用本接口根据音视频ID查询音视频历史转码任务信息，本接口不返回具体的作业信息。

    接口说明

    使用说明

    • 如需查询详细的转码作业信息，可以调用 GetTranscodeTask 接口查询。
    • 本接口仅支持查询一年内的转码任务数据。

    QPS 限制

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    VideoIdstring是

    音/视频 ID。可通过以下方式获取：

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

    开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2019-01-23T12:35:12Z
    EndTimestring否

    结束时间（需晚于开始时间）。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2019-01-23T12:40:12Z
    PageSizeinteger否

    查询页数据大小，传入此参数，立刻设置返回数据每页显示的条数。最大值为 50，默认值为 10。

    		10
    PageNointeger否

    查询数据的当前页码。传入此参数，可指定查询数据从第几页开始返回。默认值为 1。

    		1

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		25818875-5F78-4A*****F6-D7393642CA58
    TranscodeTaskListarray<object>

    转码处理信息列表。

    TranscodeTaskobject
    CreationTimestring

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

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

    触发类型。取值：

    • Auto：上传视频，自动触发。
    • Manual：SubmitTranscodeJobs 接口触发。
    		Auto
    TaskStatusstring

    转码任务状态。

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

    音/视频 ID。

    		d4860fcc6a5*****bce9fed52e893824
    CompleteTimestring

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

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

    转码使用的模板组 ID。

    		b500c7094bd24*****f3e9900752d7c3
    TranscodeTaskIdstring

    转码任务 ID。

    		b1b65ab107*****ba3dbb900f6c1fe0

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "TranscodeTaskList": [
    {
      "CreationTime": "2019-01-23T12:35:12Z",
      "Trigger": "Auto",
      "TaskStatus": "Processing",
      "VideoId": "d4860fcc6a5*****bce9fed52e893824",
      "CompleteTime": "2019-01-23T12:40:12Z",
      "TranscodeTemplateGroupId": "b500c7094bd24*****f3e9900752d7c3",
      "TranscodeTaskId": "b1b65ab107*****ba3dbb900f6c1fe0"
    }
  ]
}

    错误码

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