All Products
Search
Document Center

ApsaraVideo Media Processing:UpdateTemplate

Last Updated:Jun 11, 2026

Memperbarui pengaturan template transkoding kustom.

Deskripsi operasi

If any job with the status "Submitted" specifies the use of this custom template, the corresponding transcoding template information cannot be updated.

QPS Limit

The queries per second (QPS) limit for this API is 100 requests per second per user. If the limit is exceeded, API calls will be subject to rate limiting, which may impact your business. Please invoke the API appropriately. For more information, see QPS Limits.

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

mts:UpdateTemplate

update

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

TemplateId

string

Yes

Nama template. Nama dapat memiliki panjang hingga 128 byte.

16f01ad6175e4230ac42bb5182cd****

Name

string

Yes

Format kontainer. Nilai berupa objek JSON. Format default: MP4.

  • Format video: FLV, MP4, HLS (M3U8 + TS), dan MPEG-DASH (MPD + fMP4)

  • Format audio: MP3, MP4, OGG, FLAC, dan M4A

  • Format gambar: GIF dan WebP

Untuk informasi selengkapnya, lihat parameter Container pada topik "Detail parameter".

MPS-example

Container

string

No

Konfigurasi aliran video. Nilai berupa objek JSON. Untuk informasi selengkapnya, lihat parameter Video pada topik "Detail parameter".

{"Format":"mp4"}

Video

string

No

Konfigurasi aliran audio. Nilai berupa objek JSON. Untuk informasi selengkapnya, lihat parameter Audio pada topik "Detail parameter".

{"Codec":"H.264","Profile":"high","Bitrate":"500","Crf":"15","Width":"256","Height":"800","Fps":"25","Gop":"10"}

Audio

string

No

Konfigurasi transmuxing. Nilai berupa objek JSON. Untuk informasi selengkapnya, lihat parameter MuxConfig pada topik "Detail parameter".

{"Codec":"aac","Samplerate":"44100","Bitrate":"500","Channels":"2"}

MuxConfig

string

No

Konfigurasi transkoding umum. Nilai berupa objek JSON. Untuk informasi selengkapnya, lihat parameter TransConfig pada topik "Detail parameter".

{"Segment":{"Duration":"10"}}

TransConfig

string

No

ID permintaan.

{"TransMode":"onepass"}

Elemen respons

Element

Type

Description

Example

object

RequestId

string

The type of the transcoding template.

5E4FB22E-B9EA-4E24-8FFC-B407EA71QW21

Template

object

The type of the transcoding template.

Video

object

The video codec configurations.

LongShortMode

string

The size of the buffer.

  • Unit: KB.

  • Default value: 6000.

false

Bufsize

string

The level of quality control on the video.

6000

Degrain

string

The average bitrate range of the video.

10

BitrateBnd

object

The upper limit of the total bitrate. Unit: Kbit/s.

Max

string

The lower limit of the total bitrate. Unit: Kbit/s.

500

Min

string

The pixel format. Valid values: standard pixel formats such as yuv420p and yuvj420p.

100

PixFmt

string

The black borders added to the video.

  • Format: width:height:left:top.

  • Example: 1280:800:0:140.

yuv420p

Pad

string

The video codec. Default value: H.264.

1280:800:0:140

Codec

string

The height of the output video.

  • Unit: pixel.

  • Default value: the height of the input video.

H.264

Height

string

The level of the independent denoising algorithm.

800

Qscale

string

The method used to crop the video.

  • border: automatically detects and removes borders.

  • Value in the width:height:left:top format: crops the video based on custom settings.**** Example: 1280:800:0:140.

1

Crop

string

The average bitrate of the video. Unit: Kbit/s.

border

Bitrate

string

The maximum bitrate of the video. Unit: Kbit/s.

200

Maxrate

string

The maximum frame rate.

500

MaxFps

string

The encoding profile. Valid values:

  • baseline: applicable to mobile devices.

  • main: applicable to standard-definition devices.

  • high: applicable to high-definition devices.

  • Default value: high.

60

Profile

string

The bitrate quality control factor.

  • Default value if the Codec parameter is set to H.264: 23. Default value if the Codec parameter is set to H.265: 26.

  • If this parameter is returned, the setting of the Bitrate parameter is invalid.

high

Crf

string

Indicates whether the video stream is deleted. Valid values:

  • true: The video stream is deleted.

  • false: The video stream is retained.

  • Default value: false.

15

Remove

string

