Konfigurasi Penyimpanan Snapshot Langsung ke OSS melalui API - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Deskripsi operasi

You can call this operation to modify a snapshot configuration of a streaming domain. The captured snapshots are stored in OSS. The modification takes effect after you restart stream ingest.

QPS limit

You can call this operation up to 30 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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:UpdateLiveAppSnapshotConfig

update

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DomainName	string	Yes	Domain streaming utama.	example.com
AppName	string	Yes	Nama aplikasi tempat aliran langsung berada.	liveApp****
TimeInterval	integer	No	Interval pengambilan snapshot. Nilai valid: 5 hingga 3600. Unit: detik.	5
OssEndpoint	string	No	Titik akhir Bucket OSS.	cn-oss-****.aliyuncs.com
OssBucket	string	No	Nama Bucket OSS.	liveBucket****
OverwriteOssObject	string	No	Format penamaan snapshot yang disimpan dalam mode timpa, yang berarti snapshot baru menimpa snapshot sebelumnya. Panjang nama harus kurang dari 256 byte. Hanya gambar JPG yang didukung. Nama dapat berisi variabel seperti {AppName} dan {NamaStream}. Nilai tanda hubung (-) menunjukkan bahwa parameter ini dihapus.	{liveApp**}/{liveStream**}.jpg
SequenceOssObject	string	No	Format penamaan snapshot yang disimpan secara berurutan, yang berarti snapshot baru tidak menimpa snapshot sebelumnya. Anda dapat memanggil operasi DescribeLiveStreamSnapshotInfo untuk mengkueri snapshot yang ditangkap dalam periode pengatur waktu tertentu. Panjang nama harus kurang dari 256 byte. Hanya gambar JPG yang didukung. Nama dapat berisi variabel seperti {AppName}, {NamaStream}, {UnixTimestamp}, dan {Sequence}. Nama harus berisi setidaknya salah satu dari variabel {UnixTimestamp} dan {Sequence}. Nilai tanda hubung (-) menunjukkan bahwa parameter ini dihapus.	snapshot/{liveApp**}/{liveStream}/{UnixTimestamp**}.jpg
Callback	string	No	URL callback yang digunakan untuk menerima notifikasi tentang pengambilan snapshot.	https://learn.aliyundoc.com

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Contoh

Respons sukses

JSONformat

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Respons error

JSONformat

{
    "Code":"InternalError",
    "HostId":"live.aliyuncs.com",
    "Message":"The request processing has failed due to some unknown error.",
    "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidOverwriteOssObjectOrSequenceOssObject.Malformed	Specified paramters OverwriteOssObject or SequenceOssObject should have one.
400	InvalidOssEndpoint.Malformed	Specified parameter OssEndpoint is not valid.
400	InvalidOssBucket.Malformed	Specified parameter OssBucket is not valid.
400	InvalidOssBucket.NotFound	The parameter OssBucket does not exist.
400	InvalidOverwriteOssObject.Malformed	Specified parameter OverwriteOssObject is not valid.
400	InvalidSequenceOssObject.Malformed	Specified parameter SequenceOssObject is not valid.
400	InvalidConfig.NotFound	The speicified config does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.