全部产品
Search
文档中心

ApsaraVideo Live:DescribeLiveDomainConfigs

更新时间:Dec 17, 2025

Mengkueri satu atau beberapa konfigurasi nama domain.

Deskripsi operasi

Anda dapat memanggil operasi ini untuk mengkueri beberapa konfigurasi sekaligus.

Batas QPS

Anda dapat memanggil operasi ini hingga 100 kali per detik per akun. Permintaan yang melebihi batas ini akan di-drop dan dapat menyebabkan gangguan layanan. Disarankan untuk memperhatikan batas ini saat memanggil operasi tersebut.

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 None

Parameter permintaan

Parameter

Type

Required

Description

Example

DomainName

string

Yes

Domain ingest atau domain streaming.

demo.aliyundoc.com

FunctionNames

string

Yes

Nama fitur-fitur tersebut. Pisahkan beberapa fitur dengan koma (,). Untuk informasi selengkapnya, lihat bagian Fitur yang ditentukan oleh parameter Functions dalam 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 catatan konfigurasi. Untuk memperbarui salah satu catatan konfigurasi tersebut, gunakan bidang configId untuk menentukan catatan tersebut.

NamaParameter
referer_white_list_set: Daftar putih Referer.refer_domain_allow_list: Referer yang akan ditambahkan ke daftar putih. Pisahkan beberapa Referer dengan koma (,).allow_empty: menentukan apakah Referer kosong diizinkan. Nilai yang valid: on dan off.
referer_black_list_set: Daftar hitam Referer.refer_domain_deny_list: Referer yang akan ditambahkan ke daftar hitam. Pisahkan beberapa Referer dengan koma (,).allow_empty: menentukan apakah Referer kosong diizinkan. Nilai yang valid: on dan off.
filetype_based_ttl_set: periode waktu setelah file kedaluwarsa.ttl: durasi cache. Satuan: detik.file_type: tipe file. Pisahkan beberapa tipe file dengan koma (,).weight: bobot tipe file. Nilai yang valid: 1 hingga 99.
path_based_ttl_set: periode waktu setelah direktori kedaluwarsa.ttl: durasi cache. Satuan: detik.path: direktori, yang harus diawali dengan garis miring (/).weight: bobot direktori. Nilai yang 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: daftar hitam alamat IP.ip_list: alamat IP yang akan ditambahkan ke daftar hitam. Pisahkan beberapa alamat IP dengan koma (,).
ip_allow_list_set: daftar putih alamat IP.ip_list: alamat IP yang akan ditambahkan ke daftar putih. Pisahkan beberapa alamat IP dengan koma (,).
ip_white_list_set: 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.hashkey_args: parameter yang akan dipertahankan. Pisahkan beberapa parameter dengan koma (,).disable: menentukan apakah semua parameter diabaikan. Nilai yang valid: on dan off. Nilai on berarti semua parameter diabaikan. Nilai off berarti tidak ada parameter yang diabaikan.
aliauth: mengonfigurasi autentikasi Alibaba Cloud.auth_type: tipe autentikasi. Nilai yang valid: type_a dan no_auth. Nilai type_a berarti autentikasi tipe A diaktifkan. Nilai no_auth berarti autentikasi dinonaktifkan.auth_key1: kunci autentikasi primer. Kunci autentikasi harus terdiri dari 16 hingga 32 karakter dan dapat berisi huruf besar, huruf kecil, serta angka.auth_key2: kunci autentikasi sekunder.ali_auth_delta: waktu buffer kustom untuk autentikasi. Satuan: detik. Disarankan untuk mengatur nilainya minimal 60 detik.
remote_auth: mengonfigurasi otentikasi jarak jauh untuk live streaming.enable: menentukan apakah otentikasi jarak jauh diaktifkan. Atribut ini wajib diisi. Nilai yang valid: on dan off.remote_auth_path: alamat server otentikasi. Atribut ini wajib diisi.remote_auth_pattern: mode autentikasi. Bidang-bidang berikut tersedia:- param: menentukan apakah parameter dalam URL ingest diteruskan ke server otentikasi. Nilai yang 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 otentikasi ke ApsaraVideo Live jika autentikasi berhasil. Contoh: code=200. Nilai dalam bentuk code=~XXX dikembalikan oleh server otentikasi ke ApsaraVideo Live jika autentikasi gagal. Contoh: code=~403.- delta: durasi timeout untuk autentikasi.- retry: jumlah percobaan ulang jika terjadi timeout autentikasi.- timeout: aksi yang dilakukan jika terjadi timeout autentikasi. Nilai yang valid: pass dan fail. pass: ApsaraVideo Live meneruskan permintaan. fail: ApsaraVideo Live mengembalikan kode status HTTP 403 yang menunjukkan kegagalan.- async: menentukan apakah autentikasi asinkron diaktifkan. Nilai yang 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: menentukan apakah fitur diaktifkan. Nilai yang valid: on dan off. Fitur https_force dan http_force saling eksklusif. Anda tidak dapat mengonfigurasi keduanya secara bersamaan. Jika Anda telah mengonfigurasi salah satu fitur, Anda harus menghapusnya terlebih dahulu sebelum mengonfigurasi fitur lainnya.
http_force: mengonfigurasi pengalihan paksa ke HTTP.enable: menentukan apakah fitur diaktifkan. Nilai yang valid: on dan off. Fitur https_force dan http_force saling eksklusif. Anda tidak dapat mengonfigurasi keduanya secara bersamaan. Jika Anda telah mengonfigurasi salah satu fitur, Anda harus menghapusnya terlebih dahulu sebelum mengonfigurasi fitur lainnya.
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.
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). Anda dapat menentukan URI duplikat. Namun, Anda harus memverifikasi validitasnya.pathType: aturan pencocokan. Nilai yang valid: 0 dan 1. Nilai 0 berarti pencocokan awalan. Nilai 1 berarti pencocokan eksak.interval: interval pemantauan data. Satuan: detik. Interval harus lebih besar dari atau sama dengan 10 detik.count: jumlah kunjungan dari suatu alamat IP.action: aksi yang dilakukan setelah kondisi tertentu terpenuhi. Nilai yang valid: 0 dan 1. Nilai 0 berarti akses diblokir. Nilai 1 berarti Pendeteksian bot dilakukan.ttl: periode waktu selama akses diblokir. Satuan: detik.
forward_scheme: mengonfigurasi back-to-origin adaptif.enable: menentukan apakah fitur diaktifkan. Nilai yang valid: on dan off.scheme_origin: protokol origin. Nilai yang valid: http, https, dan follow.scheme_origin_port: nomor port origin. Nilai yang valid: 80, 443, dan 80:443.
video_seek: mengonfigurasi Pencarian video.enable: menentukan apakah Pencarian video diaktifkan. Nilai yang valid: on dan off.
gzip: mengonfigurasi kompresi Gzip.enable: menentukan apakah kompresi Gzip 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: type User-Agent. Nilai yang valid: black dan white.
host_redirect: mengonfigurasi Penulisan ulang URL.regex: URL yang akan ditulis ulang, contohnya ^/$.replacement: URL akhir, contohnya /go/act/sale/tbzlsy.php.flag: flag. Nilai yang valid: redirect dan break.
ipv6: mengonfigurasi IPv6.switch: menentukan apakah IPv6 diaktifkan. Atribut ini wajib diisi. Nilai yang valid: on dan off. Jika Anda ingin menonaktifkan fitur ini setelah diaktifkan, hapus centang fitur tersebut di Konsol. Jangan hapus konfigurasinya. Jika tidak, fitur tetap aktif.region: wilayah tempat Anda ingin mengaktifkan IPv6. Nilai yang 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-wilayah tersebut.
type: tipe daftar tersebut.Nilai yang valid: black dan white.
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.
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.

F8AA0364-0FDB-4AD5-AC74-D69FAB8924ED

DomainConfigs

object

DomainConfig

array<object>

Konfigurasi nama domain.

array<object>

Status

string

Status konfigurasi. Nilai yang valid:

  • success

  • testing

  • failed

  • configuring

success

ConfigId

string

ID konfigurasi.

5003576

FunctionName

string

Nama fitur.

set_req_host_header

FunctionArgs

object

FunctionArg

array<object>

Atribut fitur.

object

ArgName

string

Nama atribut.

domain_name

ArgValue

string

Nilai atribut.

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.