All Products
Search

This Product

    ApsaraVideo Live:StartRtcCloudRecording

    Document Center

    ApsaraVideo Live:StartRtcCloudRecording

    Last Updated:Jul 24, 2026

    Memulai tugas perekaman cloud RTC.

    Deskripsi operasi

    Perekaman cloud adalah fitur berbayar. Untuk detail penagihan, lihat Biaya perekaman cloud.

    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

    live:StartRtcCloudRecording

    create

    *Semua sumber daya.

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    AppId

    string

    Yes

    ID aplikasi tempat saluran yang akan direkam berada. Aplikasi harus dimiliki oleh akun utama yang terkait dengan akun pemanggil API saat ini.

    ********-7074-****-9ef5-85c19a4*****
    ChannelId

    string

    Yes

    ID saluran yang akan direkam. Pastikan saluran memiliki pengguna aktif saat Anda memanggil operasi ini. Jika tidak, tugas perekaman gagal dibuat.

    room1024
    SubscribeParams

    object

    Yes

    Parameter langganan.

    SubscribeUserIdList

    array<object>

    Yes

    Daftar entri UserId yang berlangganan. Dalam mode perekaman aliran tunggal, setiap UserId direkam secara terpisah. Dalam mode perekaman pencampuran aliran, audio dan video dari semua UserId dicampur menjadi satu set audio dan video.

    object

    No

    Informasi tentang UserId yang berlangganan.

    UserId

    string

    Yes

    UserId yang dilanggan.

    userA.
    StreamType

    integer

    No

    Tipe media UserId yang dilanggan. Nilai valid:

    Valid values:

    • 0 :

      aliran asli, yang mencakup audio dan video.

    • 1 :

      aliran hanya audio.

    • 2 :

      aliran hanya video.

    0
    SourceType

    integer

    No

    Tipe aliran input video UserId. Parameter ini hanya berlaku jika langganan bukan hanya audio (StreamType != 1). Nilai valid:

    Valid values:

    • 0 :

      kamera.

    • 1 :

      berbagi layar.

    0
    RecordParams

    object

    Yes

    Parameter perekaman.

    RecordMode

    integer

    Yes

    Mode perekaman. Nilai valid:

    Valid values:

    • 0 :

      mode perekaman aliran tunggal, di mana file rekaman terpisah dihasilkan untuk setiap UserId yang berlangganan.

    • 1 :

      mode perekaman pencampuran aliran, di mana aliran dari semua UserId yang berlangganan dicampur dan ditranskode untuk menghasilkan satu set file rekaman.

    0
    StreamType

    integer

    No

    Tipe media aliran rekaman output. Nilai valid:

    Valid values:

    • 0 :

      aliran asli, yang mencakup audio dan video.

    • 1 :

      aliran hanya audio.

    • 2 :

      aliran hanya video.

    0
    MaxFileDuration

    integer

    No

    Durasi maksimum file rekaman, dalam detik. File rekaman yang melebihi durasi ini akan dipisah. Nilainya harus berada dalam rentang [180, 7200], yang berarti maksimum 2 jam. Jika parameter ini tidak ditentukan, nilai defaultnya adalah 7200 (2 jam).

    7200
    StorageParams

    object

    Yes

    Parameter penyimpanan.

    StorageType

    integer

    Yes

    Metode penyimpanan. Nilai valid:

    Valid values:

    • 0 :

      VOD.

    • 1 :

      OSS.

    1
    FileInfo

    array<object>

    No

    Informasi penyimpanan file, yang menentukan format, lokasi penyimpanan, dan penamaan file rekaman. Parameter ini hanya berlaku jika StorageType diatur ke OSS.

    object

    No

    Konfigurasi penyimpanan untuk berbagai format file.

    Format

    string

    Yes

    Format penyimpanan file. Nilai valid:

    Valid values:

    • MP4 :

      format MP4.

    • MP3 :

      format MP3.

    • HLS :

      format HLS.

    HLS.
    FileNamePattern

    string

    No

    Format penamaan file. Anda dapat memilih dan menggabungkan variabel berikut dalam urutan apa pun:

    {AppId}_{ChannelId}_{StartTime}_{UserId}
    SliceNamePattern

    string

    No

    Format penamaan segmen. Parameter ini hanya berlaku dalam format HLS. Mirip dengan FileNamePattern, tetapi dengan variabel tambahan Sequence:

    {AppId}_{ChannelId}_{StartTime}_{Sequence}
    FilePathPrefix

    array

    No

    Jalur penyimpanan file. Setiap elemen dalam array sesuai dengan tingkat direktori. Misalnya, jika nilainya adalah ["dir1","dir2"], file xxx.m3u8 disimpan sebagai dir1/dir2/TaskId/xxx.m3u8. Jika parameter ini kosong, file disimpan sebagai TaskId/xxx.m3u8.

    string

    No

    Nama setiap tingkat direktori.

    dir1
    SliceDuration

    integer

    No

    Panjang segmen dalam detik. Parameter ini hanya berlaku dalam format HLS. Nilainya harus berada dalam rentang [10, 30]. Nilai default: 30.

    30
    OSSParams

    object

    No

    Konfigurasi penyimpanan OSS. Parameter ini diperlukan ketika metode penyimpanan adalah OSS dan tidak berlaku ketika metode penyimpanan adalah VOD.

    OSSEndpoint

    string

    Yes

    Titik akhir penyimpanan OSS. ID wilayah yang sesuai harus konsisten dengan titik akhir pendaftaran layanan yang dipilih.

    oss-cn-shanghai.aliyuncs.com.
    OSSBucket

    string

    Yes

    Nama bucket OSS. Bucket harus dimiliki oleh akun utama yang terkait dengan akun pemanggil API saat ini.

    mytest-bucket.
    VodParams

    object

    No

    Konfigurasi penyimpanan VOD. Parameter ini diperlukan ketika metode penyimpanan adalah VOD dan tidak berlaku ketika metode penyimpanan adalah OSS.

    StorageLocation

    string

    No

    Alamat penyimpanan yang dikonfigurasi di Konsol ApsaraVideo VOD bawah Manajemen Aset Media > Manajemen Penyimpanan. File rekaman pertama-tama disimpan ke lokasi ini lalu diunggah ke VOD.

    mytest.oss-cn-shenzhen.aliyuncs.com.
    VodTranscodeGroupId

    string

    No

    ID grup templat transkoding VOD.

    ****8a914d3989e9825eb90530b2****
    AutoCompose

    integer

    No

    Apakah akan mengaktifkan pencampuran aliran otomatis. Nilai valid:

    Valid values:

    • 0 :

      Menonaktifkan pencampuran aliran otomatis.

    • 1 :

      Mengaktifkan pencampuran aliran otomatis. Saat diaktifkan, parameter ComposeVodTranscodeGroupId harus ditentukan.

    0
    ComposeVodTranscodeGroupId

    string

    No

    ID grup templat transkoding VOD yang digunakan untuk mentranskode video yang dicampur secara otomatis di layanan VOD.

    ****4c34112cfe68248f2f77759c****
    MixTranscodeParams

    object

    No

    Parameter transkoding. Parameter ini tidak diperlukan dalam mode perekaman aliran tunggal dan diperlukan dalam mode perekaman pencampuran aliran.

    FrameFillType

    integer

    No

    Tipe pengisian frame ketika aliran terputus. Nilai valid:

    Valid values:

    • 0 :

      Isi dengan frame terakhir.

    0
    AudioBitrate

    integer

    Yes

    Laju bitrate audio dalam kbps. Nilainya harus berada dalam rentang [8, 500]. Parameter ini diperlukan dalam mode pencampuran aliran.

    300
    AudioChannels

    integer

    Yes

    Jumlah saluran audio. Nilai valid:

    Valid values:

    • 1 :

      mono.

    • 2 :

      stereo.

    2
    AudioSampleRate

    integer

    Yes

    Laju sampel audio dalam Hz. Nilai valid:

    Valid values:

    • 8000 :

      8000HZ

    • 16000 :

      16000HZ

    • 32000 :

      32000HZ

    • 44100 :

      44100HZ

    • 48000 :

      48000HZ

    32000
    VideoCodec

    string

    No

    Format pengkodean video. Nilai valid:

    Valid values:

    • H.264 :

      Pengkodean H.264.

    • H.265 :

      Pengkodean H.265.

    H.264
    VideoBitrate

    integer

    No

    Laju bitrate video dalam kbps. Nilainya harus berada dalam rentang [1, 10000].

    5000
    VideoFramerate

    integer

    No

    Laju frame video dalam fps. Nilainya harus berada dalam rentang [1, 60].

    30
    VideoGop

    integer

    No

    GOP video. I-frame disisipkan setiap VideoGop frame. Nilainya harus berada dalam rentang [1, 60].

    30
    VideoHeight

    integer

    No

    Tinggi video dalam piksel. Nilainya harus berada dalam rentang [0, 1920]. Nilai default: 0.

    480
    VideoWidth

    integer

    No

    Lebar video dalam piksel. Nilainya harus berada dalam rentang [0, 1920]. Nilai default: 0.

    640
    MixLayoutParams

    object

    No

    Parameter tata letak. Parameter ini tidak diperlukan dalam mode perekaman aliran tunggal dan diperlukan dalam mode perekaman pencampuran aliran ketika output bukan hanya audio.

    MixBackground

    object

    No

    Gambar latar belakang global untuk pencampuran aliran.

    RenderMode

    integer

    No

    Mode tampilan untuk output. Nilai valid:

    Valid values:

    • 0 :

      Potong.

    • 1 :

      Skala dan tampilkan dengan batas hitam.

    0
    Url

    string

    No

    URL gambar latar belakang. Panjang maksimum adalah 2048 karakter.

    https://xxxx.com/photos/my-test-picture.png.
    UserPanes

    array<object>

    No

    Menentukan informasi tata letak jendela untuk pengguna yang berlangganan. Hanya pengguna yang UserId-nya telah dikonfigurasi dengan informasi tata letak yang disertakan dalam video. Parameter ini diperlukan dalam mode pencampuran aliran saat merekam file non-hanya-audio.

    array<object>

    No

    Konfigurasi jendela dalam video.

    UserId

    string

    No

    UserId yang sesuai dengan jendela ini.

    userA.
    SourceType

    integer

    No

    Tipe aliran input video untuk UserId ini. Jika UserId tidak ditentukan, pengaturan SourceType ini tidak berpengaruh. Nilai valid:

    Valid values:

    • 0 :

      kamera.

    • 1 :

      berbagi layar.

    0
    Height

    string

    No

    Tinggi panel sebagai persentase ternormalisasi. Nilai harus berada dalam rentang [0,1]. Nilai default: 0.

    0.5
    Width

    string

    No

    Lebar panel sebagai persentase ternormalisasi. Nilai harus berada dalam rentang [0,1]. Nilai default: 0.

    0.5
    X

    string

    No

    Koordinat X sebagai persentase ternormalisasi. Nilai harus berada dalam rentang [0,1]. Nilai default: 0.

    0
    Y

    string

    No

    Koordinat Y sebagai persentase ternormalisasi. Nilai harus berada dalam rentang [0,1]. Nilai default: 0.

    0
    ZOrder

    integer

    No

    Urutan penumpukan. 0 adalah lapisan paling bawah, lapisan 1 berada di atas lapisan 0, dan seterusnya. Nilai default: 0.

    0
    SubBackground

    object

    No

    Gambar latar belakang untuk sub-panel. Ketika pengguna mematikan kamera, belum memublikasikan aliran setelah bergabung, atau meninggalkan saluran di tengah jalan, gambar yang sesuai akan mengisi posisi tata letak.

    RenderMode

    integer

    No

    Mode tampilan untuk output sub-pane. Nilai valid:

    • 0: Crop. (Default)

    • 1: Skala dan tampilkan dengan batas hitam.

    Valid values:

    • 0 :

      potong.

    • 1 :

      Skala dan tampilkan dengan batas hitam.

    0
    Url

    string

    No

    URL gambar latar belakang. Panjang maksimal adalah 2048 karakter.

    https://xxxx.com/photos/my-test-pane-picture.png
    NotifyUrl

    string

    No

    URL untuk menerima Paket callback. Pesan status tugas dikirim ke URL ini dalam format JSON menggunakan metode POST. Panjang maksimum adalah 2048 karakter.

    http://xxxx/test/mycallback.
    NotifyAuthKey

    string

    No

    Kunci otentikasi untuk Paket callback. Biarkan parameter ini kosong untuk melewatkan otentikasi. Jika ditentukan, kunci harus memiliki panjang 16 hingga 64 karakter dan hanya terdiri dari huruf besar, huruf kecil, dan angka.

    mytestkeymytestkey.
    NotifyFileUploadedFormat

    array

    No

    Format yang ditentukan untuk mengirim Paket callback saat event unggah file rekaman (RecordFileUploaded) dipicu.

    string

    No

    Format file spesifik yang menerima callback. Nilai valid (tidak peka huruf besar/kecil):

    MP4
    MaxIdleTime

    integer

    No

    Periode waktu tunggu idle. Ketika tugas tetap idle lebih lama dari MaxIdleTime, tugas akan otomatis berhenti. Unit: detik. Nilai harus berada dalam rentang [10,14400], yaitu maksimum 4 jam. Nilai default: 300.

    600

    • Untuk mode perekaman aliran tunggal:

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Badan respons.

    RequestId

    string

    ID permintaan.

    ******58-5876-****-83CA-B56278******
    TaskId

    string

    ID tugas.

    ******73-8501-****-8ac1-72295a******

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "******58-5876-****-83CA-B56278******",
  "TaskId": "******73-8501-****-8ac1-72295a******"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter.NotifyUrl %s, please check the notifyUrl. Format parameter NotifyUrl tidak valid. Periksa parameter tersebut.
    400 InvalidParameter.StorageParams.FileInfo %s, please check the fileInfo of storageParams. Parameter FileInfo berisi bidang tidak valid. Periksa parameter tersebut.
    400 InvalidParameter.StorageParams.OSSParams %s, please check the ossParams of storageParams. Parameter OSSParams berisi bidang tidak valid. Periksa parameter tersebut.
    400 NotFound.OSSBucket %s, please check the ossBucket of storageParams. OSSBucket yang ditentukan tidak ada.
    400 InvalidParameter.SubscribeParams.SubscribeUserIdList %s, please check the subscribeUserIdList of subscribeParams. Parameter SubscribeUserIdList tidak valid. Periksa parameter tersebut.
    400 InvalidParameter.MixLayoutParams.UserPanes %s, please check the userPanes of mixLayoutParams. Parameter UserPanes berisi bidang tidak valid. Periksa parameter tersebut.
    400 InvalidParameter.MixTranscodeParams %s, please check the transcodeParams. Parameter MixTranscodeParams berisi bidang tidak valid. Periksa parameter tersebut.
    400 MissingParameter %s. Parameter yang diperlukan hilang.
    403 InvalidParameter.UserId %s, please check the UserId. Parameter UserId tidak valid. Periksa parameter tersebut.
    403 QuotaExceed.RunningTask The number of active cloud recording tasks has reached the limit. Jumlah tugas Catatan cloud aktif telah mencapai batas atas.
    404 InvalidParameter.ChannelId %s, please check the channelId.
    404 InvalidParameter.AppId %s, please check the appId. Parameter AppId tidak valid. Periksa nilai parameter.
    405 InvalidParameter.StorageParams.VodParams %s, please check the vodParams of storageParams.
    405 InvalidParameter.NotifyAuthKey %s, please check the notifyAuthKey.
    405 InvalidParameter.MaxIdleTime %s, please check the maxIdleTime.
    405 InvalidParameter.RecordParams %s, please check the recordParams.
    405 InvalidParameter.StorageParams.StorageType %s, please check the storageType of storageParams. Parameter StorageType tidak valid. Periksa nilai parameter.
    405 InvalidParameter.NotifyFileUploadedFormat %s, please check the notifyFileUploadedFormat. Parameter NotifyFileUploadedFormat tidak valid. Periksa nilai parameter.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.