Web Application Firewall:DescribeDomainDetail - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Mengkueri detail konfigurasi situs web.

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

yundun-waf:DescribeDomainDetail

get

DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}

DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}-waf

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans WAF. Catatan Anda dapat memanggil DescribeInstance untuk mengkueri ID instans WAF.	waf_cdnsdf3****
DomainId	string	No	ID nama domain.	www.aliyundoc.com-waf
Domain	string	No	Nama domain yang akan dikueri.	www.aliyundoc.com
RegionId	string	No	Wilayah tempat instans WAF diterapkan. Nilai valid: cn-hangzhou: Tiongkok Daratan. ap-southeast-1: Luar Tiongkok Daratan.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	Detail Nama Domain CNAME.
RequestId	string	ID permintaan.	BAEF9CA9-66A0-533E-BD09-5D5D7AA8****
Domain	string	Nama domain.	www.aliyundoc.com
DomainId	string	ID nama domain.	www.aliyundoc.com-waf
Status	integer	Status nama domain. Nilai valid: 1: Nama domain dalam status normal. 2: Nama domain sedang dibuat. 3: Nama domain sedang dimodifikasi. 4: Nama domain sedang dilepaskan. 5: Nama domain telah berhenti meneruskan trafik.	1
Cname	string	Nama Domain CNAME yang ditetapkan oleh WAF ke nama domain.	xxxxxcvdaf.****.com
Listen	object	Konfigurasi pendengar.
HttpPorts	array	Port pendengaran untuk protokol HTTP.
	integer	Port pendengaran untuk protokol HTTP.	80
HttpsPorts	array	Port pendengaran untuk protokol HTTPS.
	integer	Port pendengaran untuk protokol HTTPS.	443
Http2Enabled	boolean	Apakah HTTP/2 diaktifkan. Nilai valid: true: HTTP/2 diaktifkan. false: HTTP/2 tidak diaktifkan.	true
CertId	string	ID sertifikat.	123
TLSVersion	string	Versi TLS. Nilai valid: tlsv1 tlsv1.1 tlsv1.2	tlsv1.2
EnableTLSv3	boolean	Apakah TLS 1.3 didukung. Nilai valid: true: TLS 1.3 didukung. false: TLS 1.3 tidak didukung.	true
CipherSuite	integer	Jenis paket sandi. Nilai valid: 1: Semua paket sandi ditambahkan. 2: Paket sandi kuat ditambahkan. 99: Paket sandi kustom ditambahkan.	2
CustomCiphers	array	Paket sandi kustom.
	string	Paket sandi kustom.	xxx
FocusHttps	boolean	Apakah pengalihan paksa HTTPS diaktifkan. Nilai valid: true: Pengalihan paksa HTTPS diaktifkan. false: Pengalihan paksa HTTPS tidak diaktifkan.	true
SM2Enabled	boolean	Apakah sertifikat Jenis Penyimpanan Standar Enkripsi Tiongkok (SM) diaktifkan. Nilai valid: true: Sertifikat SM diaktifkan. false: Sertifikat SM tidak diaktifkan.	true
SM2CertId	string	ID sertifikat SM yang akan ditambahkan. Parameter ini hanya digunakan ketika SM2Enable diatur ke true.	123-cn-hangzhou
SM2AccessOnly	boolean	Apakah hanya klien yang kompatibel dengan SM yang dapat mengakses nama domain. Parameter ini hanya digunakan ketika SM2Enable diatur ke true. true: Hanya klien yang kompatibel dengan SM yang dapat mengakses nama domain. false: Klien yang kompatibel dengan SM dan non-SM dapat mengakses nama domain.	true
XffHeaderMode	integer	Metode yang digunakan WAF untuk memperoleh alamat IP asal klien. Nilai valid: 0: Tidak ada proxy Layer 7 yang diterapkan di depan WAF. 1: WAF membaca nilai pertama dari bidang header X-Forwarded-For (XFF) sebagai alamat IP klien. 2: WAF membaca nilai dari bidang header kustom yang Anda tentukan sebagai alamat IP klien.	2
XffHeaders	array	Daftar bidang header kustom yang digunakan untuk memperoleh alamat IP klien.
	string	Daftar bidang header kustom yang digunakan untuk memperoleh alamat IP klien.	Client-ip
