Mengkueri konfigurasi nama domain yang ditambahkan ke Web Application Firewall (WAF).
Debugging
Parameter permintaan
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | DescribeDomain | Operasi yang akan dilakukan. Tetapkan nilainya ke DescribeDomain. |
| Domain | String | Yes | www.example.com | Nama domain yang akan dikueri. Untuk mendapatkan daftar nama domain yang telah ditambahkan ke WAF, panggil operasi DescribeDomainNames. |
| InstanceId | String | Yes | waf-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
| Parameter | Type | Example | Description |
|---|---|---|---|
| RequestId | String | D827FCFE-90A7-4330-9326-D33C8B4C7726 | ID permintaan. |
| Domain | Struct | Konfigurasi nama domain. |
Domain
| Parameter | Type | Example | Description |
|---|---|---|---|
| AccessHeaderMode | Integer | 1 | Metode 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. |
| AccessHeaders | List | ["X-Client-IP"] | Bidang header kustom yang digunakan untuk mendapatkan alamat IP client sebenarnya. Hanya dikembalikan ketika AccessHeaderMode bernilai 1. |
| AccessType | String | waf-cloud-dns | Mode yang digunakan untuk menambahkan nama domain ke WAF. Nilai yang valid: waf-cloud-dns: Mode rekaman CNAME. waf-cloud-native: mode proxy transparan. |
| ClusterType | Integer | 0 | Jenis kluster proteksi WAF. Nilai yang valid: 0: kluster bersama. 1: kluster eksklusif. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns. |
| Cname | String | kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com | CNAME yang ditetapkan oleh WAF untuk nama domain. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns. |
| ConnectionTime | Integer | 5 | Periode timeout koneksi untuk kluster WAF. Satuan: detik. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns. |
| Http2Port | List | [443,8443] | Port HTTP/2. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns dan HttpsPort ditentukan. |
| HttpPort | List | [80] | Port HTTP. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns. |
| HttpToUserIp | Integer | 0 | Menentukan 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. |
| HttpsPort | List | [443,8443] | Port HTTPS. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns. |
| HttpsRedirect | Integer | 0 | Menentukan apakah pengalihan HTTP-ke-HTTPS diaktifkan. Nilai yang valid: 0: dinonaktifkan. 1: diaktifkan. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns dan HttpsPort ditentukan. |
| IpFollowStatus | Integer | 1 | Menentukan 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. |
| IsAccessProduct | Integer | 1 | Menentukan 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. |
| Keepalive | Boolean | true | Menentukan apakah koneksi persisten diaktifkan. Nilai yang valid: true (default). false. |
| KeepaliveRequests | Integer | 1000 | Jumlah maksimum permintaan per koneksi persisten. Nilai yang valid: 60 hingga 1000. |
| KeepaliveTimeout | Integer | 15 | Periode timeout idle untuk koneksi persisten. Satuan: detik. Nilai yang valid: 1 hingga 60. Nilai default: 15. |
| LoadBalancing | Integer | 2 | Algoritma 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. |
| ReadTime | Integer | 120 | Periode timeout koneksi baca untuk kluster WAF. Satuan: detik. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns. |
| ResourceGroupId | String | rg-acfm2mkrunv**** | ID kelompok sumber daya tempat instans WAF berada. |
| Retry | Boolean | true | Menentukan apakah WAF mencoba kembali meneruskan permintaan ke server origin setelah kegagalan penerusan. Nilai yang valid: true (default). false. |
| SniHost | String | waf.example.com | Nilai kustom untuk bidang Indikasi Nama Server (Server Name Indication/SNI). Jika kosong, nilai header Host yang digunakan. Hanya dikembalikan ketika SniStatus bernilai 1. |
| SniStatus | Integer | 1 | Menentukan 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. |
| SourceIps | List | ["39.XX.XX.197"] | Alamat IP server origin. Hanya dikembalikan ketika AccessType bernilai waf-cloud-dns. |
| Version | Long | 40 | Nomor versi konfigurasi nama domain. |
| WriteTime | Integer | 120 | Periode 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)
| Parameter | Type | Example | Description |
|---|---|---|---|
| CloudNativeProductName | String | ALB | Jenis 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). |
| IPAddressList | String | ["39.XX.XX.197"] | Alamat IP publik instans layanan cloud. |
| InstanceId | String | alb-s65nua68wdedsp**** | ID instans layanan cloud. |
ProtocolPortConfigs (di dalam CloudNativeInstances)
| Parameter | Type | Example | Description |
|---|---|---|---|
| Ports | String | [80] | Port. |
| Protocol | String | http | Protokol. Nilai yang valid: http. https. |
| RedirectionTypeName | String | ALB | Jenis 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)
| Parameter | Type | Example | Description |
|---|---|---|---|
| k | String | ALIWAF-TAG | Nama bidang header kustom. |
| v | String | Yes | Nilai 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.