ListTranscodeJobs - Intelligent Media Services - Alibaba Cloud Documentation Center

Mengkueri daftar pekerjaan transkoding untuk file media.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ice:ListTranscodeJobs

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
StartOfCreateTime	string	No	Waktu mulai kondisi filter waktu pembuatan pekerjaan. Format: yyyy-MM-ddTHH:mm:ssZ.	2022-07-01T00:00:00Z
EndOfCreateTime	string	No	Waktu selesai kondisi filter waktu pembuatan pekerjaan. Format: yyyy-MM-ddTHH:mm:ssZ.	2022-07-15T00:00:00Z
ParentJobId	string	No	Filter berdasarkan jobId.	7b38a5d86f1e47838927b6e7ccb1****
Status	string	No	Status pekerjaan. Init: Dikirim. Success: Berhasil. Fail: Gagal.	Success
OrderBy	string	No	Urutan pengurutan. Saat ini hanya dua opsi yang didukung: CreateTimeDesc: Urutkan berdasarkan waktu pembuatan secara menurun. CreateTimeAsc: Urutkan berdasarkan waktu pembuatan secara menaik.	CreateTimeDesc
PageSize	integer	No	Ukuran halaman. Rentang: 0-100, nilai default: 20.	10
NextPageToken	string	No	Token untuk halaman berikutnya dalam kueri berhalaman berkelanjutan (tidak tersedia untuk halaman pertama).	ab4802364a2e49208c99efab82df****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	31E30781-9495-5E2D-A84D-759B0A01E262
Jobs	array<object>	Daftar pekerjaan.
	array<object>	Informasi pekerjaan.
CreateTime	string	Waktu pembuatan pekerjaan. Format: yyyy-MM-ddTHH:mm:ssZ.	2022-01-12T08:49:41Z
Name	string	Nama pekerjaan.	transcode-job
RequestId	string	ID permintaan saat mengirimkan pekerjaan.	31E30781-9495-5E2D-A84D-759B0A01E262
ParentJobId	string	ID pekerjaan induk.	8b2198504dd340b7b3c9842a74fc****
JobCount	integer	Jumlah sub-pekerjaan.	1
Status	string	Status pekerjaan. Success: Setelah semua sub-pekerjaan selesai, pekerjaan berhasil jika setidaknya satu sub-pekerjaan berhasil. Fail: Semua sub-pekerjaan gagal.	Success
TriggerSource	string	Sumber pemicu pekerjaan. API: API. WorkFlow: Alur kerja. Console: Konsol.	API
Percent	integer	Persentase penyelesaian pekerjaan.	0
SubmitTime	string	Waktu pengiriman pekerjaan. Format: yyyy-MM-ddTHH:mm:ssZ.	2022-01-12T08:49:41Z
FinishTime	string	Waktu penyelesaian pekerjaan. Format: yyyy-MM-ddTHH:mm:ssZ.	2022-01-12T08:49:41Z
InputGroup	array<object>	Kelompok input pekerjaan. Satu input menunjukkan pekerjaan transkoding. Beberapa input menunjukkan pekerjaan penggabungan audio/video.
	object	Input pekerjaan.
Type	string	The type of the media object. Valid values: OSS: an Object Storage Service (OSS) object. Media: a media asset.	OSS
Media	string	The media object. If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported. If Type is set to Media, the ID of a media asset is returned.	oss://bucket/path/to/video.mp4
InputUrl	string	The URL of the media asset. This parameter is specified only when the media asset is transcoded.	oss://bucket/path/to/video.mp4
OutputGroup	array<object>	Kelompok output pekerjaan.
	array<object>	Output pekerjaan.
