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

Mengambil 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 menanyakan ID instans WAF saat ini.	waf_cdnsdf3****
DomainId	string	No	ID nama domain.	www.aliyundoc.com-waf
Domain	string	No	Nama domain yang akan ditanyakan.	www.aliyundoc.com
RegionId	string	No	Wilayah tempat instans WAF berada. Nilai yang valid:	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	Detail 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 yang valid:	1
Cname	string	CNAME yang ditetapkan oleh WAF untuk nama domain.	xxxxxcvdaf.****.com
Listen	object	Konfigurasi listener.
HttpPorts	array	Port pendengar untuk protokol HTTP.
	integer	Port pendengar untuk protokol HTTP.	80
HttpsPorts	array	Port pendengar untuk protokol HTTPS.
	integer	Port pendengar untuk protokol HTTPS.	443
Http2Enabled	boolean	Menunjukkan apakah HTTP/2 diaktifkan. Nilai yang valid: true: HTTP/2 diaktifkan. false: HTTP/2 tidak diaktifkan.	true
CertId	string	ID sertifikat.	123
TLSVersion	string	Versi TLS. Nilai yang valid: tlsv1: Mendukung TLS 1.0 dan versi setelahnya. Memberikan kompatibilitas tertinggi dan keamanan terendah. tlsv1.1: Mendukung TLS 1.1 dan versi setelahnya. Memberikan kompatibilitas baik dan keamanan baik. tlsv1.2: Mendukung TLS 1.2 dan versi setelahnya. Memberikan kompatibilitas baik dan keamanan tertinggi. tlsv1.3: Hanya mendukung TLS 1.3. Memberikan keamanan tertinggi dan kompatibilitas terendah.	tlsv1.2
EnableTLSv3	boolean	Menunjukkan apakah TLS 1.3 didukung. Nilai yang valid:	true
CipherSuite	integer	Jenis paket sandi. Nilai yang valid:	2
CustomCiphers	array	Paket sandi kustom.
	string	Paket sandi kustom.	xxx
FocusHttps	boolean	Menunjukkan apakah pengalihan paksa HTTPS diaktifkan. Nilai yang valid:	true
SM2Enabled	boolean	Menunjukkan apakah sertifikat Standar Enkripsi Tiongkok (SM) diaktifkan. Nilai yang valid:	true
SM2CertId	string	ID sertifikat Standar Enkripsi Tiongkok (SM) yang akan ditambahkan. Parameter ini hanya digunakan ketika SM2Enable diatur ke true.	123-cn-hangzhou
SM2AccessOnly	boolean	Menunjukkan apakah hanya akses klien SM yang diizinkan. Parameter ini hanya digunakan ketika SM2Enable diatur ke true.	true
XffHeaderMode	integer	Metode yang digunakan WAF untuk memperoleh alamat IP asal klien. Nilai yang valid: 0: Trafik akses klien tidak diteruskan oleh proxy Lapisan 7 lain sebelum mencapai WAF. 1: WAF membaca nilai pertama dalam bidang header X-Forwarded-For (XFF) permintaan sebagai alamat IP klien. 2: WAF membaca nilai bidang header kustom yang Anda tentukan dalam permintaan sebagai alamat IP klien. 3: WAF membaca Client IP dari header Proxy Protocol sebagai alamat IP klien.	2
XffHeaders	array	Bidang header kustom yang digunakan untuk memperoleh alamat IP klien.
	string	Bidang header kustom yang digunakan untuk memperoleh alamat IP klien.	Client-ip
IPv6Enabled	boolean	Menunjukkan apakah IPv6 diaktifkan. Nilai yang valid: true: IPv6 diaktifkan. false: IPv6 tidak diaktifkan.	true
ProtectionResource	string	Jenis sumber daya proteksi yang digunakan. Nilai yang valid:	share
ExclusiveIp	boolean	Menunjukkan apakah alamat IP eksklusif diaktifkan. Nilai yang valid: true: Alamat IP eksklusif diaktifkan. false: Alamat IP eksklusif tidak diaktifkan.	true
HstsIncludeSubDomain	boolean	Menunjukkan apakah HSTS mencakup subdomain. Nilai yang valid: true: Diaktifkan. false: Tidak diaktifkan.
HstsPreload	boolean	Menunjukkan apakah preloading HSTS diaktifkan. Fitur ini dinonaktifkan secara default. Nilai yang valid:	false
HstsMaxAge	integer	Waktu kedaluwarsa HSTS. Satuan: detik.	365000
Redirect	object	Konfigurasi penerusan.
Backends `deprecated`	array<object>	Alamat back-to-origin nama domain.
	object	Alamat IP atau nama domain server asal.
Backend	string	Alamat IP atau nama domain server asal untuk nama domain.	1.1.XX.XX
Loadbalance	string	Algoritma penyeimbangan beban yang digunakan untuk permintaan back-to-origin. Nilai yang valid: iphash: Algoritma IP Hash. roundRobin: Algoritma round-robin. leastTime: Algoritma Least Time.	iphash
FocusHttpBackend	boolean	Menunjukkan apakah back-to-origin HTTP paksa diaktifkan. Nilai yang valid: true: Back-to-origin HTTP paksa diaktifkan. false: Back-to-origin HTTP paksa tidak diaktifkan.	true
SniEnabled	boolean	Menunjukkan apakah Indikasi Nama Server (SNI) diaktifkan untuk permintaan back-to-origin. Nilai yang valid: true: SNI diaktifkan untuk permintaan back-to-origin. false (default): SNI tidak diaktifkan untuk permintaan back-to-origin.	true
SniHost	string	Nilai bidang ekstensi SNI kustom.	www.aliyundoc.com
RequestHeaders	array<object>	Bidang dan nilai tag lalu lintas nama domain, yang digunakan untuk memberi tag trafik yang diproses oleh WAF.
	object	Bidang dan nilai tag lalu lintas nama domain, yang digunakan untuk memberi tag trafik yang diproses oleh WAF.