IPv6Enabled	boolean	Apakah IPv6 diaktifkan. Nilai valid: true: IPv6 diaktifkan. false: IPv6 tidak diaktifkan.	true
ProtectionResource	string	Jenis sumber daya perlindungan yang akan digunakan. Nilai valid: share: Kluster bersama. gslb: Kluster bersama dengan penyeimbangan beban cerdas.	share
ExclusiveIp	boolean	Apakah alamat IP eksklusif diaktifkan. Nilai valid: true: Alamat IP eksklusif diaktifkan. false: Alamat IP eksklusif tidak diaktifkan.	true
HstsIncludeSubDomain	boolean	Apakah HSTS mencakup subdomain. Nilai valid: true: Diaktifkan. false: Tidak diaktifkan.
HstsPreload	boolean	Apakah pemuatan awal HSTS diaktifkan. Fitur ini dinonaktifkan secara default. Nilai valid: true: Diaktifkan. false: Dinonaktifkan.	false
HstsMaxAge	integer	Pengatur waktu kedaluwarsa HSTS. Unit: detik.	365000
Redirect	object	Konfigurasi penerusan.
Backends `deprecated`	array<object>	Alamat back-to-origin nama domain. Catatan Parameter ini akan didepresiasi. Gunakan BackendList sebagai gantinya.
	object	Alamat IP atau nama domain server asal.
Backend	string	Alamat IP atau nama domain server asal.	1.1.XX.XX
Loadbalance	string	Algoritma penyeimbangan beban yang digunakan untuk back-to-origin. Nilai valid: iphash: Algoritma hash IP. roundRobin: Algoritma round-robin. leastTime: Algoritma back-to-origin pengatur waktu paling singkat.	iphash
FocusHttpBackend	boolean	Apakah back-to-origin HTTP paksa diaktifkan. Nilai valid: true: Back-to-origin HTTP paksa diaktifkan. false: Back-to-origin HTTP paksa tidak diaktifkan.	true
SniEnabled	boolean	Apakah Sumber SNI back-to-origin diaktifkan. Nilai valid: true: Sumber SNI back-to-origin diaktifkan. false (default): Sumber SNI back-to-origin tidak diaktifkan.	true
SniHost	string	Nilai bidang ekstensi SNI kustom.	www.aliyundoc.com
RequestHeaders	array<object>	Bidang tag lalu lintas dan nilai nama domain, yang digunakan untuk menandai trafik yang diproses oleh WAF.
	object	Bidang tag lalu lintas dan nilai nama domain, yang digunakan untuk menandai trafik yang diproses oleh WAF.
Key	string	Kunci kolom header kustom.	aaa
Value	string	Nilai kolom header kustom.	bbb
ConnectTimeout	integer	Periode pengatur waktu tunggu koneksi. Unit: detik. Nilai valid: 5 hingga 120.	120
WriteTimeout	integer	Periode pengatur waktu tunggu tulis. Unit: detik. Nilai valid: 5 hingga 1800.	200
ReadTimeout	integer	Periode pengatur waktu tunggu baca. Unit: detik. Nilai valid: 5 hingga 1800.	200
Keepalive	boolean	Apakah koneksi persisten diaktifkan. Nilai valid: true (default): Koneksi persisten diaktifkan. false: Koneksi persisten tidak diaktifkan.	true
Retry	boolean	Apakah WAF melakukan percobaan ulang ketika back-to-origin gagal. Nilai valid: true (default): WAF melakukan percobaan ulang. false: WAF tidak melakukan percobaan ulang.	true
KeepaliveRequests	integer	Jumlah permintaan yang dapat menggunakan kembali koneksi persisten. Nilai valid: 60 hingga 1000. Catatan Setelah koneksi persisten diaktifkan, parameter ini menentukan berapa banyak koneksi persisten yang dapat digunakan kembali.	1000
KeepaliveTimeout	integer	Periode pengatur waktu tunggu idle untuk koneksi persisten. Nilai valid: 1 hingga 60. Nilai default: 15. Unit: detik. Catatan Menentukan berapa lama koneksi persisten idle dapat tetap terbuka sebelum dilepaskan.	15
XffProto	boolean	Apakah header X-Forward-For-Proto digunakan untuk meneruskan protokol yang digunakan oleh WAF. Nilai valid: true (default): Protokol yang digunakan oleh WAF diteruskan. false: Protokol yang digunakan oleh WAF tidak diteruskan.	true
BackupBackends `deprecated`	array<object>	Alamat back-to-origin sekunder nama domain. Catatan Parameter ini akan didepresiasi. Gunakan BackUpBackendList sebagai gantinya.
	object	Alamat IP atau nama domain server asal.
