文档

ListPackageJobs - 获取打包任务列表

更新时间:

获取打包任务列表接口。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

任务创建时间筛选条件的起始时间。格式为: yyyy-MM-ddTHH:mm:ssZ。

2022-07-01T00:00:00Z
EndOfCreateTimestring

任务创建时间筛选条件的结束时间。格式为: yyyy-MM-ddTHH:mm:ssZ。

2022-07-15T00:00:00Z
JobIdstring

按 jobId 筛选。

7b38a5d86f1e47838927b6e7ccb11cbe
Statusstring

任务状态

  • Init: 已提交,
  • Success: 成功,
  • Fail: 失败
Success
OrderBystring

排序顺序。目前只支持两种:CreateTimeDesc: 按创建时间降序和 CreateTimeAsc: 按创建时间升序

CreateTimeDesc
PageSizeinteger

分页大小。范围:0~100,默认值:20。

10
NextPageTokenstring

连续分页查询时下一页的标记(第一页没有)。

ab4802364a2e49208c99efab82dfa8e8

返回参数

名称类型描述示例值
object
RequestIdstring

请求 id。

31E30781-9495-5E2D-A84D-759B0A01E262
PackageJobListobject

打包任务列表。

PackageJobsobject []

打包任务列表。

JobIdstring

任务 ID。

7b38a5d86f1e47838927b6e7ccb11cbe
TriggerSourcestring

任务来源。 API: API, WorkFlow: 工作流, Console: 控制台

API
Namestring

任务名称。

job-name
Inputsobject []

任务输入。

Inputobject

打包播放流文件信息。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
Outputobject

任务输出。

Typestring

媒体对象类型。 取值:

  • OSS: OSS 文件。
  • Media: 媒资 ID。
OSS
Mediastring

媒体值:

  • type 为 OSS 时,为 URL, 支持 OSS 协议和 HTTP 协议;
  • type 为 Media 时,为媒资 ID。
oss://bucket/path/to/video.mp4
PipelineIdstring

管道 ID。

5b40833e4c3e4d4e95a866abb9a42510
Priorityinteger

任务优先级。数字越大优先级越高,取值范围:1~10。默认为 6。

6
Statusstring

任务状态。

Success
Codestring

错误码。

InvalidParameter
Messagestring

错误消息。

Resource content bad.
SubmitTimestring

任务提交时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

2022-07-07T14:00:32Z
FinishTimestring

任务结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

2022-07-07T15:00:32Z
UserDatastring

用户自定义信息。

{"param": "value"}
CreateTimestring

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

2022-07-07T14:00:32Z
ModifiedTimestring

最后修改时间。格式为:yyyy-MM-ddTHH:mm:ssZ 。

2022-07-07T15:00:32Z
NextPageTokenstring

下一页标识,第一次提交时为空即可。下一页标识将在第一次查询后返回。

019daf5780f74831b0e1a767c9f1c178

示例

正常返回示例

JSON格式

{
  "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
  "PackageJobList": {
    "PackageJobs": [
      {
        "JobId": "7b38a5d86f1e47838927b6e7ccb11cbe",
        "TriggerSource": "API",
        "Name": "job-name",
        "Inputs": [
          {
            "Input": {
              "Type": "OSS",
              "Media": "oss://bucket/path/to/video.mp4"
            }
          }
        ],
        "Output": {
          "Type": "OSS",
          "Media": "oss://bucket/path/to/video.mp4"
        },
        "PipelineId": "5b40833e4c3e4d4e95a866abb9a42510",
        "Priority": 6,
        "Status": "Success",
        "Code": "InvalidParameter",
        "Message": "Resource content bad. ",
        "SubmitTime": "2022-07-07T14:00:32Z",
        "FinishTime": "2022-07-07T15:00:32Z",
        "UserData": "{\"param\": \"value\"}",
        "CreateTime": "2022-07-07T14:00:32Z",
        "ModifiedTime": "2022-07-07T15:00:32Z"
      }
    ],
    "NextPageToken": "019daf5780f74831b0e1a767c9f1c178"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