Key	string	Bidang header permintaan kustom.	aaa
Value	string	Nilai bidang header permintaan kustom.	bbb
ConnectTimeout	integer	Periode timeout koneksi. Satuan: detik.	120
WriteTimeout	integer	Periode timeout penulisan. Satuan: detik.	200
ReadTimeout	integer	Periode timeout pembacaan. Satuan: detik.	200
Keepalive	boolean	Menentukan apakah koneksi dipertahankan tetap aktif. Nilai yang valid: true (default): Koneksi dipertahankan tetap aktif. false: Koneksi tidak dipertahankan tetap aktif.	true
Retry	boolean	Menentukan apakah akan mencoba ulang ketika WAF gagal meneruskan permintaan ke server asal. Nilai yang valid: true (default): Coba ulang. false: Jangan coba ulang.	true
KeepaliveRequests	integer	Jumlah permintaan yang menggunakan kembali koneksi persisten. Nilai yang valid: 60 hingga 1000.	1000
KeepaliveTimeout	integer	Periode timeout idle untuk koneksi persisten. Nilai yang valid: 1 hingga 60. Nilai default: 15. Satuan: detik.	15
XffProto	boolean	Menunjukkan apakah X-Forward-For-Proto digunakan untuk meneruskan protokol yang digunakan oleh WAF. Nilai yang valid:	true
BackupBackends `deprecated`	array<object>	Alamat origin sekunder nama domain. Catatan Parameter ini akan segera ditinggalkan. Gunakan BackUpBackendList untuk memperoleh informasi terkait.
	object	Alamat IP atau nama domain server asal.
Backend	string	Alamat IP atau nama domain server asal sekunder untuk nama domain.	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	Menentukan apakah WAF diizinkan menimpa X-Client-IP. Nilai yang valid: true (default): WAF diizinkan menimpa header. false: WAF tidak diizinkan menimpa header.	true
XTrueIp	boolean	Menentukan apakah WAF diizinkan menimpa header X-True-IP. Nilai yang valid: true (default): WAF diizinkan menimpa header. false: WAF tidak diizinkan menimpa header.	true
WebServerType	boolean	Menentukan apakah WAF diizinkan menimpa header Web-Server-Type. Nilai yang valid: true (default): WAF diizinkan menimpa header. false: WAF tidak diizinkan menimpa header.	true
WLProxyClientIp	boolean	Menentukan apakah WAF diizinkan menimpa header WL-Proxy-Client-IP. Nilai yang valid: true (default): WAF diizinkan menimpa header. false: WAF tidak diizinkan menimpa header.	true
MaxBodySize	integer	Ukuran maksimum badan permintaan. Nilai yang valid: 2 hingga 10. Nilai default: 2. Satuan: GB.	2
Http2Origin	boolean	Menunjukkan apakah back-to-origin HTTP/2 diaktifkan.	true
Http2OriginMaxConcurrency	integer	Jumlah maksimum koneksi bersamaan untuk back-to-origin HTTP/2.	128
ProxyProtocol	boolean	Menunjukkan apakah fitur pelestarian alamat IP sumber klien diaktifkan. true: Fitur pelestarian alamat IP sumber klien diaktifkan. Setelah fitur ini diaktifkan, layanan backend dapat melihat alamat IP asal klien. false: Fitur pelestarian alamat 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 cadangan atau nama domain back-to-origin untuk nama domain.
	string	Alamat IP server asal cadangan atau nama domain back-to-origin untuk nama domain.	2.2.XX.XX
BackendPorts	array<object>	Konfigurasi port kustom. Secara default, port sama dengan port listener.
	object	Konfigurasi port kustom. Secara default, port sama dengan port listener.
ListenPort	integer	Port listener.	80
BackendPort	integer	Port back-to-origin.	80
Protocol	string	Jenis protokol port listener. Nilai yang valid:	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 berlaku sertifikat. Nilainya dalam format stempel waktu UNIX (UTC). Satuan: milidetik.	1677772800000
EndTime	integer	Waktu kedaluwarsa sertifikat. Nilainya adalah stempel waktu UNIX (UTC). Satuan: 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 SM2.
Name	string	Nama sertifikat.	test-sm2-cert-name
Id	string	ID sertifikat SSL.	123-cn-hangzhou
StartTime	integer	Periode berlaku sertifikat. Nilainya dalam format stempel waktu UNIX (UTC). Satuan: milidetik.	1657551525000
EndTime	integer	Waktu kedaluwarsa sertifikat. Nilainya adalah stempel waktu UNIX (UTC). Satuan: 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",
    "Sans": [
      "www.aliyundoc.com"
    ]
  }
}

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 tidak cocok dengan parameter DomainId.
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.