ListTranscodeJobs - 查詢轉碼工作清單 - Intelligent Media Services

查詢媒體檔案的轉碼工作清單。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ice:ListTranscodeJobs

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
StartOfCreateTime	string	否	任務建立時間篩選條件的起始時間。格式為：yyyy-MM-ddTHH:mm:ssZ。	2022-07-01T00:00:00Z
EndOfCreateTime	string	否	任務建立時間篩選條件的結束時間。格式為：yyyy-MM-ddTHH:mm:ssZ。	2022-07-15T00:00:00Z
ParentJobId	string	否	按 jobId 篩選。	7b38a5d86f1e47838927b6e7ccb1****
Status	string	否	任務狀態 Init：已提交。 Success：成功。 Fail：失敗。	Success
OrderBy	string	否	排序次序。目前只支援兩種： CreateTimeDesc：按建立時間降序和。 CreateTimeAsc：按建立時間升序。	CreateTimeDesc
PageSize	integer	否	分頁大小。範圍：0~100，預設值：20。	10
NextPageToken	string	否	連續分頁查詢時下一頁的標記（第一頁沒有）。	ab4802364a2e49208c99efab82df****

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 id	31E30781-9495-5E2D-A84D-759B0A01E262
Jobs	array<object>	工作清單。
	array<object>	任務資訊。
CreateTime	string	任務建立時間。格式為：yyyy-MM-ddTHH:mm:ssZ 。	2022-01-12T08:49:41Z
Name	string	任務名。	transcode-job
RequestId	string	提交任務時請求 ID。	31E30781-9495-5E2D-A84D-759B0A01E262
ParentJobId	string	主任務 ID。	8b2198504dd340b7b3c9842a74fc****
JobCount	integer	子任務數量。	1
Status	string	任務狀態。 Success：所有子任務完成後，有一個子任務則為成功。 Fail：所有子任務失敗。	Success
TriggerSource	string	任務來源。 API：API。 WorkFlow：工作流程, Console：控制台。	API
Percent	integer	任務完成百分比。	0
SubmitTime	string	任務提交時間。格式為：yyyy-MM-ddTHH:mm:ssZ 。	2022-01-12T08:49:41Z
FinishTime	string	任務結束時間。格式為：yyyy-MM-ddTHH:mm:ssZ 。	2022-01-12T08:49:41Z
InputGroup	array<object>	任務輸入組。單個輸入為轉碼任務。多個輸入為音視頻合流任務。
	object	任務輸入。
Type	string	媒體物件類型。取值： OSS：OSS 檔案。 Media：媒資 ID。	OSS
Media	string	媒體值： type 為 OSS 時，URL 支援 OSS 協議和 HTTP 協議。 type 為 Media 時，為媒資 ID。	oss://bucket/path/to/video.mp4
InputUrl	string	媒資流地址，只有當對媒資流進行轉碼時填寫此參數。	oss://bucket/path/to/video.mp4
OutputGroup	array<object>	任務輸出組。
	array<object>	任務輸出。
