BatchSetLiveDomainConfigs - ApsaraVideo Live

Deskripsi operasi

Tentukan nama domain yang ingin dikonfigurasi, lalu panggil operasi ini untuk mengonfigurasi domain tersebut secara batch.

Batas QPS

Anda dapat memanggil operasi ini hingga 30 kali per detik per akun. Permintaan yang melebihi batas ini akan di-drop dan dapat menyebabkan gangguan layanan. Pastikan Anda memperhatikan batas ini saat melakukan pemanggilan.

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

update

*Domain

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DomainNames	string	Yes	Nama domain yang ingin Anda konfigurasikan secara batch. Nama domain yang didukung mencakup ingest domains, main streaming domains, dan sub-streaming domains. Pisahkan beberapa nama domain dengan koma (,).	demo.aliyundoc.com,example.aliyundoc.com,example.com
Functions	string	Yes	Daftar fitur. Beberapa fitur, seperti `filetype_based_ttl_set`, mendukung beberapa catatan konfigurasi. Untuk memperbarui salah satu catatan konfigurasi tersebut, gunakan `configId` untuk mengidentifikasi catatan tersebut. Untuk informasi selengkapnya, lihat Format parameter Functions dan Fitur yang ditentukan oleh parameter Functions.	[{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]

Format parameter Functions

Contoh: [{"functionArgs":[{"argName":"domain_name","argValue":"developer.aliyundoc.com"}],"functionName":"set_req_host_header"}]
Beberapa fitur, seperti filetype_based_ttl_set, mendukung beberapa catatan konfigurasi. Untuk memperbarui salah satu catatan tersebut, gunakan configId untuk mengidentifikasinya. Contoh: [{"functionArgs":[{"argName":"file_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype_based_ttl_set","configId":506***}]

Fitur yang ditentukan oleh parameter Functions

Fitur	Atribut
referer_white_list_set: menentukan Referer whitelist.	refer_domain_allow_list: Referer yang akan ditambahkan ke whitelist. Pisahkan beberapa Referer dengan koma (,).allow_empty: menentukan apakah Referer kosong diizinkan. Nilai yang valid: on dan off.
referer_black_list_set: menentukan Referer blacklist.	refer_domain_deny_list: Referer yang akan ditambahkan ke blacklist. Pisahkan beberapa Referer dengan koma (,).allow_empty: menentukan apakah Referer kosong diizinkan. Nilai yang valid: on dan off.
filetype_based_ttl_set: menentukan periode waktu setelah file kedaluwarsa.	ttl: durasi cache. Satuan: detik. Nilai yang valid: 1 hingga 99999999 (lebih dari tiga tahun).file_type: jenis file. Pisahkan beberapa jenis file dengan koma (,).weight: bobot jenis file. Nilai yang valid: 1 hingga 99.
path_based_ttl_set: menentukan periode waktu setelah direktori kedaluwarsa.	ttl: durasi cache. Satuan: detik. Nilai yang valid: 1 hingga 99999999 (lebih dari tiga tahun).path: direktori, yang harus diawali dengan garis miring (/).weight: bobot direktori. Nilai yang valid: 1 hingga 99.
oss_auth: mengotentikasi akses ke bucket Object Storage Service (OSS).	oss_bucket_id: path bucket OSS Anda.
ip_black_list_set: menentukan blacklist alamat IP.	ip_list: alamat IP yang akan ditambahkan ke blacklist. Pisahkan beberapa alamat IP dengan koma (,).
ip_allow_list_set: menentukan daftar putih alamat IP.	ip_list: alamat IP yang akan ditambahkan ke daftar putih. Pisahkan beberapa alamat IP dengan koma (,).
ip_white_list_set: menentukan daftar putih alamat IP untuk pembatasan laju.	ip_list: alamat IP yang akan ditambahkan ke daftar putih. Pisahkan beberapa alamat IP dengan koma (,).
error_page: mengalihkan halaman error ke halaman tertentu.	error_code: kode kesalahan.rewrite_page: halaman tujuan pengalihan halaman error.
set_req_host_header: memodifikasi header Host pada permintaan back-to-origin.	domain_name: header Host pada permintaan back-to-origin.
set_hashkey_args: mengabaikan parameter URL tertentu.	on berarti semua parameter diabaikan; nilai off berarti tidak ada parameter yang diabaikan.
aliauth: mengonfigurasi autentikasi Alibaba Cloud.	no_auth. Nilai type_a berarti autentikasi tipe A diaktifkan; nilai no_auth berarti autentikasi dinonaktifkan.auth_key1: kunci autentikasi utama. Kunci autentikasi dapat berisi huruf dan angka. Disarankan panjang kunci antara 8 hingga 32 karakter.auth_key2: kunci autentikasi sekunder.ali_auth_delta: buffer time kustom untuk autentikasi. Satuan: detik. Disarankan nilai minimal 60 detik.auth_m3u8: menentukan apakah penulisan ulang M3U8 diaktifkan. Jika diaktifkan, sistem akan melakukan autentikasi untuk segmen TS dalam playlist M3U8 guna mencegah kegagalan akses. Nilai yang valid: on (default) dan off.
remote_auth: mengonfigurasi otentikasi jarak jauh untuk live streaming.	pass (default) dan fail.– args_white: parameter yang ingin diteruskan. Pisahkan beberapa parameter dengan koma (,).– args_black: parameter yang tidak ingin diteruskan. Pisahkan beberapa parameter dengan koma (,).– code: kode status HTTP. Nilai dalam bentuk code=XXX dikembalikan oleh server otentikasi ke ApsaraVideo Live setelah otentikasi berhasil (contoh: code=200). Nilai dalam bentuk code=~XXX dikembalikan setelah otentikasi gagal (contoh: code=~403).– delta: durasi timeout untuk otentikasi.– retry: jumlah percobaan ulang saat timeout otentikasi.– timeout: aksi yang dilakukan saat timeout otentikasi. Nilai yang valid: pass dan fail. pass: ApsaraVideo Live meneruskan permintaan. fail: ApsaraVideo Live mengembalikan kode status HTTP 403.– async: menentukan apakah otentikasi asinkron diaktifkan. Nilai yang valid: on dan off (default).
set_resp_header: mengonfigurasi header respons. Untuk memverifikasi konfigurasi, periksa pesan respons di browser.	Content-Type, Cache-Control, Content-Disposition, Content-Language, Expires, Access-Control-Allow-Origin, Access-Control-Allow-Methods, Access-Control-Allow-Headers, Access-Control-Max-Age, Access-Control-Expose-Headers.value: konten header respons. Untuk menghapus header, masukkan null.
https_force: mengonfigurasi pengalihan paksa ke HTTPS.	off. Fitur https_force dan http_force saling eksklusif. Anda tidak dapat mengonfigurasi keduanya sekaligus. Jika salah satu telah dikonfigurasi, hapus terlebih dahulu sebelum mengonfigurasi yang lain.
http_force: mengonfigurasi pengalihan paksa ke HTTP.	off. Fitur https_force dan http_force saling eksklusif. Anda tidak dapat mengonfigurasi keduanya sekaligus. Jika salah satu telah dikonfigurasi, hapus terlebih dahulu sebelum mengonfigurasi yang lain.
forward_scheme: mengonfigurasi back-to-origin adaptif.	follow.scheme_origin_port: nomor port origin. Nilai yang valid: 80, 443, dan 80:443.
green_manager: mengonfigurasi Deteksi pornografi.	enable: menentukan apakah Deteksi pornografi diaktifkan. Nilai yang valid: on dan off.
tmd_signature: mengonfigurasi aturan pembatasan laju kustom.	name: nama aturan, yang harus unik secara global.path: uniform resource identifier (URI). URI duplikat diperbolehkan, tetapi validitasnya harus diverifikasi.pathType: aturan pencocokan. Nilai yang valid: 0 (pencocokan awalan) dan 1 (pencocokan persis).interval: interval pemantauan data. Satuan: detik. Harus ≥10 detik.count: jumlah kunjungan dari suatu alamat IP.action: aksi yang dilakukan setelah kondisi tertentu terpenuhi. Nilai yang valid: 0 (akses diblokir) dan 1 (Pendeteksian bot dilakukan).ttl: periode waktu selama akses diblokir. Satuan: detik.
l2_oss_key: mengonfigurasi autentikasi kunci privat untuk permintaan back-to-origin dari node L2 ke bucket OSS pribadi.	private_oss_auth: menentukan apakah akses ke bucket OSS pribadi diautentikasi. Nilai yang valid: on dan off.
video_seek: mengonfigurasi Pencarian video.	enable: menentukan apakah fitur diaktifkan. Nilai yang valid: on dan off.
gzip: mengonfigurasi kompresi Gzip.	enable: menentukan apakah fitur diaktifkan. Nilai yang valid: on dan off.
tesla: mengonfigurasi optimasi halaman untuk mempercepat akses.	enable: menentukan apakah fitur diaktifkan. Nilai yang valid: on dan off.
ali_ua: mengonfigurasi kontrol akses berbasis User-Agent.	ua: User-Agent.type: jenis daftar. Nilai yang valid: black dan white.
host_redirect: mengonfigurasi Penulisan ulang URL.	flag: flag. Nilai yang valid: redirect dan break.
ipv6: mengonfigurasi IPv6.	apsoutheast-1 (Singapura), eu-central-1 (Jerman (Frankfurt)), ap-northeast-1 (Jepang (Tokyo)), dan ap-southeast-5 (Indonesia (Jakarta)).
ali_location: mengonfigurasi kontrol akses berbasis wilayah.	location: wilayah-wilayah.type: jenis daftar. Nilai yang valid: black dan white.
cc_defense: mengonfigurasi perlindungan terhadap serangan banjir HTTP.	enable: menentukan apakah perlindungan terhadap serangan banjir HTTP diaktifkan. Nilai yang valid: on dan off.
alilive: mengonfigurasi pengaturan live streaming.	notify_url: URL untuk menerima Notifikasi dari ApsaraVideo Live.enable: menentukan apakah fitur diaktifkan. Nilai yang valid: on dan off.live_forbid_flv: menentukan apakah pemutaran Flash Video (FLV) dilarang. Nilai yang valid: on dan off.live_forbid_rtmp: menentukan apakah pemutaran video Real-Time Messaging Protocol (RTMP) dilarang. Nilai yang valid: on dan off.live_forbid_hls: menentukan apakah pemutaran video HTTP Live Streaming (HLS) dilarang. Nilai yang valid: on dan off.
ali_grtn: menentukan apakah terhubung ke Global Realtime Transport Network (GRTN).	grtn_rts_pub: menentukan apakah pengambilan aliran melalui Real-Time Streaming (RTS) diaktifkan. Atribut ini berlaku untuk ingest domains. Nilai yang valid: on dan off.grtn_rts_play: menentukan apakah streaming melalui RTS diaktifkan. Atribut ini berlaku untuk streaming domains. Nilai yang valid: on dan off.grtn_rts_transcode: menentukan apakah transkoding otomatis untuk pemutaran HTML5 berbasis RTS diaktifkan. Nilai yang valid: on dan off.
edge_function: mengonfigurasi fungsi edge.	Atribut wajib:rule: aturan bahasa domain-spesifik (DSL).pri: prioritas aturan.enable: menentukan apakah aturan diaktifkan. Nilai yang valid: on dan off.Atribut opsional:name: nama aturan.pos: posisi eksekusi aturan.brk: Setelah aturan terkena, aturan setelah posisi yang ditentukan dilewati.option: opsi.grammar: tata bahasa. Nilai yang valid: es2 dan js. Atribut ini juga dapat dibiarkan kosong.jsmode: mode untuk mengelola daftar putih nama domain dalam JavaScript. Nilai yang valid: redirect dan bypass.
https_tls_version: mengonfigurasi versi protokol Transport Layer Security (TLS).	tls10: menentukan apakah TLS 1.0 diaktifkan. Nilai default: on. Nilai yang valid: on dan off.tls11: menentukan apakah TLS 1.1 diaktifkan. Nilai default: on. Nilai yang valid: on dan off.tls12: menentukan apakah TLS 1.2 diaktifkan. Nilai default: on. Nilai yang valid: on dan off.tls13: menentukan apakah TLS 1.3 diaktifkan. Nilai default: on. Nilai yang valid: on dan off.
https_option: mengonfigurasi pengaturan HTTP.	http2: menentukan apakah HTTP/2 diaktifkan. Nilai default: off. Nilai yang valid: on dan off.live_http2: menentukan apakah live_http2 diaktifkan. Nilai default: off. Nilai yang valid: on dan off.

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	04F0F334-1335-436C-A1D7-6C044FE73368

Contoh

Respons sukses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidFunctions.Malformed	Specified Functions is malformed.
400	InvalidFunctionArgs.Malformed	The specified FunctionArgs is invalid.
400	InvalidArgValue.Malformed	Specified ArgValue is malformed.
400	Invalid%s.ValueNotSupported	FunctionName [%s] is not supported.
400	Invalid%s.Malformed	ArgValue [%s] is malformed.
400	MissingParameter%s	The specified value of ArgName[%s] is missing.
400	FunctionMutex	Function is mutex with other function.
400	RewriteHostRely	Domain name is configured as rewrite host by others.
400	ConfigurationConflicts	The staging environment has a configuration in effect and cannot modify the production environment configuration.	The staging environment has a configuration in effect and cannot modify the production environment configuration.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.