Cara meminta konfigurasi nama domain yang ditambahkan ke WAF - Web Application Firewall

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

Debugging

OpenAPI Explorer secara otomatis menghitung nilai tanda tangan. Untuk kenyamanan Anda, disarankan untuk memanggil operasi ini melalui OpenAPI Explorer. OpenAPI Explorer juga secara dinamis menghasilkan kode contoh operasi untuk berbagai SDK.

Parameter permintaan

Parameter	Tipe	Diperlukan	Contoh	Deskripsi
Action	String	Ya	DescribeDomain	Operasi yang ingin Anda lakukan. Atur parameter ini menjadi DescribeDomain.
Domain	String	Ya	www.example.com	Nama domain yang ingin Anda minta. Catatan Anda dapat memanggil operasi DescribeDomainNames untuk meminta nama domain yang ditambahkan ke WAF.
InstanceId	String	Ya	waf-cn-7pp26f1****	ID dari instance WAF. Catatan Anda dapat memanggil operasi DescribeInstanceInfo untuk meminta ID dari instance WAF.

Semua permintaan API Alibaba Cloud harus mencakup parameter permintaan umum. Untuk informasi lebih lanjut tentang parameter permintaan umum, lihat Parameter Permintaan Umum.

Untuk detail lebih lanjut tentang contoh permintaan, lihat bagian "Contoh" dalam topik ini.

Parameter respons