Backend	string	Alamat IP atau nama domain cadangan server asal.	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	Apakah WAF diizinkan untuk menimpa header X-Client-IP. Nilai valid: true (default): WAF diizinkan untuk menimpa header. false: WAF tidak diizinkan untuk menimpa header.	true
XTrueIp	boolean	Apakah WAF diizinkan untuk menimpa header X-True-IP. Nilai valid: true (default): WAF diizinkan untuk menimpa header. false: WAF tidak diizinkan untuk menimpa header.	true
WebServerType	boolean	Apakah WAF diizinkan untuk menimpa header Web-Server-Type. Nilai valid: true (default): WAF diizinkan untuk menimpa header. false: WAF tidak diizinkan untuk menimpa header.	true
WLProxyClientIp	boolean	Apakah WAF diizinkan untuk menimpa header WL-Proxy-Client-IP. Nilai valid: true (default): WAF diizinkan untuk menimpa header. false: WAF tidak diizinkan untuk menimpa header.	true
MaxBodySize	integer	Ukuran badan permintaan maksimum. Nilai valid: 2 hingga 10. Nilai default: 2. Unit: GB. Catatan Hanya Edisi Ultimate yang mendukung fitur ini.	2
Http2Origin	boolean	Pengaturan back-to-origin HTTP/2.	true
Http2OriginMaxConcurrency	integer	Jumlah maksimum koneksi bersamaan untuk back-to-origin HTTP/2.	128
ProxyProtocol	boolean	Apakah fitur pelestarian IP sumber klien diaktifkan. true: Fitur pelestarian IP sumber klien diaktifkan. Setelah fitur ini diaktifkan, layanan backend dapat melihat Tampilan alamat IP asal klien. false: Fitur pelestarian IP sumber klien tidak diaktifkan.	false
BackendList	array	Daftar alamat IP server asal atau nama domain back-to-origin untuk nama domain.
	string	Alamat IP atau nama domain server asal untuk nama domain.	1.1.XX.XX
BackUpBackendList	array	Daftar alamat IP server asal sekunder atau nama domain back-to-origin untuk nama domain.
	string	Alamat IP atau nama domain server asal sekunder untuk nama domain.	2.2.XX.XX
BackendPorts	array<object>	Konfigurasi Port kustom. Secara default, ini sama dengan Port pendengaran.
	object	Konfigurasi Port kustom. Secara default, ini sama dengan Port pendengaran.
ListenPort	integer	Port listener.	80
BackendPort	integer	Port kembali-ke-asal.	80
Protocol	string	Protokol port kembali-ke-asal. Nilai yang valid: http: HTTP. https: HTTPS.	http
ResourceManagerResourceGroupId	string	ID kelompok sumber daya Alibaba Cloud.	rg-acfm***q
CertDetail	object	Detail sertifikat SSL.
Name	string	Nama sertifikat.	test-cert-name
Id	string	ID sertifikat SSL.	123-cn-hangzhou
StartTime	integer	Periode efektif sertifikat. Nilainya dalam format stempel waktu UNIX (UTC). Unit: milidetik.	1677772800000
EndTime	integer	Waktu ketika sertifikat kedaluwarsa. Nilainya adalah stempel waktu UNIX dalam UTC. Unit: milidetik.	1685590400000
CommonName	string	Nama umum (CN).	test.aliyundoc.com
Sans	array	Semua nama domain yang terikat pada sertifikat.
	string	Semua nama domain yang terikat pada sertifikat.	www.aliyundoc.com