Output	object	The output file configuration.
Type	string	The type of the media object. Valid values: OSS: an OSS object. Media: a media asset.	OSS
Media	string	The media object. If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported. If Type is set to Media, the ID of a media asset is returned.	oss://bucket/path/to/video.mp4
OutputUrl	string	The URL of the transcoded output stream. This parameter is required only when the output is a media asset.	oss://bucket/path/to/{MediaId}/{JobId}.mp4
ProcessConfig	object	The job processing configuration.
Transcode	object	The transcoding configuration.
TemplateId	string	The template ID.	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	The parameters that are used to overwrite the corresponding parameters of the template.
Video	object	The video settings.
Codec	string	The encoding format.	H.264
Profile	string	The encoding profile. Valid values: baseline, main, and high. baseline: applicable to mobile devices. main: applicable to standard-definition devices. high: applicable to high-definition devices. Default value: high.	Main
Bitrate	string	The average bitrate of the video. Valid values: [10,50000]. Unit: Kbit/s.	3000
Crf	string	The constant rate factor. Valid values: [0,51]. Default value: 23 if the encoding format is H.264, or 26 if the encoding format is H.265. If this parameter is set, the value of Bitrate becomes invalid.	23
Width	string	The width of the output video. Valid values: [128,4096]. Unit: pixels. Default value: the width of the input video.	1920
Height	string	The height of the output video. Valid values: [128,4096]. Unit: pixels. Default value: the height of the input video.	1080
Fps	string	The frame rate. Valid values: (0,60]. The value is 60 if the frame rate of the input video exceeds 60. Default value: the frame rate of the input video.	25
Gop	string	The maximum number of frames between two keyframes. Valid values: [1,1080000]. Default value: 250.	250
Preset	string	The preset video algorithm. This parameter takes effect only if the encoding format is H.264. Valid values: veryfast, fast, medium, slow, and slower. Default value: medium.	medium
ScanMode	string	The scan mode. Valid values: interlaced and progressive.	progressive
PixFmt	string	The pixel format of the video. Valid values: standard pixel formats such as yuv420p and yuvj420p.	yuv420p
Remove	string	Indicates whether the video was removed.	false
Crop	string	The method of video cropping. Valid values: border: automatically detects and removes black bars. A value in the width:height:left:top format: crops the videos based on the custom settings. Example: 1280:800:0:140.	1280:800:0:140
Pad	string	The black bars added to the video. Format: width:height:left:top. Example: 1280:800:0:140.	1280:800:0:140
LongShortMode	string	Indicates whether the auto-rotate screen feature is enabled.	false
Bufsize	string	The buffer size. Valid values: [1000,128000]. Default value: 6000. Unit: KB.	6000
Maxrate	string	The maximum bitrate of the output video. Valid values: [10,50000]. Unit: Kbit/s.	9000
AbrMax	string	The maximum adaptive bitrate (ABR). This parameter takes effect only for Narrowband HD 1.0. Valid values: [10,50000]. Unit: Kbit/s.	6000
Audio	object	The audio settings.
Codec	string	The audio codec. Valid values: AAC, MP3, VORBIS, and FLAC. Default value: AAC.	AAC
Profile	string	The audio codec profile. If the Codec parameter is set to AAC, the valid values are aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.	aac_low
Samplerate	string	The sampling rate. Default value: 44100. Valid values: 22050, 32000, 44100, 48000, and 96000. Unit: Hz.	44100
Bitrate	string	The audio bitrate of the output file. Valid values: [8,1000]. Unit: Kbit/s. Default value: 128.	128
Channels	string	The number of sound channels. Default value: 2.	2
Remove	string	Indicates whether the audio stream is deleted.	false
Volume	object	The volume configurations.
Method	string	The volume adjustment method. Valid values:	auto
IntegratedLoudnessTarget	string	The output volume.	-6
TruePeak	string	The peak volume.	-1
LoudnessRangeTarget	string	The volume range.	8
Container	object	The encapsulation format settings.
Format	string	The container format.	mp4
MuxConfig	object	The encapsulation settings.
Segment	object	The segment settings.
Duration	string	The segment length.	10
ForceSegTime	string	The forced segmentation point in time.	2,3
Tags	object
	string
ImageWatermarks	array<object>	The watermark configuration for an image.
	array<object>	The watermark configuration for an image.
