文档

QueryAnalysisJobList - 查询模板分析作业

更新时间:

查询模板分析作业,模板分析作业完成后,返回可用的预置模板列表。

接口说明

本接口一次最多可查询 10 个模板分析作业。

QPS 限制

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

调试

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

授权信息

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

请求参数

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

模板分析作业 ID 列表。

  • 一次最多查询 10 个。
  • 多个使用半角逗号(,)作为分隔符。
bb558c1cc25b45309aab5be44d19****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

5CA6E020-4102-4FFF-AA56-5ED7ECD811A1
AnalysisJobListobject []

模板分析作业列表。

CreationTimestring

作业添加时间。

2014-01-10T12:00:00Z
Percentlong

转码进度。

86
Statestring

作业状态。

  • Submitted:已提交。

  • Analyzing:分析中。

  • Success:成功。

  • Fail:失败。

Success
AnalysisConfigobject

作业配置。

QualityControlobject

输出质量控制。

MethodStreamingstring

播放方式。

  • network:在线。

  • local:本地。

  • 默认值:network

network
RateQualitystring

输出质量等级。默认值:25

25
PropertiesControlobject

属性控制。

Deinterlacestring

强制扫描模式判定。

  • Auto:自动。
  • Force:强制做 deinterlace。
  • None:强制不做 deinterlace。
Auto
Cropobject

视频裁切配置。

Topstring

裁切上边距。

说明 如果 Mode 为 Auto 或 None,则此值失效。
8
Widthstring

裁切后宽。

说明 如果 Mode 为 Auto 或 None,则此值失效。
8
Heightstring

裁切后高。

说明 如果 Mode 为 Auto 或 None,则此值失效。
8
Leftstring

裁切左边距。

说明 如果 Mode 为 Auto 或 None,则此值失效。
8
Modestring

裁切方式。取值:

  • Auto:自动。
  • Force:强制。
  • None:强制不做。
  • 如 Crop 不是空 JSON{},则此值必填。
Auto
Messagestring

分析失败时错误信息。

The resource operated \"PipelineId\" cannot be found
Prioritystring

任务在其对应管道内的优先级。

  • 取值范围:[1,10]。10 为最高优先级。
  • 默认值:10
8
MNSMessageResultobject

MNS 通知用户作业完成的结果。

MessageIdstring

成功时消息 ID。分析失败时不返回此参数。

3ca84a39a9024f19853b21be9cf9****
ErrorMessagestring

失败时错误信息。分析成功时不返回此参数。

The resource operated \"PipelineId\" cannot be found
ErrorCodestring

失败时错误码。分析成功时不返回此参数。

InvalidParameter.ResourceNotFound
TemplateListobject []

作业输出的预置模板列表。

Videoobject

视频编解码配置。

Bufsizestring

缓冲区大小。

  • 单位:Kb。
  • 默认值:6000
6000
Degrainstring

独立去噪算法强度。

5
BitrateBndobject

视频平均码率范围。

Maxstring

总码率上限。单位:Kbps。

1500
Minstring

总码率下限。单位:Kbps。

800
PixFmtstring

视频颜色格式。包含 yuv420p,yuvj420p 等标准颜色格式。

yuv420p
Codecstring

编解码格式。支持 H.264、H.265。 默认值:H.264

H.264
Heightstring

视频高。

  • 单位:px。
  • 默认值:视频原始高度
720
Qscalestring

视频质量控制度。

15
Bitratestring

视频平均码率。单位:Kbps。

1000
Maxratestring

视频码率峰值。

  • 取值范围:[10,50000]
  • 单位:Kbps。
2000
Profilestring

编码级别。

  • baseline:针对移动设备。
  • main:针对标准分辨率设备。
  • high:针对高分辨率设备。
  • 默认值:high
high
Crfstring

码率-质量控制因子。

  • 默认值:编码格式为 H264,默认值为 23。编码格式为 H265,默认值为 26
  • 如果设置了 Crf,则 Bitrate 的设置失效。
26
Gopstring

关键帧间最大帧数。默认值:250

250
Widthstring

视频宽。

  • 单位:px。
  • 默认值:视频原始宽度
1280
Fpsstring

帧率。

  • 当输入文件帧率超过 60 时取 60。
  • 默认值:取输入文件帧率
25
Presetstring

视频算法器预置。支持 veryfast(超快)、fast(快)、medium(中等)、slow(慢)、slower(超慢)。 默认值:medium

medium
ScanModestring

扫描模式。取值:

  • interlaced:交叉扫描。

  • progressive:顺序扫描。

interlaced
TransConfigobject

转码通用配置。

TransModestring

转码模式。默认值:onepass。可选范围:

  • onepass

  • twopass

  • CBR

onepass
Statestring

