Tous les produits
Search

Ce produit

    :ListTranscodeJobs

    Centre de documentation

    :ListTranscodeJobs

    Dernière mise à jour :Aug 07, 2026

    Répertorie les travaux de transcodage d'un fichier média.

    Testez maintenant

    Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

    Test

    Autorisation RAM

    Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

    • Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.

    • API : l'API que vous pouvez appeler pour exécuter l'action.

    • Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.

    • Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.

      • Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.

      • Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.

    • Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.

    • Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

    ice:ListTranscodeJobs

    *All Resource

    *

    		 Aucune Aucune

    Paramètres de requête

    Paramètre

    Type

    Requis

    Description

    Exemple
    StartOfCreateTime

    string

    Non

    Le début de la plage de temps permettant de filtrer les travaux selon leur heure de création. L'heure doit être en UTC et au format yyyy-MM-ddTHH:mm:ssZ.

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

    string

    Non

    La fin de la plage de temps permettant de filtrer les travaux selon leur heure de création. L'heure doit être en UTC et au format yyyy-MM-ddTHH:mm:ssZ.

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

    string

    Non

    Filtre par identifiant de travail.

    7b38a5d86f1e47838927b6e7ccb1****
    Status

    string

    Non

    L'état de la tâche. Valeurs valides :

    • Init : Soumis.

    • Success : Réussi.

    • Fail : Échoué.

    Success
    OrderBy

    string

    Non

    L'ordre de tri. Valeurs valides :

    • CreateTimeDesc : Trie par ordre décroissant de l'heure de création.

    • CreateTimeAsc : Trie par ordre croissant de l'heure de création.

    CreateTimeDesc
    PageSize

    integer

    Non

    Le nombre d'entrées par page. Valeurs valides : 1 à 100. Valeur par défaut : 20.

    10
    NextPageToken

    string

    Non

    Le jeton pour la page de résultats suivante. Non requis pour la première page.

    ab4802364a2e49208c99efab82df****

    Éléments de réponse

    Élément

    Type

    Description

    Exemple

    object

    RequestId

    string

    L'identifiant de la requête.

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

    array<object>

    La liste des tâches.

    array<object>

    Les détails de la tâche.

    CreateTime

    string

    L'heure de création de la tâche. L'heure est au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.

    2022-01-12T08:49:41Z
    Name

    string

    Le nom de la tâche.

    transcode-job
    RequestId

    string

    L'identifiant de la requête de la tâche.

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

    string

    L'identifiant de la tâche parente.

    8b2198504dd340b7b3c9842a74fc****
    JobCount

    integer

    Le nombre de sous-tâches.

    1
    Status

    string

    L'état de la tâche. Valeurs valides :

    • Success : La tâche réussit si au moins une sous-tâche réussit.

    • Fail : La tâche échoue si toutes les sous-tâches échouent.

    Success
    TriggerSource

    string

    La source de la tâche. Valeurs valides :

    • API : La tâche est soumise en appelant une opération d'API.

    • Workflow : La tâche est déclenchée par un workflow.

    • Console : La tâche est soumise depuis la console.

    API
    Percent

    integer

    La progression de la tâche.

    0
    SubmitTime

    string

    L'heure de soumission de la tâche. L'heure est au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.

    2022-01-12T08:49:41Z
    FinishTime

    string

    L'heure de fin de la tâche. L'heure est au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.

    2022-01-12T08:49:41Z
    InputGroup

    array<object>

    Le groupe d'entrées de la tâche. Une entrée unique indique une tâche de transcodage. Plusieurs entrées indiquent une tâche de composition.

    object

    L'entrée de la tâche.

    Type

    string

    The type of the media asset. Valid values:

    • OSS: an OSS file.

    • Media: a media asset ID.

    OSS
    Media

    string

    The media information. The value of this parameter varies based on the value of Type.

    • If Type is set to OSS, the value of this parameter must be an OSS URL. Both the oss:// and http(s):// protocols are supported.

    • If Type is set to Media, the value of this parameter must be a media ID.

    oss://bucket/path/to/video.mp4
    InputUrl

    string

    The URL of the media stream. This parameter is required only when you transcode a media stream.

    oss://bucket/path/to/video.mp4
    OutputGroup

    array<object>

    Le groupe de sorties de la tâche.

    array<object>

    La sortie de la tâche.

    Output

    object

    The output media configuration.

    Type

    string

    The type of the media asset. Valid values:

    • OSS: an OSS file.

    • Media: a media asset ID.

    OSS
    Media

    string

    The media information. The value of this parameter varies based on the value of Type.

    • If Type is set to OSS, the value of this parameter must be an OSS URL. Both the oss:// and http(s):// protocols are supported.

    • If Type is set to Media, the value of this parameter must be a media ID.

    oss://bucket/path/to/video.mp4
    OutputUrl

    string

    The URL of the output stream. This parameter is required only when you transcode a media stream.

    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 override parameter. If you specify this parameter, the corresponding parameter in the template is overwritten.

    Video

    object

    The video settings.

    Codec

    string

    The video codec.

    H.264
    Profile

    string

    The encoding profile. Valid values include baseline, main, and high.

    • baseline: suitable for mobile devices.

    • main: suitable for standard-definition devices.

    • high: suitable for high-definition devices.

    Default value: high.

    Main
    Bitrate

    string

    The average video bitrate.

    • Valid values: 10 to 50000.

    • Unit: Kbit/s.

    3000
    Crf

    string

    The quality-to-bitrate control factor.

    • Valid values: 0 to 51.

    • Default value: If the codec is H.264, the default value is 23. If the codec is H.265, the default value is 26.

    If you specify Crf, the value of Bitrate is ignored.

    23
    Width

    string

    The width.

    • Valid values: 128 to 4096.

    • Unit: px.

    • Default value: the width of the source video.

    1920
    Height

    string

    The height.

    • Valid values: 128 to 4096.

    • Unit: px.

    • Default value: the height of the source video.

    1080
    Fps

    string

    The frame rate.

    • Valid values: 0 to 60.

    • If the frame rate of the input file is greater than 60, the value is 60.

    • Default value: the frame rate of the input file.

    25
    Gop

    string

    The maximum number of frames in a Group of Pictures (GOP).

    • Valid values: 1 to 1080000.

    • Default value: 250.

    250
    Preset

    string

    The preset of the video encoder. This parameter is supported only when the video codec 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. Valid values include yuv420p and yuvj420p.

    yuv420p
    Remove

    string

    Specifies whether to delete the video. Valid values: true and false.

    false
    Crop

    string

    The cropping settings. Two modes are supported.

    • Automatic: Set the value to border to automatically detect and crop black borders.

    • Manual: Specify the crop area in the width:height:left:top format. Example: 1280:800:0:140.

    1280:800:0:140
    Pad

    string

    The settings for adding black bars.

    • Format: width:height:left:top.

    • Example: 1280:800:0:140.

    1280:800:0:140
    LongShortMode

    string

    Specifies whether to enable adaptive resolution by long and short sides.

    false
    Bufsize

    string

    The buffer size.

    • Valid values: 1000 to 128000.

    • Default value: 6000.

    • Unit: Kbit.

    6000
    Maxrate

    string

    The maximum video bitrate. Valid values: 10 to 50000. Unit: Kbit/s.

    9000
    AbrMax

    string

    The maximum bitrate for adaptive bitrate (ABR) streaming. This parameter is valid only for videos with a narrow height and a wide width. Valid values: 10 to 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 encoding preset. This parameter is supported only when the audio codec is AAC. Valid values: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.

    aac_low
    Samplerate

    string

    The sample rate.

    • Valid values: 22050, 32000, 44100, 48000, and 96000.

    • Default value: 44100.

    • Unit: Hz.

    44100
    Bitrate

    string

    The audio bitrate of the output file.

    • Valid values: 8 to 1000.

    • Unit: Kbit/s.

    • Default value: 128.

    128
    Channels

    string

    The number of audio channels. Default value: 2.

    2
    Remove

    string

    Specifies whether to delete the audio stream. Valid values: true and false.

    false
    Volume

    object

    The volume control settings.

    Method

    string

    The volume adjustment method.

    auto
    IntegratedLoudnessTarget

    string

    The target integrated loudness.

    -6
    TruePeak

    string

    The true peak level.

    -1
    LoudnessRangeTarget

    string

    The target loudness range.

    8
    Container

    object

    The container format settings.

    Format

    string

    The container format.

    mp4
    MuxConfig

    object

    The muxing settings.

    Segment

    object

    The segment settings.

    Duration

    string

    The duration of each segment.

    10
    ForceSegTime

    string

    The time points at which to enforce segmentation.

    2,3
    Tags

    object

    The custom tags.

    string

    The key-value pairs of custom tags.

    ImageWatermarks

    array<object>

    The image watermark configurations.

    array<object>

    The image watermark configuration.

    TemplateId

    string

    The template ID.

    9547c6ad97cb4f2aaa29683ebd18****
    OverwriteParams

    object

    The override parameter. If you specify this parameter, the corresponding parameter in the template is overwritten.

    Width

    string

    The width of the watermark.

    32
    Height

    string

    The height of the watermark.

    32
    Dx

    string

    The horizontal offset of the watermark.

    10
    Dy

    string

    The vertical offset of the watermark.

    10
    ReferPos

    string

    The reference position. Valid values: TopLeft, TopRight, BottomLeft, and BottomRight. Default value: TopLeft.

    TopLeft
    Timeline

    object

    The timeline settings.

    Start

    string

    The start time.

    00:00:05
    Duration

    string

    The display duration in seconds. You can also set the value to ToEND.

    ToEND
    File

    object

    The watermark image file.

    Type

    string

    The type of the media asset. Valid values:

    • OSS: an OSS file.

    • Media: a media asset ID.

    OSS
    Media

    string

    The media information. The value of this parameter varies based on the value of Type.

    • If Type is set to OSS, the value of this parameter must be an OSS URL. Both the oss:// and http(s):// protocols are supported.

    • If Type is set to Media, the value of this parameter must be a media ID.

    oss://bucket/path/to/video.mp4
    TextWatermarks

    array<object>

    The text watermark configurations.

    array<object>

    The text watermark configuration.

    TemplateId

    string

    The template ID.

    9547c6ad97cb4f2aaa29683ebd18****
    OverwriteParams

    object

    The override parameter. If you specify this parameter, the corresponding parameter in the template is overwritten.

    Content

    string

    The watermark text, which must be UTF-8 encoded. The text does not need to be Base64 encoded.

    Test watermark
    FontName

    string

    The font.

    SimSun
    FontColor

    string

    The color.

    #006400
    FontAlpha

    string

    The transparency.

    1.0
    Top

    string

    The distance of the watermark from the top edge.

    10
    Left

    string

    The distance from the left edge of the video.

    10
    FontSize

    integer

    The font size.

    16
    BorderWidth

    integer

    The width of the border.

    0
    BorderColor

    string

    The color of the border.

    #006400
    Adaptive

    string

    Specifies whether to adjust the font size based on the output video size.

    • true: The font size is automatically adjusted based on the output video size.

    • false: The font size remains fixed and is not affected by the output video size.

    Default value: false

    false
    Subtitles

    array<object>

    The subtitle burn-in settings.

    array<object>

    The subtitle burn-in configuration.

    TemplateId

    string

    The template ID.

    9547c6ad97cb4f2aaa29683ebd18****
    OverwriteParams

    object

    The overwrite parameters. If specified, these parameters overwrite the corresponding parameters in 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 Object Storage Service (OSS) file.

    • Media: the ID of the Media Asset.

    OSS
    Media

    string

    The media value:

    • If type is OSS, the value is a URL. Both OSS and HTTP protocols are supported.

    • If type is Media, the value is the Media Asset ID.

    oss://bucket/path/to/video.mp4
    Encryption

    object

    The encryption settings.

    EncryptType

    string

    The encryption type.

    PrivateEncryption
    CipherText

    string

    The key ciphertext for standard encryption.

    MTYi00NDU0LTg5O****
    DecryptKeyUri

    string

    The URL of the decryption service for standard encryption.

    https://sample.com/path?CipherText=MTYi00NDU0LTg5O****
    CombineConfigs

    array<object>

    The configurations for combining multiple inputs.

    object

    AudioIndex

    string

    The audio stream index.

    0 or exclude
    VideoIndex

    string

    The index of the video stream.

    0 or exclude
    Start

    number

    The start time of the input stream. The default value is 0.

    0.0
    Duration

    number

    The duration of the input stream. The default is the duration of the video.

    20.0
    IsInheritTags

    boolean

    Specifies whether to inherit tags from the input stream. This parameter applies only when the input is a Media Asset. Default Value: false

    UserData

    string

    Les données utilisateur.

    user-data
    ScheduleConfig

    object

    La configuration de planification de la tâche.

    PipelineId

    string

    The pipeline ID.

    e37ebee5d98b4781897f6086e89f****
    Priority

    integer

    The priority of the job. A larger value indicates a higher priority. The value can be an integer from 1 to 10.

    5
    NextPageToken

    string

    Le jeton pour la page de résultats suivante. Laissez ce paramètre vide pour la première requête. Le jeton est renvoyé après la première requête.

    019daf5780f74831b0e1a767c9f1****

    Exemples

    JSON format

    {
  "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": "Test watermark",
                  "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 or exclude",
                "VideoIndex": "0 or exclude",
                "Start": 0,
                "Duration": 20
              }
            ],
            "IsInheritTags": false
          }
        }
      ],
      "UserData": "user-data",
      "ScheduleConfig": {
        "PipelineId": "e37ebee5d98b4781897f6086e89f****",
        "Priority": 5
      }
    }
  ],
  "NextPageToken": "019daf5780f74831b0e1a767c9f1****"
}

    Codes d'erreur

    Consultez Codes d'erreur pour la liste complète.

    Notes de version

    Consultez Notes de version pour la liste complète.