Output	object	輸出媒體配置
Type	string	媒體物件類型。取值： OSS: OSS 檔案。 Media: 媒資 ID。	OSS
Media	string	媒體值： type 為 OSS 時，URL 支援 OSS 協議和 HTTP 協議。 type 為 Media 時，為媒資 ID。	oss://bucket/path/to/video.mp4
OutputUrl	string	轉碼輸出資料流地址，僅當輸出到媒資流時需要填此參數	oss://bucket/path/to/{MediaId}/{JobId}.mp4
ProcessConfig	object	任務處理配置。
Transcode	object	轉碼配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	覆蓋參數, 若填寫會覆蓋模板對應參數。
Video	object	video 設定。
Codec	string	編碼格式。	H.264
Profile	string	編碼層級。支援 baseline、main、high。 baseline：針對行動裝置。 main：針對標準解析度裝置。 high：針對高解析度裝置。預設值：high。	Main
Bitrate	string	視頻平均碼率。取值範圍：[10，50000]。單位：Kbps。	3000
Crf	string	碼率-品質控制因子。取值範圍：[0，51]。預設值：編碼格式為 H264，預設值為 23。編碼格式為 H265，預設值為 26。如果設定了 Crf，則 Bitrate 的設定失效。	23
Width	string	寬。取值範圍：[128,4096]。單位：px。預設值：視頻原始寬度。	1920
Height	string	高。取值範圍：[128,4096]。單位：px。預設值：視頻原始高度。	1080
Fps	string	幀率。取值範圍：(0,60]。當輸入檔案幀率超過 60 時取 60。預設值：取輸入檔案幀率。	25
Gop	string	主要畫面格間最大幀數。取值範圍：[1，1080000]。預設值：250。	250
Preset	string	視頻演算法器預置。只有 H264 支援該參數。支援 veryfast、fast、medium、slow、slower。預設值：medium。	medium
ScanMode	string	掃描模式。支援 interlaced、progressive。	progressive
PixFmt	string	視頻顏色格式。範圍：yuv420p，yuvj420p 等標準顏色格式。	yuv420p
Remove	string	是否去掉視頻。	false
Crop	string	視頻畫面裁切。支援 2 種方式。自動檢測黑邊並裁切，設定為“border” 自訂裁切，參數格式：width:height:left:top。樣本：1280:800:0:140	1280:800:0:140
Pad	string	視頻貼黑邊。參數格式：width:height:left:top。樣本：1280:800:0:140	1280:800:0:140
LongShortMode	string	是否開啟橫豎屏自適應（即：長短邊模式）	false
Bufsize	string	緩衝區大小。值範圍：[1000，128000] 預設值：6000 單位：Kb	6000
Maxrate	string	視頻碼率峰值。值範圍[10，50000]，單位 Kbps。	9000
AbrMax	string	abr 最大碼率（只有窄高 1 有效）值範圍[10，50000]，單位 Kbps。	6000
Audio	object	audio 設定。
Codec	string	音頻編解碼格式，AAC、MP3、VORBIS、FLAC。預設值：AAC	AAC
Profile	string	音頻編碼的預置配置。當 Codec 為 AAC 時，預置值取值範圍：aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。	aac_low
Samplerate	string	採樣率。預設值：44100 支援 22050、32000、44100、48000、96000，單位：Hz	44100
Bitrate	string	輸出檔案的音頻碼率。值範圍：[8，1000] 單位：Kbps 預設值：128	128
Channels	string	聲道數。預設值：2	2
Remove	string	是否刪除音頻流。	false
Volume	object	音量控制。
Method	string	音量調整方式。	auto
IntegratedLoudnessTarget	string	目標音量。	-6
TruePeak	string	最大峰值。	-1
LoudnessRangeTarget	string	音量範圍。	8
Container	object	封裝格式設定。
Format	string	容器格式。	mp4
MuxConfig	object	封裝設定。
Segment	object	切片設定。
Duration	string	切片時間長度。	10
ForceSegTime	string	強制切片時間點。	2,3
Tags	object
	string
ImageWatermarks	array<object>	圖片浮水印配置。
	array<object>	圖片浮水印配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	覆蓋參數, 若填寫會覆蓋模板對應參數。
Width	string	寬。	32
Height	string	高。	32
Dx	string	浮水印位置，x	10
Dy	string	浮水印位置，y	10
ReferPos	string	參考位置：TopLeft, TopRight, BottomLeft, BottomRight 預設值：TopLeft	TopLeft
Timeline	object	顯示時間設定。
Start	string	開始時間。	00:00:05
Duration	string	顯示時間長度，秒數或者 "ToEND"	ToEND
File	object	浮水印圖片檔案。
Type	string	媒體物件類型。取值： OSS: OSS 檔案。 Media: 媒資 ID。	OSS
Media	string	媒體值： type 為 OSS 時，為 URL, 支援 OSS 協議和 HTTP 協議； type 為 Media 時，為媒資 ID。	oss://bucket/path/to/video.mp4
TextWatermarks	array<object>	文字浮水印配置。
	array<object>	文字浮水印配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	覆蓋參數, 若填寫會覆蓋模板對應參數。
Content	string	浮水印文本，不需要 base64 encode，字串需要 utf-8 編碼。	測試浮水印
FontName	string	字型。	SimSun
FontColor	string	顏色。	#006400
FontAlpha	string	透明度。	1.0
Top	string	浮水印位置，距離上邊距離。	10
Left	string	浮水印位置，距離左邊距離。	10
FontSize	integer	字型大小。	16
BorderWidth	integer	邊框寬度。	0
BorderColor	string	邊框顏色。	#006400
Adaptive	string	根據輸出視頻大小調整字型 size。 true：系統會根據輸出視頻的大小自動調整文本的字型大小。 false：字型大小將保持固定，不受輸出視頻大小的影響。預設值：false	false
Subtitles	array<object>	字幕壓制配置。
	array<object>	字幕壓制配置。
TemplateId	string	模板 ID。	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	覆蓋參數, 若填寫會覆蓋模板對應參數。
Format	string	字幕檔案格式。	vtt
CharEnc	string	檔案 encoding 格式。	UTF-8
File	object	字幕檔案。
Type	string	媒體物件類型。取值： OSS：OSS 檔案。 Media：媒資 ID。	OSS
Media	string	媒體值： type 為 OSS 時，為 URL, 支援 OSS 協議和 HTTP 協議； type 為 Media 時，為媒資 ID。	oss://bucket/path/to/video.mp4
Encryption	object	加密配置。
EncryptType	string	加密類型。	PrivateEncryption
CipherText	string	標準加密的密鑰密文。	MTYi00NDU0LTg5O****
DecryptKeyUri	string	標準加密的解密服務地址。	https://sample.com/path?CipherText=MTYi00NDU0LTg5O****
CombineConfigs	array<object>	多輸入合流配置
	object
