All Products
Search
Document Center

Web Application Firewall:DescribeDomain

Last Updated:Apr 01, 2026

Mengkueri konfigurasi nama domain yang ditambahkan ke Web Application Firewall (WAF).

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter permintaan

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeDomainOperasi yang akan dilakukan. Tetapkan nilainya ke DescribeDomain.
DomainStringYeswww.example.comNama domain yang akan dikueri. Untuk mendapatkan daftar nama domain yang telah ditambahkan ke WAF, panggil operasi DescribeDomainNames.
InstanceIdStringYeswaf-cn-7pp26f1****ID instans WAF. Untuk mendapatkan ID instans, panggil operasi DescribeInstanceInfo.

Semua permintaan API Alibaba Cloud harus menyertakan parameter permintaan umum. Untuk informasi selengkapnya, lihat Parameter permintaan umum.

Elemen respons

ParameterTypeExampleDescription
RequestIdStringD827FCFE-90A7-4330-9326-D33C8B4C7726ID permintaan.
DomainStructKonfigurasi nama domain.

Domain

ParameterTypeExampleDescription
AccessHeaderModeInteger1Metode yang digunakan untuk mendapatkan alamat IP client sebenarnya. Nilai yang valid: 0: WAF membaca nilai pertama dari header X-Forwarded-For (XFF). 1: WAF membaca nilai dari bidang header kustom. Hanya dikembalikan ketika IsAccessProduct bernilai 1.
AccessHeadersList["X-Client-IP"]Bidang header kustom yang digunakan untuk mendapatkan alamat IP client sebenarnya. Hanya dikembalikan ketika AccessHeaderMode bernilai 1.
AccessTypeStringwaf-cloud-dnsMode yang digunakan untuk menambahkan nama domain ke WAF. Nilai yang valid: waf-cloud-dns: Mode rekaman CNAME. waf-cloud-native: mode proxy transparan.
ClusterTypeInteger0Jenis kluster proteksi WAF. Nilai yang valid: 0: kluster bersama. 1: kluster eksklusif. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns.
CnameStringkdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.comCNAME yang ditetapkan oleh WAF untuk nama domain. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns.
ConnectionTimeInteger5Periode timeout koneksi untuk kluster WAF. Satuan: detik. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns.
Http2PortList[443,8443]Port HTTP/2. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns dan HttpsPort ditentukan.
HttpPortList[80]Port HTTP. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns.
HttpToUserIpInteger0Menentukan apakah pengalihan HTTPS-ke-HTTP untuk permintaan kembali-ke-asal diaktifkan. Nilai yang valid: 0: dinonaktifkan. 1: diaktifkan. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns dan HttpsPort ditentukan.
HttpsPortList[443,8443]Port HTTPS. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns.
HttpsRedirectInteger0Menentukan apakah pengalihan HTTP-ke-HTTPS diaktifkan. Nilai yang valid: 0: dinonaktifkan. 1: diaktifkan. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns dan HttpsPort ditentukan.
IpFollowStatusInteger1Menentukan apakah WAF meneruskan permintaan ke server origin menggunakan jenis alamat IP yang sama dengan permintaan. Nilai yang valid: 0: dinonaktifkan. 1: diaktifkan. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns.
IsAccessProductInteger1Menentukan apakah proxy Lapisan 7 dikonfigurasi di depan WAF. Proxy Lapisan 7 mencakup Anti-DDoS Pro, Anti-DDoS Premium, dan CDN Alibaba Cloud. Nilai yang valid: 0: tidak ada proxy Lapisan 7 yang dikonfigurasi. 1: proxy Lapisan 7 dikonfigurasi.
KeepaliveBooleantrueMenentukan apakah koneksi persisten diaktifkan. Nilai yang valid: true (default). false.
KeepaliveRequestsInteger1000Jumlah maksimum permintaan per koneksi persisten. Nilai yang valid: 60 hingga 1000.
KeepaliveTimeoutInteger15Periode timeout idle untuk koneksi persisten. Satuan: detik. Nilai yang valid: 1 hingga 60. Nilai default: 15.
LoadBalancingInteger2Algoritma penyeimbangan beban untuk meneruskan permintaan ke server origin. Nilai yang valid: 0: IP hash. 1: round-robin. 2: least time. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns.
ReadTimeInteger120Periode timeout koneksi baca untuk kluster WAF. Satuan: detik. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns.
ResourceGroupIdStringrg-acfm2mkrunv****ID kelompok sumber daya tempat instans WAF berada.
RetryBooleantrueMenentukan apakah WAF mencoba kembali meneruskan permintaan ke server origin setelah kegagalan penerusan. Nilai yang valid: true (default). false.
SniHostStringwaf.example.comNilai kustom untuk bidang Indikasi Nama Server (Server Name Indication/SNI). Jika kosong, nilai header Host yang digunakan. Hanya dikembalikan ketika SniStatus bernilai 1.
SniStatusInteger1Menentukan apakah SNI origin diaktifkan. SNI origin adalah nama domain yang digunakan untuk membuat koneksi HTTPS selama proses jabat tangan TLS ketika WAF meneruskan permintaan ke server origin. Nilai yang valid: 0: dinonaktifkan. 1: diaktifkan. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns dan HttpsPort ditentukan.
SourceIpsList["39.XX.XX.197"]Alamat IP server origin. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns.
VersionLong40Nomor versi konfigurasi nama domain.
WriteTimeInteger120Periode timeout koneksi tulis untuk kluster WAF. Satuan: detik. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns.