The maximum number of frames between two keyframes. Default value: 250.

false

Gop

string

The width of the video.

  • Unit: pixel.

  • Default value: the width of the input video.

10

Width

string

The frame rate.

  • A value of 60 is returned if the frame rate of the input video exceeds 60.

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

256

Fps

string

The preset video algorithm. Default value: medium. Valid values:

  • veryfast

  • fast

  • medium

  • slow

  • slower

25

Preset

string

The scan mode. Valid values:

  • interlaced: An interlaced scan is performed.

  • progressive: A progressive scan is performed.

medium

ScanMode

string

The policy of resolution adjustment.

interlaced

ResoPriority

string

The general transcoding configurations.

1

Hdr2sdr

string

Indicates whether the HDR2SDR conversion feature is enabled. If this feature is enabled, high dynamic range (HDR) videos are transcoded to standard dynamic range (SDR) videos.

true

NarrowBand

object

The Narrowband HD settings.

Version

string

The Narrowband HD version. Only 1.0 may be returned.

1.0

Abrmax

number

The upper limit of the dynamic bitrate. If this parameter is set, the average bitrate is in the range of (0, 1000000].

3000

MaxAbrRatio

number

The maximum ratio of the upper limit of dynamic bitrate. If this parameter is set, the value of Abrmax does not exceed x times of the source video bitrate. Valid values: (0,1.0].

1.0

TransConfig

object

Indicates whether the audio bitrate is checked. If the bitrate of the output audio is greater than the bitrate of the input audio, the bitrate of the input audio is retained after transcoding. In this case, the specified audio bitrate does not take effect. This parameter has a lower priority than the IsCheckAudioBitrateFail parameter. Valid values:

  • true: The audio bitrate is checked.

  • false: The audio bitrate is not checked.

  • Default value:

    • If the parameter is left empty and the codec of the output audio is different from that of the input audio, the default value is false.

    • If the parameter is left empty and the codec of the output audio is the same as that of the input audio, the default value is true.

IsCheckAudioBitrate

string

The transcoding mode. Default value: onepass. Valid values:

  • onepass

  • twopass

  • CBR

false

TransMode

string

Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained after transcoding. Valid values:

  • true: The resolution is checked.

  • false: The resolution is not checked.

  • Default value: false.

onepass

IsCheckReso

string

Indicates whether the video bitrate is checked. This parameter has a higher priority than the IsCheckVideoBitrate parameter. Valid values:

  • true: The video bitrate is checked

  • false: The video bitrate is not checked.

  • Default value: false.

false

IsCheckVideoBitrateFail

string

The method of resolution adjustment. Default value: none. Valid values:

  • rescale: The input video is rescaled.

  • crop: The input video is cropped.

  • none: No change is made.

false

AdjDarMethod

string

Indicates whether the video bitrate is checked. If this parameter is set to true and the system detects that the video bitrate of the output file is greater than that of the input file, the video bitrate of the input file is retained after transcoding. Valid values:

  • true: The video bitrate is checked.

  • false: The video bitrate is not checked.

  • Default value: false.

none

IsCheckVideoBitrate

string

Indicates whether the resolution is checked. If this parameter is set to true and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, an error that indicates a transcoding failure is returned. Valid values:

  • true: The resolution is checked.

  • false: The resolution is not checked.

  • Default value: false.

false

IsCheckResoFail

string

Indicates whether the audio bitrate is checked. This parameter has a higher priority than the IsCheckAudioBitrate parameter. Valid values:

  • true: The audio bitrate is checked.

  • false: The audio bitrate is not checked.

  • Default value: false.

false

IsCheckAudioBitrateFail

string

The status of the template. Valid values:

  • Normal: The template is normal.

  • Deleted: The template is deleted.

false

State

string

The transmuxing configurations.

Normal

MuxConfig

object

The transmuxing configurations for WebP.

Webp

object

The loop count.

Loop

string

The transmuxing configurations for GIF.

0

Gif

object

The duration for which the final frame is paused. Unit: milliseconds.

FinalDelay

string

The color dithering algorithm of the palette. Valid values: sierra and bayer.

false

DitherMode

string

The loop count.

bayer

Loop

string

Indicates whether the custom palette is used.

0

IsCustomPalette

string

The segment configurations.

0

Segment

object

The length of the segment. Unit: seconds.

Duration

string

The name of the template.

10

Name

string

The audio codec configurations.

MPS-example

Audio

object

The audio codec settings.

Profile