Parameter	Tipe	Contoh	Deskripsi
RequestId	String	D827FCFE-90A7-4330-9326-D33C8B4C7726	ID dari permintaan.
Domain	Struct		Konfigurasi nama domain.
AccessHeaderMode	Integer	1	Metode yang digunakan untuk mendapatkan alamat IP sebenarnya dari klien. Nilai valid: 0: WAF membaca nilai pertama dari bidang header X-Forwarded-For (XFF) sebagai alamat IP sebenarnya dari klien. 1: WAF membaca nilai bidang header kustom sebagai alamat IP sebenarnya dari klien. Catatan Parameter ini hanya dikembalikan jika nilai IsAccessProduct adalah 1.
AccessHeaders	List	["X-Client-IP"]	Bidang header kustom yang digunakan untuk mendapatkan alamat IP sebenarnya dari klien. Catatan Parameter ini hanya dikembalikan jika nilai AccessHeaderMode adalah 1.
AccessType	String	waf-cloud-dns	Mode yang digunakan untuk menambahkan nama domain ke WAF. Nilai valid: waf-cloud-dns: Mode rekaman CNAME. waf-cloud-native: Mode proxy transparan.
CloudNativeInstances	Array of CloudNativeInstances		Instance yang ditambahkan ke WAF dalam mode proxy transparan. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-native.
CloudNativeProductName	String	ALB	Tipe instance layanan cloud. Nilai valid: SLB: Instance Classic Load Balancer (CLB), sebelumnya dikenal sebagai Server Load Balancer (SLB) instance. ECS: Instance Elastic Compute Service (ECS). ALB: Instance Application Load Balancer (ALB).
IPAddressList	String	["39.XX.XX.197"]	Alamat IP publik dari instance layanan cloud.
InstanceId	String	alb-s65nua68wdedsp****	ID dari instance layanan cloud.
ProtocolPortConfigs	Array of ProtocolPortConfigs		Konfigurasi protokol dan port.
Ports	String	[80]	Port.
Protocol	String	http	Tipe protokol. Nilai valid: http https
RedirectionTypeName	String	ALB	Tipe port pengalihan trafik. Nilai valid: SLB-L4: Trafik pada port mendengarkan Layer 4 dari instance CLB dialihkan ke WAF. SLB-L7: Trafik pada port mendengarkan Layer 7 dari instance CLB dialihkan ke WAF. ECS: Trafik pada port mendengarkan instance ECS dialihkan ke WAF. ALB: Trafik pada port HTTP dan HTTPS mendengarkan instance ALB dialihkan ke WAF.
ClusterType	Integer	0	Tipe kluster perlindungan WAF. Nilai valid: 0: kluster bersama. 1: kluster eksklusif. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns.
Cname	String	kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com	CNAME yang ditetapkan oleh WAF ke nama domain. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns.
ConnectionTime	Integer	5	Periode timeout untuk koneksi kluster WAF. Unit: detik. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns.
Http2Port	List	[443,8443]	Port HTTP/2. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns dan HttpsPort ditentukan.
HttpPort	List	[80]	Port HTTP. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns.
HttpToUserIp	Integer	0	Menunjukkan apakah pengalihan HTTPS ke HTTP untuk permintaan balik ke asal diaktifkan. Nilai valid: 0: Pengalihan HTTPS ke HTTP untuk permintaan balik ke asal dinonaktifkan. 1: Pengalihan HTTPS ke HTTP untuk permintaan balik ke asal diaktifkan. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns dan HttpsPort ditentukan.
HttpsPort	List	[443,8443]	Port HTTPS. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns.
HttpsRedirect	Integer	0	Menunjukkan apakah pengalihan HTTP ke HTTPS diaktifkan. Nilai valid: 0: Pengalihan HTTP ke HTTPS dinonaktifkan. 1: Pengalihan HTTP ke HTTPS diaktifkan. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns dan HttpsPort ditentukan.
IpFollowStatus	Integer	1	Menunjukkan apakah fitur meneruskan permintaan ke server asal yang menggunakan tipe alamat IP yang ditentukan dalam permintaan diaktifkan. Nilai valid: 0: Fitur meneruskan permintaan ke server asal yang menggunakan tipe alamat IP yang ditentukan dalam permintaan dinonaktifkan. 1: Fitur meneruskan permintaan ke server asal yang menggunakan tipe alamat IP yang ditentukan dalam permintaan diaktifkan. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns.
IsAccessProduct	Integer	1	Menunjukkan apakah proxy Lapisan 7 dikonfigurasi, yang digunakan untuk menyaring trafik masuk sebelum trafik dikirim ke instance WAF. Proxy Lapisan 7 termasuk Anti-DDoS Pro, Anti-DDoS Premium, dan Alibaba Cloud CDN. Nilai valid: 0: Tidak ada proxy Lapisan 7 yang dikonfigurasi. 1: Proxy Lapisan 7 dikonfigurasi.
LoadBalancing	Integer	2	Algoritma penyeimbangan beban yang digunakan untuk meneruskan permintaan ke server asal. Nilai valid: 0: algoritma hash IP. 1: algoritma round-robin. 2: algoritma waktu paling sedikit. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns.
LogHeaders	Array of LogHeader		Pasangan kunci-nilai yang ingin Anda gunakan untuk menandai permintaan yang melewati instance WAF. Catatan Parameter ini hanya dikembalikan jika fitur penandaan trafik diaktifkan untuk nama domain.
k	String	ALIWAF-TAG	Nama bidang header kustom.
v	String	Yes	Nilai dari bidang header kustom.
ReadTime	Integer	120	Periode timeout untuk koneksi baca kluster WAF. Unit: detik. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns.
ResourceGroupId	String	rg-acfm2mkrunv****	ID dari grup sumber daya tempat instance WAF berada.
SniHost	String	waf.example.com	Nilai dari bidang Server Name Indication (SNI) kustom. Jika parameter ini kosong, nilai dari bidang Host dalam header permintaan digunakan sebagai nilai dari bidang SNI. Catatan Parameter ini hanya dikembalikan jika nilai SniStatus adalah 1.
SniStatus	Integer	1	Menunjukkan apakah origin SNI diaktifkan. Origin SNI menunjukkan nama domain yang harus digunakan untuk memulai proses handshake HTTPS ketika WAF meneruskan permintaan ke server asal. Nilai valid: 0: Origin SNI dinonaktifkan. 1: Origin SIN diaktifkan. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns dan HttpsPort ditentukan.
SourceIps	List	["39.XX.XX.197"]	Alamat server asal. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns.
Version	Long	40	Versi konfigurasi nama domain.
WriteTime	Integer	120	Periode timeout untuk koneksi tulis kluster WAF. Unit: detik. Catatan Parameter ini hanya dikembalikan jika nilai AccessType adalah waf-cloud-dns.
Retry	Boolean	true	Menunjukkan apakah WAF mencoba lagi untuk meneruskan permintaan ketika permintaan gagal diteruskan ke server asal. Nilai valid: true (default) false
Keepalive	Boolean	true	Menunjukkan apakah fitur koneksi persisten diaktifkan. Nilai valid: true (default) false
KeepaliveRequests	Integer	1000	Jumlah koneksi persisten yang digunakan kembali. Nilai valid: 60 hingga 1000. Catatan Jumlah koneksi persisten yang digunakan kembali setelah fitur koneksi persisten diaktifkan.
KeepaliveTimeout	Integer	15	Periode timeout dari koneksi persisten yang berada dalam status Idle. Unit: detik. Nilai valid: 1 hingga 60. Nilai default: 15. Catatan Periode waktu selama koneksi persisten yang digunakan kembali dapat tetap dalam status Idle sebelum koneksi persisten dilepaskan.

Contoh

Contoh Permintaan

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

Contoh Respon Sukses

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.