TemplateId	string	The template ID.	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	The parameters that are used to overwrite the corresponding parameters of the template.
Width	string	The width of the output video.	32
Height	string	The height of the output video.	32
Dx	string	The position of the watermark on the x-axis.	10
Dy	string	The position of the watermark on the y-axis.	10
ReferPos	string	The reference position of the watermark. Valid values: TopLeft, TopRight, BottomLeft, and BottomRight. Default value: TopLeft.	TopLeft
Timeline	object	The timeline settings.
Start	string	The beginning of the time range for which data was queried.	00:00:05
Duration	string	The duration of the stream. Valid values: the number of seconds or "ToEND".	ToEND
File	object	The watermark image file.
Type	string	The type of the media object. Valid values: OSS: an OSS object. Media: a media asset.	OSS
Media	string	The media object. If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported. If Type is set to Media, the ID of a media asset is returned.	oss://bucket/path/to/video.mp4
TextWatermarks	array<object>	The configurations of the text watermarks.
	array<object>	The configurations of the text watermark.
TemplateId	string	The template ID.	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	The parameters that are used to overwrite the corresponding parameters of the template.
Content	string	The watermark text. Base64 encoding is not required. The string must be encoded in UTF-8.	测试水印
FontName	string	The font of the text.	SimSun
FontColor	string	The color of the text.	#006400
FontAlpha	string	The transparency of the watermark.	1.0
Top	string	The distance of the watermark from the top edge.	10
Left	string	The distance of the watermark from the left edge.	10
FontSize	integer	The size of the text.	16
BorderWidth	integer	The border width.	0
BorderColor	string	The border color.	#006400
Adaptive	string	Indicates whether the text size was adjusted based on the output video dimensions. true / false, default: false	false
Subtitles	array<object>	The subtitle configuration.
	array<object>	The subtitle configuration.
TemplateId	string	The template ID.	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	The parameters that are used to overwrite the corresponding parameters of the template.
Format	string	The format of the subtitle file.	vtt
CharEnc	string	The file encoding format.	UTF-8
File	object	The subtitle file.
Type	string	The type of the media object. Valid values: OSS: an OSS object. Media: a media asset.	OSS
Media	string	The media object. If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported. If Type is set to Media, the ID of a media asset is returned.	oss://bucket/path/to/video.mp4
Encryption	object	The encryption settings.
EncryptType	string	The encryption type.	PrivateEncryption
CipherText	string	The ciphertext of HTTP Live Streaming (HLS) encryption.	MTYi00NDU0LTg5O****
DecryptKeyUri	string	The endpoint of the decryption service for HLS encryption.	https://sample.com/path?CipherText=MTYi00NDU0LTg5O****
CombineConfigs	array<object>	The multi-input stream merge configuration.
	object
AudioIndex	string	The audio stream index.	0 或 exclude
VideoIndex	string	The video stream index.	0 或 exclude
Start	number	The start time of the input stream. Default value: 0.	0.0
Duration	number	The duration of the input stream. The default value is the duration of the video.	20.0
IsInheritTags	boolean	Indicates whether the tags of the input stream are inherited in the output stream. This parameter does not take effect when the input is not a media asset. Default value: false.
UserData	string	Data pengguna.	user-data
ScheduleConfig	object	Konfigurasi penjadwalan pekerjaan.
PipelineId	string	The ID of the MPS queue to which the job was submitted.	e37ebee5d98b4781897f6086e89f****
Priority	integer	The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.	5
NextPageToken	string	Token halaman berikutnya. Kosongkan untuk permintaan pertama. Token halaman berikutnya akan dikembalikan setelah kueri pertama.	019daf5780f74831b0e1a767c9f1****

Contoh

Respons sukses

JSONformat

{
  "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": false
          }
        }
      ],
      "UserData": "user-data",
      "ScheduleConfig": {
        "PipelineId": "e37ebee5d98b4781897f6086e89f****",
        "Priority": 5
      }
    }
  ],
  "NextPageToken": "019daf5780f74831b0e1a767c9f1****"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.