string

Indicates whether the audio stream is deleted.

  • true: The audio stream is deleted.

  • false: The audio stream is retained.

  • Default value: false.

aac_low

Remove

string

The audio codec format. Default value: aac. Valid values:

  • aac

  • mp3

  • vorbis

  • flac

false

Codec

string

The sampling rate.

  • Unit: Hz.

  • Default value: 44100.

aac

Samplerate

string

The level of the independent denoising algorithm.

44100

Qscale

string

The number of sound channels. Default value: 2.

1

Channels

string

The audio bitrate of the output file.

  • Valid values: 8 to 1000.****

  • Unit: Kbit/s.

  • Default value: 128.

2

Bitrate

string

The ID of the transcoding template.

500

Volume

object

The volume control configurations.

Method

string

The volume adjustment method. Valid values:

  • auto

  • dynamic

  • linear

auto

TruePeak

string

The peak volume.

  • This parameter takes effect only if the value of Method is dynamic.

  • Unit: decibel.

  • Valid values: [-9,0].

  • Default value: -1.

-1

IntegratedLoudnessTarget

string

The expected volume.

  • This parameter takes effect only if the value of Method is dynamic.

  • Unit: decibel.

  • Valid values: [-70,-5].

  • Default value: -6.

-6

Level

string

The increased volume relative to the volume of the input audio.

  • This parameter takes effect only if the value of Method is linear.

  • Unit: decibel.

  • Valid values: less than or equal to 20.

  • Default value: -20.

-20

LoudnessRangeTarget

string

The range of the volume relative to the expected volume.

  • This parameter takes effect only if the value of Method is dynamic.

  • Unit: decibel.

  • Valid values: [1,20].

  • Default value: 8.

8

PeakLevel

string

The volume adjustment coefficient.

This parameter takes effect only if the value of Method is adaptive.

Valid values: [0,1].

Default value: 0.9.

0.9

Id

string

The container configurations.

16f01ad6175e4230ac42bb5182cd****

Container

object

The container format.

Format

string

The container format.

mp4

Contoh

Respons sukses

JSONformat

{
  "RequestId": "5E4FB22E-B9EA-4E24-8FFC-B407EA71QW21",
  "Template": {
    "Video": {
      "LongShortMode": "false",
      "Bufsize": "6000",
      "Degrain": "10",
      "BitrateBnd": {
        "Max": "500",
        "Min": "100"
      },
      "PixFmt": "yuv420p",
      "Pad": "1280:800:0:140",
      "Codec": "H.264",
      "Height": "800",
      "Qscale": "1",
      "Crop": "border",
      "Bitrate": "200",
      "Maxrate": "500",
      "MaxFps": "60",
      "Profile": "high",
      "Crf": "15",
      "Remove": "false",
      "Gop": "10",
      "Width": "256",
      "Fps": "25",
      "Preset": "medium",
      "ScanMode": "interlaced",
      "ResoPriority": "1",
      "Hdr2sdr": "true",
      "NarrowBand": {
        "Version": "1.0",
        "Abrmax": 3000,
        "MaxAbrRatio": 1
      }
    },
    "TransConfig": {
      "IsCheckAudioBitrate": "false",
      "TransMode": "onepass",
      "IsCheckReso": "false",
      "IsCheckVideoBitrateFail": "false",
      "AdjDarMethod": "none",
      "IsCheckVideoBitrate": "false",
      "IsCheckResoFail": "false",
      "IsCheckAudioBitrateFail": "false"
    },
    "State": "Normal",
    "MuxConfig": {
      "Webp": {
        "Loop": "0"
      },
      "Gif": {
        "FinalDelay": "false",
        "DitherMode": "bayer",
        "Loop": "0",
        "IsCustomPalette": "0"
      },
      "Segment": {
        "Duration": "10"
      }
    },
    "Name": "MPS-example",
    "Audio": {
      "Profile": "aac_low",
      "Remove": "false",
      "Codec": "aac",
      "Samplerate": "44100",
      "Qscale": "1",
      "Channels": "2",
      "Bitrate": "500",
      "Volume": {
        "Method": "auto",
        "TruePeak": "-1",
        "IntegratedLoudnessTarget": "-6",
        "Level": "-20",
        "LoudnessRangeTarget": "8",
        "PeakLevel": "0.9"
      }
    },
    "Id": "16f01ad6175e4230ac42bb5182cd****",
    "Container": {
      "Format": "mp4"
    }
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.