AudioIndex	string	音頻流 Index	0 或 exclude
VideoIndex	string	視頻流 Index	0 或 exclude
Start	number	輸入資料流的開始時間。預設為 0	0.0
Duration	number	輸入資料流的期間。預設為視頻時間長度。	20.0
IsInheritTags	boolean	是否繼承輸入資料流的 tag。當輸入不是媒資是該參數不生效。預設值：false
UserData	string	使用者資料。	user-data
ScheduleConfig	object	任務調度配置。
PipelineId	string	管道 ID。	e37ebee5d98b4781897f6086e89f****
Priority	integer	任務優先順序。數字越大優先順序越高，取值範圍：1~10	5
NextPageToken	string	下一頁標識，第一次提交時為空白即可。下一頁標識將在第一次查詢後返回。	019daf5780f74831b0e1a767c9f1****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
  "Jobs": [
    {
      "CreateTime": "2022-01-12T08:49:41Z",
      "Name": "transcode-job",
      "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
      "ParentJobId": "8b2198504dd340b7b3c9842a74fc****",
      "JobCount": 1,
      "Status": "Success",
      "TriggerSource": "API",
      "Percent": 0,
      "SubmitTime": "2022-01-12T08:49:41Z",
      "FinishTime": "2022-01-12T08:49:41Z",
      "InputGroup": [
        {
          "Type": "OSS",
          "Media": "oss://bucket/path/to/video.mp4",
          "InputUrl": "oss://bucket/path/to/video.mp4"
        }
      ],
      "OutputGroup": [
        {
          "Output": {
            "Type": "OSS",
            "Media": "oss://bucket/path/to/video.mp4",
            "OutputUrl": "oss://bucket/path/to/{MediaId}/{JobId}.mp4"
          },
          "ProcessConfig": {
            "Transcode": {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
              "OverwriteParams": {
                "Video": {
                  "Codec": "H.264",
                  "Profile": "Main",
                  "Bitrate": "3000",
                  "Crf": "23",
                  "Width": "1920",
                  "Height": "1080",
                  "Fps": "25",
                  "Gop": "250",
                  "Preset": "medium",
                  "ScanMode": "progressive",
                  "PixFmt": "yuv420p",
                  "Remove": "false",
                  "Crop": "1280:800:0:140",
                  "Pad": "1280:800:0:140",
                  "LongShortMode": "false",
                  "Bufsize": "6000",
                  "Maxrate": "9000",
                  "AbrMax": "6000"
                },
                "Audio": {
                  "Codec": "AAC",
                  "Profile": "aac_low",
                  "Samplerate": "44100",
                  "Bitrate": "128",
                  "Channels": "2",
                  "Remove": "false",
                  "Volume": {
                    "Method": "auto",
                    "IntegratedLoudnessTarget": "-6",
                    "TruePeak": "-1",
                    "LoudnessRangeTarget": "8"
                  }
                },
                "Container": {
                  "Format": "mp4"
                },
                "MuxConfig": {
                  "Segment": {
                    "Duration": "10",
                    "ForceSegTime": "2,3"
                  }
                },
                "Tags": {
                  "key": ""
                }
              }
            },
            "ImageWatermarks": [
              {
                "TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
                "OverwriteParams": {
                  "Width": "32",
                  "Height": "32",
                  "Dx": "10",
                  "Dy": "10",
                  "ReferPos": "TopLeft",
                  "Timeline": {
                    "Start": "00:00:05",
                    "Duration": "ToEND"
                  },
                  "File": {
                    "Type": "OSS",
                    "Media": "oss://bucket/path/to/video.mp4"
                  }
                }
              }
            ],
            "TextWatermarks": [
              {
                "TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
                "OverwriteParams": {
                  "Content": "測試浮水印",
                  "FontName": "SimSun",
                  "FontColor": "#006400",
                  "FontAlpha": "1.0",
                  "Top": "10",
                  "Left": "10",
                  "FontSize": 16,
                  "BorderWidth": 0,
                  "BorderColor": "#006400",
                  "Adaptive": "false"
                }
              }
            ],
            "Subtitles": [
              {
                "TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
                "OverwriteParams": {
                  "Format": "vtt",
                  "CharEnc": "UTF-8",
                  "File": {
                    "Type": "OSS",
                    "Media": "oss://bucket/path/to/video.mp4"
                  }
                }
              }
            ],
            "Encryption": {
              "EncryptType": "PrivateEncryption",
              "CipherText": "MTYi00NDU0LTg5O****",
              "DecryptKeyUri": "https://sample.com/path?CipherText=MTYi00NDU0LTg5O****"
            },
            "CombineConfigs": [
              {
                "AudioIndex": "0 或 exclude",
                "VideoIndex": "0 或 exclude",
                "Start": 0,
                "Duration": 20
              }
            ],
            "IsInheritTags": true
          }
        }
      ],
      "UserData": "user-data",
      "ScheduleConfig": {
        "PipelineId": "e37ebee5d98b4781897f6086e89f****",
        "Priority": 5
      }
    }
  ],
  "NextPageToken": "019daf5780f74831b0e1a767c9f1****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。