CloudNativeInstances (hanya dikembalikan ketika AccessType bernilai waf-cloud-native)

ParameterTypeExampleDescription
CloudNativeProductNameStringALBJenis instans layanan cloud. Nilai yang valid: SLB: Instans Classic Load Balancer (CLB), sebelumnya dikenal sebagai Server Load Balancer (SLB). ECS: Instans Elastic Compute Service (ECS). ALB: Instans Application Load Balancer (ALB).
IPAddressListString["39.XX.XX.197"]Alamat IP publik instans layanan cloud.
InstanceIdStringalb-s65nua68wdedsp****ID instans layanan cloud.

ProtocolPortConfigs (di dalam CloudNativeInstances)

ParameterTypeExampleDescription
PortsString[80]Port.
ProtocolStringhttpProtokol. Nilai yang valid: http. https.
RedirectionTypeNameStringALBJenis port pengalihan lalu lintas. Nilai yang valid: SLB-L4: Port listening Lapisan 4 pada instans CLB. SLB-L7: Port listening Lapisan 7 pada instans CLB. ECS: Port listening pada instans ECS. ALB: Port listening HTTP dan HTTPS pada instans ALB.

LogHeaders (hanya dikembalikan ketika penandaan traffic diaktifkan untuk nama domain)

ParameterTypeExampleDescription
kStringALIWAF-TAGNama bidang header kustom.
vStringYesNilai bidang header kustom.

Contoh

Permintaan contoh

http(s)://[Endpoint]/?Action=DescribeDomain
&Domain=www.example.com
&InstanceId=waf-cn-7pp26f1****
&<Common request parameters>

Respons sukses contoh

XML format

<DescribeDomainResponse>
      <RequestId>D827FCFE-90A7-4330-9326-D33C8B4C7726</RequestId>
      <Domain>
            <HttpToUserIp>0</HttpToUserIp>
            <HttpPort>80</HttpPort>
            <IsAccessProduct>1</IsAccessProduct>
            <AccessHeaderMode>1</AccessHeaderMode>
            <ResourceGroupId>rg-acfm2mkrunv****</ResourceGroupId>
            <AccessHeaders>X-Client-IP</AccessHeaders>
            <ReadTime>120</ReadTime>
            <SourceIps>39.XX.XX.197</SourceIps>
            <IpFollowStatus>1</IpFollowStatus>
            <ClusterType>0</ClusterType>
            <LoadBalancing>2</LoadBalancing>
            <Cname>kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com</Cname>
            <LogHeaders>
                  <v>Yes</v>
                  <k>ALIWAF-TAG</k>
            </LogHeaders>
            <WriteTime>120</WriteTime>
            <Http2Port>443</Http2Port>
            <Http2Port>8443</Http2Port>
            <Version>40</Version>
            <HttpsRedirect>0</HttpsRedirect>
            <ConnectionTime>5</ConnectionTime>
            <AccessType>waf-cloud-dns</AccessType>
            <HttpsPort>443</HttpsPort>
            <HttpsPort>8443</HttpsPort>
            <Keepalive>true</Keepalive>
            <KeepaliveTimeout>15</KeepaliveTimeout>
            <Retry>true</Retry>
            <KeepaliveRequests>1000</KeepaliveRequests>
      </Domain>
</DescribeDomainResponse>

JSON format

{
  "RequestId": "D827FCFE-90A7-4330-9326-D33C8B4C7726",
  "Domain": {
    "HttpToUserIp": 0,
    "HttpPort": [
      80
    ],
    "IsAccessProduct": 1,
    "AccessHeaderMode": 1,
    "ResourceGroupId": "rg-acfm2mkrunv****",
    "AccessHeaders": [
      "X-Client-IP"
    ],
    "ReadTime": 120,
    "SourceIps": [
      "39.XX.XX.197"
    ],
    "IpFollowStatus": 1,
    "ClusterType": 0,
    "LoadBalancing": 2,
    "Cname": "kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com",
    "LogHeaders": [
      {
        "v": "Yes",
        "k": "ALIWAF-TAG"
      }
    ],
    "WriteTime": 120,
    "Http2Port": [
      443,
      8443
    ],
    "Version": 40,
    "HttpsRedirect": 0,
    "ConnectionTime": 5,
    "AccessType": "waf-cloud-dns",
    "HttpsPort": [
      443,
      8443
    ],
    "Keepalive": true,
    "KeepaliveTimeout": 15,
    "SniStatus": 0,
    "Retry": true,
    "KeepaliveRequests": 1000
  }
}

Kode kesalahan

Untuk daftar kode kesalahan, lihat Kode kesalahan layanan.