Ambil Konfigurasi Snapshot Langsung untuk Domain Streaming - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Mengkueri konfigurasi snapshot di bawah domain streaming.

Deskripsi operasi

Dapatkan domain streaming terlebih dahulu, lalu panggil operasi ini untuk mengkueri konfigurasi snapshot di bawah domain streaming.

Batas QPS

Batas QPS pengguna tunggal untuk operasi ini adalah 100 panggilan per detik. Jika batas terlampaui, panggilan API akan di-throttle, yang dapat memengaruhi bisnis Anda. Panggil operasi ini sesuai kebutuhan.

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

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DomainName	string	Yes	Domain streaming.	example.com
AppName	string	No	Nama aplikasi tempat live stream berada.	liveApp****
PageNum	integer	No	Nomor halaman. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 5 hingga 30. Nilai default: 10.	10
Order	string	No	Urutan pengurutan. Nilai yang valid: asc (default): urutan naik. desc: urutan turun. Valid values: asc : Urutan naik. desc : Urutan turun.	asc

Elemen respons

Element	Type	Description	Example
	object
PageNum	integer	Nomor halaman.	2
RequestId	string	ID permintaan.	A3136B58-5876-4168-83CA-B562781981A0
Order	string	Urutan pengurutan.	asc
TotalPage	integer	Jumlah total halaman.	10
PageSize	integer	Jumlah entri per halaman.	11
TotalNum	integer	Jumlah total entri yang memenuhi kondisi yang ditentukan.	6
LiveStreamSnapshotConfigList	object
LiveStreamSnapshotConfig	array<object>	Daftar konfigurasi snapshot.
	object
OverwriteOssObject	string	The naming format of snapshots that are stored in the overwrite mode, which means that a new snapshot overwrites the previous snapshot.	{liveApp**}/{liveStream**}.jpg
TimeInterval	integer	The interval at which snapshots are captured. Unit: seconds.	10
AppName	string	The name of the application to which the live stream belongs.	liveApp****
CreateTime	string	The time when the configuration was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2016-05-20T01:33:38Z
OssBucket	string	The name of the Object Storage Service (OSS) bucket.	liveBucket****
DomainName	string	The main streaming domain.	example.com
Callback	string	The callback URL that is used to receive notifications about snapshot capture.	https://learn.aliyundoc.com
SequenceOssObject	string	The naming format of snapshots that are stored in sequence, which means that a new snapshot does not overwrite the previous snapshot.	snapshot/{liveApp**}/{liveStream**}/{UnixTimestamp}.jpg
OssEndpoint	string	The endpoint of the OSS bucket.	cn-oss-****.aliyuncs.com

Contoh

Respons sukses

JSONformat

{
  "PageNum": 2,
  "RequestId": "A3136B58-5876-4168-83CA-B562781981A0",
  "Order": "asc",
  "TotalPage": 10,
  "PageSize": 11,
  "TotalNum": 6,
  "LiveStreamSnapshotConfigList": {
    "LiveStreamSnapshotConfig": [
      {
        "OverwriteOssObject": "{liveApp****}/{liveStream****}.jpg",
        "TimeInterval": 10,
        "AppName": "liveApp****",
        "CreateTime": "2016-05-20T01:33:38Z",
        "OssBucket": "liveBucket****",
        "DomainName": "example.com",
        "Callback": "https://learn.aliyundoc.com",
        "SequenceOssObject": "snapshot/{liveApp****}/{liveStream****}/{UnixTimestamp}.jpg",
        "OssEndpoint": "cn-oss-****.aliyuncs.com"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.