SM2CertDetail	object	Informasi sertifikat SM dalam format tertentu.
Name	string	Nama sertifikat.	test-sm2-cert-name
Id	string	ID sertifikat SSL.	123-cn-hangzhou
StartTime	integer	Periode efektif sertifikat. Nilainya dalam format stempel waktu UNIX (UTC). Unit: milidetik.	1657551525000
EndTime	integer	Waktu ketika sertifikat kedaluwarsa. Nilainya adalah stempel waktu UNIX dalam UTC. Unit: milidetik.	1665590400000
CommonName	string	Nama umum (CN).	test.aliyundoc.com
Sans	array	Semua nama domain yang terikat pada sertifikat.
	string	Semua nama domain yang terikat pada sertifikat.	www.aliyundoc.com

Contoh

Respons sukses

JSONformat

{
  "RequestId": "BAEF9CA9-66A0-533E-BD09-5D5D7AA8****",
  "Domain": "www.aliyundoc.com",
  "DomainId": "www.aliyundoc.com-waf",
  "Status": 1,
  "Cname": "xxxxxcvdaf.****.com",
  "Listen": {
    "HttpPorts": [
      80
    ],
    "HttpsPorts": [
      443
    ],
    "Http2Enabled": true,
    "CertId": "123",
    "TLSVersion": "tlsv1.2",
    "EnableTLSv3": true,
    "CipherSuite": 2,
    "CustomCiphers": [
      "xxx"
    ],
    "FocusHttps": true,
    "SM2Enabled": true,
    "SM2CertId": "123-cn-hangzhou",
    "SM2AccessOnly": true,
    "XffHeaderMode": 2,
    "XffHeaders": [
      "Client-ip"
    ],
    "IPv6Enabled": true,
    "ProtectionResource": "share",
    "ExclusiveIp": true,
    "HstsIncludeSubDomain": false,
    "HstsPreload": false,
    "HstsMaxAge": 365000
  },
  "Redirect": {
    "Backends": [
      {
        "Backend": "1.1.XX.XX"
      }
    ],
    "Loadbalance": "iphash",
    "FocusHttpBackend": true,
    "SniEnabled": true,
    "SniHost": "www.aliyundoc.com",
    "RequestHeaders": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ],
    "ConnectTimeout": 120,
    "WriteTimeout": 200,
    "ReadTimeout": 200,
    "Keepalive": true,
    "Retry": true,
    "KeepaliveRequests": 1000,
    "KeepaliveTimeout": 15,
    "XffProto": true,
    "BackupBackends": [
      {
        "Backend": "[\n    \"1.1.XX.XX\",\n    \"2.2.XX.XX\"\n]\n"
      }
    ],
    "XClientIp": true,
    "XTrueIp": true,
    "WebServerType": true,
    "WLProxyClientIp": true,
    "MaxBodySize": 2,
    "Http2Origin": true,
    "Http2OriginMaxConcurrency": 128,
    "ProxyProtocol": false,
    "BackendList": [
      "1.1.XX.XX"
    ],
    "BackUpBackendList": [
      "2.2.XX.XX"
    ],
    "BackendPorts": [
      {
        "ListenPort": 80,
        "BackendPort": 80,
        "Protocol": "http"
      }
    ]
  },
  "ResourceManagerResourceGroupId": "rg-acfm***q",
  "CertDetail": {
    "Name": "test-cert-name",
    "Id": "123-cn-hangzhou",
    "StartTime": 1677772800000,
    "EndTime": 1685590400000,
    "CommonName": "test.aliyundoc.com",
    "Sans": [
      "www.aliyundoc.com"
    ]
  },
  "SM2CertDetail": {
    "Name": "test-sm2-cert-name",
    "Id": "123-cn-hangzhou",
    "StartTime": 1657551525000,
    "EndTime": 1665590400000,
    "CommonName": "test.aliyundoc.com\n",
    "Sans": [
      "www.aliyundoc.com\n"
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.	Nama domain dan ID nama domain tidak boleh kosong secara bersamaan.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.	Parameter Domain dan DomainId tidak cocok.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.	Parameter DomainId tidak valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.