Gunakan DescribeLiveDomainConfigs - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Deskripsi operasi

You can call this operation to query multiple configurations at a time.

QPS limit

You can call this operation up to 100 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:DescribeLiveDomainConfigs

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DomainName	string	Yes	Domain ingest atau domain streaming.	demo.aliyundoc.com
FunctionNames	string	Yes	Nama fitur. Pisahkan beberapa fitur dengan koma (,). Untuk informasi selengkapnya, lihat bagian Fitur yang ditentukan oleh parameter Functions di topik ini.	set_req_host_header,set_hashkey_args

Fitur yang ditentukan oleh parameter Functions

Catatan Semua nilai parameter bertipe string. Beberapa fitur, seperti filetype_based_ttl_set, mendukung beberapa rekaman konfigurasi. Untuk memperbarui salah satu rekaman konfigurasi, gunakan field configId untuk menentukan rekaman tersebut.

Nama	Parameter
referer_white_list_set: whitelist Referer.	refer_domain_allow_list: Referer yang akan ditambahkan ke whitelist. Pisahkan beberapa Referer dengan koma (,).allow_empty: apakah Referer kosong diizinkan. Nilai valid: on dan off.
referer_black_list_set: blacklist Referer.	refer_domain_deny_list: Referer yang akan ditambahkan ke blacklist. Pisahkan beberapa Referer dengan koma (,).allow_empty: apakah Referer kosong diizinkan. Nilai valid: on dan off.
filetype_based_ttl_set: pengatur waktu setelah file kedaluwarsa.	ttl: durasi cache. Unit: detik.file_type: tipe file. Pisahkan beberapa tipe file dengan koma (,).weight: bobot tipe file. Nilai valid: 1 hingga 99.
path_based_ttl_set: pengatur waktu setelah direktori kedaluwarsa.	ttl: durasi cache. Unit: detik.path: direktori, yang harus diawali dengan garis miring (/).weight: bobot direktori. Nilai valid: 1 hingga 99.
oss_auth: mengautentikasi akses ke bucket Object Storage Service (OSS).	oss_bucket_id: nama bucket OSS Anda.
ip_black_list_set: blacklist alamat IP.	ip_list: alamat IP yang akan ditambahkan ke blacklist. Pisahkan beberapa alamat IP dengan koma (,).
ip_allow_list_set: whitelist alamat IP.	ip_list: alamat IP yang akan ditambahkan ke whitelist. Pisahkan beberapa alamat IP dengan koma (,).
ip_white_list_set: whitelist alamat IP untuk pembatasan kecepatan.	ip_list: alamat IP yang akan ditambahkan ke whitelist. Pisahkan beberapa alamat IP dengan koma (,).
error_page: mengalihkan halaman error ke halaman tertentu.	error_code: kode error.rewrite_page: halaman tujuan pengalihan halaman error.
set_req_host_header: mengubah header Host dari permintaan back-to-origin.	domain_name: header Host dari permintaan back-to-origin.
set_hashkey_args: mengabaikan parameter URL tertentu.	hashkey_args: parameter yang akan disimpan. Pisahkan beberapa parameter dengan koma (,).disable: apakah akan mengabaikan semua parameter. Nilai valid: on dan off. Nilai on menentukan bahwa semua parameter diabaikan. Nilai off menentukan bahwa tidak ada parameter yang diabaikan.
aliauth: mengonfigurasi autentikasi Alibaba Cloud.	auth_type: tipe autentikasi. Nilai valid: type_a dan no_auth. Nilai type_a menentukan bahwa autentikasi tipe A diaktifkan. Nilai no_auth menentukan bahwa autentikasi dinonaktifkan.auth_key1: kunci autentikasi primer. Kunci autentikasi harus memiliki panjang 16 hingga 32 karakter dan dapat berisi huruf besar, huruf kecil, dan angka.auth_key2: kunci autentikasi sekunder.ali_auth_delta: waktu buffer kustom untuk autentikasi. Unit: detik. Kami merekomendasikan Anda mengatur nilai ke setidaknya 60 detik.
remote_auth: mengonfigurasi autentikasi jarak jauh untuk live streaming.	enable: apakah akan mengaktifkan autentikasi jarak jauh. Atribut ini diperlukan. Nilai valid: on dan off.remote_auth_path: alamat server autentikasi. Atribut ini diperlukan.remote_auth_pattern: mode autentikasi. Field berikut tersedia:- param: apakah akan meneruskan parameter di URL ingest ke server autentikasi. Nilai valid: pass (default) dan fail.- args_white: parameter yang ingin Anda teruskan. Pisahkan beberapa parameter dengan koma (,).- args_black: parameter yang tidak ingin Anda teruskan. Pisahkan beberapa parameter dengan koma (,).- code: kode status HTTP. Nilai dalam bentuk code=XXX dikembalikan oleh server autentikasi ke ApsaraVideo Live setelah autentikasi berhasil. Contoh: code=200. Nilai dalam bentuk code=~XXX dikembalikan oleh server autentikasi ke ApsaraVideo Live setelah autentikasi gagal. Contoh: code=~403.- delta: durasi timeout untuk autentikasi.- retry: jumlah percobaan ulang setelah timeout autentikasi.- timeout: tindakan yang dilakukan setelah timeout autentikasi. Nilai valid: pass dan fail. pass: ApsaraVideo Live meneruskan permintaan. fail: ApsaraVideo Live mengembalikan kode status HTTP 403 yang menunjukkan kegagalan.- async: apakah akan mengaktifkan autentikasi asinkron. Nilai valid: on dan off (default).
set_resp_header: mengonfigurasi header respons. Untuk memverifikasi konfigurasi, Anda dapat memeriksa pesan respons di browser.	key: nama header respons.value: konten header respons. Jika Anda ingin menghapus header, masukkan null.
https_force: mengonfigurasi pengalihan paksa ke HTTPS.	enable: apakah akan mengaktifkan fitur. Nilai valid: on dan off. Fitur https_force dan http_force saling eksklusif. Anda tidak dapat mengonfigurasi keduanya. Jika Anda telah mengonfigurasi salah satu fitur, Anda harus menghapusnya sebelum dapat mengonfigurasi fitur lainnya.
http_force: mengonfigurasi pengalihan paksa ke HTTP.	enable: apakah akan mengaktifkan fitur. Nilai valid: on dan off. Fitur https_force dan http_force saling eksklusif. Anda tidak dapat mengonfigurasi keduanya. Jika Anda telah mengonfigurasi salah satu fitur, Anda harus menghapusnya sebelum dapat mengonfigurasi fitur lainnya.
l2_oss_key: mengonfigurasi autentikasi kunci privat untuk permintaan back-to-origin dari node L2 ke bucket OSS privat.	private_oss_auth: apakah akan mengautentikasi akses ke bucket OSS privat. Nilai valid: on dan off.
green_manager: mengonfigurasi deteksi pornografi.	enable: apakah akan mengaktifkan deteksi pornografi. Nilai valid: on dan off.
tmd_signature: mengonfigurasi aturan pembatasan kecepatan kustom.	name: nama aturan, yang harus unik secara global.path: uniform resource identifier (URI). Anda dapat menentukan URI duplikat. Namun, Anda harus memverifikasi validitasnya.pathType: aturan pencocokan. Nilai valid: 0 dan 1. Nilai 0 menentukan pencocokan awalan. Nilai 1 menentukan pencocokan tepat.interval: interval pemantauan data. Unit: detik. Interval harus lebih besar dari atau sama dengan 10 detik.count: jumlah kunjungan dari alamat IP.action: tindakan yang dilakukan setelah kondisi tertentu terpenuhi. Nilai valid: 0 dan 1. Nilai 0 menentukan bahwa akses diblokir. Nilai 1 menentukan bahwa deteksi bot dilakukan.ttl: pengatur waktu selama akses diblokir. Unit: detik.
forward_scheme: mengonfigurasi back-to-origin adaptif.	enable: apakah akan mengaktifkan fitur. Nilai valid: on dan off.scheme_origin: protokol origin. Nilai valid: http, https, dan follow.scheme_origin_port: nomor port origin. Nilai valid: 80, 443, dan 80:443.
video_seek: mengonfigurasi pencarian video.	enable: apakah akan mengaktifkan pencarian video. Nilai valid: on dan off.
gzip: mengonfigurasi kompresi Gzip.	enable: apakah akan mengaktifkan kompresi Gzip. Nilai valid: on dan off.
tesla: mengonfigurasi optimasi halaman untuk mempercepat akses.	enable: apakah akan mengaktifkan fitur. Nilai valid: on dan off.
ali_ua: mengonfigurasi kontrol akses berbasis User-Agent.	ua: tipe User-Agent. Nilai valid: black dan white.
host_redirect: mengonfigurasi penulisan ulang URL.	regex: URL yang akan ditulis ulang, misalnya ^/$.replacement: URL akhir, misalnya /go/act/sale/tbzlsy.php.flag: flag. Nilai valid: redirect dan break.
ipv6: mengonfigurasi IPv6.	switch: apakah akan mengaktifkan IPv6. Atribut ini diperlukan. Nilai valid: on dan off. Jika Anda ingin menonaktifkan fitur ini setelah fitur ini diaktifkan, batalkan pilihan fitur di konsol. Jangan menghapus konfigurasi. Jika tidak, fitur tetap diaktifkan.region: wilayah tempat Anda ingin mengaktifkan IPv6. Nilai valid: cn-beijing (Beijing), cn-shanghai (Shanghai), cn-shenzhen (Shenzhen), cn-qingdao (Qingdao), apsoutheast-1 (Singapura), eu-central-1 (Jerman), ap-northeast-1 (Tokyo), dan ap-southeast-5 (Jakarta).
ali_location: mengonfigurasi kontrol akses berbasis wilayah.	location: wilayah.
type: tipe daftar.	Nilai valid: black dan white.
enable: apakah akan mengaktifkan fitur.	Nilai valid: on dan off.
live_forbid_flv: apakah akan melarang pemutaran Flash Video (FLV).	Nilai valid: on dan off.
live_forbid_rtmp: apakah akan melarang pemutaran video Real-Time Messaging Protocol (RTMP).	Nilai valid: on dan off.
live_forbid_hls: apakah akan melarang pemutaran video HTTP Live Streaming (HLS).	Nilai valid: on dan off.
https_option: mengonfigurasi pengaturan HTTP.	http2: apakah akan mengaktifkan HTTP/2. Nilai default: off. Nilai valid: on dan off.live_http2: apakah akan mengaktifkan live_http2. Nilai default: off. Nilai valid: on dan off.

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED
DomainConfigs	object
DomainConfig	array<object>	The configurations of the domain name.
	array<object>
Status	string	The configuration status. Valid values: success testing failed configuring	success
ConfigId	string	The configuration ID.	5003576
FunctionName	string	The name of the feature.	set_req_host_header
FunctionArgs	object
FunctionArg	array<object>	The attributes of the feature.
	object
ArgName	string	The name of the attribute.	domain_name
ArgValue	string	The attribute value.	developer.aliyundoc.com

Contoh

Respons sukses

JSONformat

{
  "RequestId": "F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED",
  "DomainConfigs": {
    "DomainConfig": [
      {
        "Status": "success",
        "ConfigId": "5003576",
        "FunctionName": "set_req_host_header",
        "FunctionArgs": {
          "FunctionArg": [
            {
              "ArgName": "domain_name",
              "ArgValue": "developer.aliyundoc.com"
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.
404	InvalidUser	The user's account is invalid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.