模板的状态。

  • Normal:正常。

  • Deleted:已删除。

Normal
MuxConfigobject

转码封包配置。

Gifobject

gif 格式。

FinalDelaystring

gif 的 loop 间隔,单位为百分之一秒,比如 500 代表间隔为 5 秒。

0
Loopstring

gif 与 webp 循环次数,默认不循环。

0
Segmentobject

切片配置。

Durationstring

分片时长。单位:秒。

10
Namestring

模板名称。

FLV-UD
Audioobject

音频编解码配置。

Profilestring

音频编码预置。当 Codecaac 时可取值:

  • aac_low

  • aac_he

  • aac_he_v2

  • aac_ld

  • aac_eld

aac_low
Codecstring

音频编解码格式。默认值:aac。可取值:

  • aac

  • mp3

  • vorbis

  • flac

aac
Sampleratestring

采样率。

  • 单位:Hz。
  • 默认值:44100
44100
Qscalestring

音频质量控制度。

15
Channelsstring

声道数。默认值:2

2
Bitratestring

输出文件的音频码率。

  • 取值范围:8~1000
  • 单位:Kbps。
  • 默认值:128
128
Idstring

转码模板 ID。

S00000000-00****
Containerobject

容器。

Formatstring

容器格式。

flv
UserDatastring

用户自定义数据。

testid-001
Codestring

分析失败时错误码。

InvalidParameter.ResourceNotFound
InputFileobject

作业输入。

Objectstring

OSS 的 Object。

example.flv
Locationstring

OSS 的服务区域。

oss-cn-hangzhou
Bucketstring

输入文件的 OSS Bucket。

example-bucket
PipelineIdstring

管道 ID。

bb558c1cc25b45309aab5be44d19****
Idstring

模板分析作业 ID。

57f6aa3f84824309bcba67231b406****
NonExistAnalysisJobIdsarray

不存在的模板分析作业。

string

不存在的模板分析作业 ID 列表,无数据时该结构不返回。

null

示例

正常返回示例

JSON格式

{
  "RequestId": "5CA6E020-4102-4FFF-AA56-5ED7ECD811A1",
  "AnalysisJobList": {
    "AnalysisJob": [
      {
        "CreationTime": "2014-01-10T12:00:00Z",
        "Percent": 86,
        "State": "Success",
        "AnalysisConfig": {
          "QualityControl": {
            "MethodStreaming": "network",
            "RateQuality": "25"
          },
          "PropertiesControl": {
            "Deinterlace": "Auto",
            "Crop": {
              "Top": "8",
              "Width": "8",
              "Height": "8",
              "Left": "8",
              "Mode": "Auto"
            }
          }
        },
        "Message": "The resource operated \\\"PipelineId\\\" cannot be found",
        "Priority": "8",
        "MNSMessageResult": {
          "MessageId": "3ca84a39a9024f19853b21be9cf9****",
          "ErrorMessage": "The resource operated \\\"PipelineId\\\" cannot be found",
          "ErrorCode": "InvalidParameter.ResourceNotFound"
        },
        "TemplateList": {
          "Template": [
            {
              "Video": {
                "Bufsize": "6000",
                "Degrain": "5",
                "BitrateBnd": {
                  "Max": "1500",
                  "Min": "800"
                },
                "PixFmt": "yuv420p",
                "Codec": "H.264",
                "Height": "720",
                "Qscale": "15",
                "Bitrate": "1000",
                "Maxrate": "2000",
                "Profile": "high",
                "Crf": "26",
                "Gop": "250",
                "Width": "1280",
                "Fps": "25",
                "Preset": "medium",
                "ScanMode": "interlaced"
              },
              "TransConfig": {
                "TransMode": "onepass"
              },
              "State": "Normal",
              "MuxConfig": {
                "Gif": {
                  "FinalDelay": "0",
                  "Loop": "0"
                },
                "Segment": {
                  "Duration": "10"
                }
              },
              "Name": "FLV-UD",
              "Audio": {
                "Profile": "aac_low",
                "Codec": "aac",
                "Samplerate": "44100",
                "Qscale": "15",
                "Channels": "2",
                "Bitrate": "128"
              },
              "Id": "S00000000-00****",
              "Container": {
                "Format": "flv"
              }
            }
          ]
        },
        "UserData": "testid-001",
        "Code": "InvalidParameter.ResourceNotFound",
        "InputFile": {
          "Object": "example.flv",
          "Location": "oss-cn-hangzhou",
          "Bucket": "example-bucket"
        },
        "PipelineId": "bb558c1cc25b45309aab5be44d19****",
        "Id": "57f6aa3f84824309bcba67231b406****"
      }
    ]
  },
  "NonExistAnalysisJobIds": {
    "String": [
      "null"
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