DescribeDomainDetail - Web Application Firewall

Mengambil detail nama domain yang telah ditambahkan ke Web Application Firewall (WAF).

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 Web Application Firewall (WAF). Catatan Panggil DescribeInstance untuk mengkueri ID instans WAF saat ini.	waf_cdnsdf3****
DomainId	string	No	ID Nama domain.	www.aliyundoc.com-waf
Domain	string	No	Nama domain yang ingin Anda kueri.	www.aliyundoc.com
RegionId	string	No	Wilayah tempat instans WAF berada. Nilai yang valid: cn-hangzhou: Tiongkok daratan. ap-southeast-1: luar Tiongkok daratan.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	Detail tentang Rekaman 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: Nama domain dalam status normal. 2: Nama domain sedang dibuat. 3: Nama domain sedang dimodifikasi. 4: Nama domain sedang dilepas. 5: Nama domain berhenti meneruskan traffic.	1
Cname	string	CNAME yang ditetapkan oleh WAF untuk Nama domain.	xxxxxcvdaf.****.com
Listen	object	Konfigurasi listener.
HttpPorts	array	Port listener HTTP.
	integer	Port listener HTTP.	80
HttpsPorts	array	Port listener HTTPS.
	integer	Port listener 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 protokol Transport Layer Security (TLS). Nilai yang valid: tlsv1 tlsv1.1 tlsv1.2	tlsv1.2
EnableTLSv3	boolean	Menunjukkan apakah TLS 1.3 didukung. Nilai yang valid: true: TLS 1.3 didukung. false: TLS 1.3 tidak didukung.	true
CipherSuite	integer	Jenis paket sandi. Nilai yang 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	Menunjukkan apakah Pengalihan HTTP ke HTTPS diaktifkan untuk Nama domain. Nilai yang valid: true: Pengalihan HTTP ke HTTPS diaktifkan untuk Nama domain. false: Pengalihan HTTP ke HTTPS tidak diaktifkan untuk Nama domain.	true
SM2Enabled	boolean	Menunjukkan apakah verifikasi berbasis Sertifikat SM diaktifkan. Nilai yang valid: true: Verifikasi berbasis Sertifikat SM diaktifkan. false: Verifikasi berbasis Sertifikat SM tidak diaktifkan.	true
SM2CertId	string	ID Sertifikat SM yang ingin Anda tambahkan. Parameter ini tersedia hanya jika Anda mengatur SM2Enabled ke true.	123-cn-hangzhou
SM2AccessOnly	boolean	Menunjukkan apakah hanya client berbasis Sertifikat SM yang dapat mengakses Nama domain. Parameter ini tersedia hanya jika Anda mengatur SM2Enabled ke true. true: Hanya client berbasis Sertifikat SM yang dapat mengakses Nama domain. false: Baik client berbasis Sertifikat SM maupun non-SM dapat mengakses Nama domain.	true
XffHeaderMode	integer	Metode yang digunakan WAF untuk memperoleh alamat IP asal client. Nilai yang valid: 0: Traffic client tidak diteruskan oleh proxy lapisan 7 sebelum mencapai WAF. 1: WAF membaca nilai pertama bidang X-Forwarded-For (XFF) dalam header permintaan sebagai alamat IP client. 2: WAF membaca nilai bidang kustom yang Anda tentukan dalam header permintaan sebagai alamat IP client.	2
XffHeaders	array	Bidang header kustom yang digunakan untuk memperoleh alamat IP aktual client.
	string	Bidang header kustom yang digunakan untuk memperoleh alamat IP aktual client.	Client-ip
IPv6Enabled	boolean	Menunjukkan apakah IPv6 diaktifkan. Nilai yang valid: true: IPv6 diaktifkan. false: IPv6 tidak diaktifkan.	true
ProtectionResource	string	Jenis resource perlindungan yang digunakan. Nilai yang valid: share: Kluster bersama. gslb: Load balancing cerdas untuk kluster bersama.	share
ExclusiveIp	boolean	Menunjukkan apakah alamat IP eksklusif diaktifkan untuk Nama domain. Nilai yang valid: true: Alamat IP eksklusif diaktifkan untuk Nama domain. false: Alamat IP eksklusif tidak diaktifkan untuk Nama domain.	true
HstsIncludeSubDomain	boolean	Menunjukkan apakah HSTS mencakup subdomain. Nilai yang valid: true: HSTS mencakup subdomain. false: HSTS tidak mencakup subdomain.
HstsPreload	boolean	Menunjukkan apakah preload HSTS diaktifkan. Nilai default: false. Nilai yang valid: true: Preload HSTS diaktifkan. false: Preload HSTS dinonaktifkan.
HstsMaxAge	integer	Waktu hidup (TTL) untuk HSTS. Satuan: detik.
Redirect	object	Konfigurasi penerusan.
Backends `deprecated`	array<object>	Array alamat server origin. Catatan Parameter ini akan ditinggalkan. Kami menyarankan agar Anda menggunakan BackendList sebagai gantinya.
	object	Alamat IP atau Nama domain server origin.
Backend	string	Alamat IP atau Nama domain server origin.	1.1.XX.XX
Loadbalance	string	Algoritma penyeimbangan beban yang digunakan ketika WAF meneruskan permintaan ke server origin. Nilai yang valid: iphash: Algoritma IP hash. roundRobin: Algoritma round-robin. leastTime: Algoritma waktu paling singkat.	iphash
FocusHttpBackend	boolean	Menentukan apakah permintaan kembali-ke-asal dipaksa menggunakan HTTP. Nilai yang valid: true: Permintaan dipaksa menggunakan HTTP. false: Permintaan tidak dipaksa menggunakan HTTP.	true
SniEnabled	boolean	Menunjukkan apakah Indikasi Nama Server (SNI) origin diaktifkan. Nilai yang valid: true: SNI origin diaktifkan. false (default): SNI origin tidak diaktifkan.	true
SniHost	string	Nilai bidang SNI.	www.aliyundoc.com
RequestHeaders	array<object>	Array pasangan kunci-nilai yang digunakan untuk menandai permintaan yang melewati instans WAF.
	object	Pasangan kunci-nilai yang digunakan untuk menandai permintaan yang melewati WAF.
Key	string	Kunci bidang header kustom.	aaa
Value	string	Nilai bidang header kustom.	bbb
ConnectTimeout	integer	Periode timeout untuk koneksi. Satuan: detik. Nilai yang valid: 5 hingga 120.	120
WriteTimeout	integer	Periode timeout untuk operasi tulis. Satuan: detik. Nilai yang valid: 5 hingga 1.800.	200
ReadTimeout	integer	Periode timeout untuk operasi baca. Satuan: detik. Nilai yang valid: 5 hingga 1.800.	200
Keepalive	boolean	Menunjukkan apakah fitur koneksi persisten diaktifkan. Nilai yang valid: true (default): Fitur koneksi persisten diaktifkan. false: Fitur koneksi persisten tidak diaktifkan.	true
Retry	boolean	Menentukan apakah WAF mencoba ulang jika gagal meneruskan permintaan ke server origin. Nilai yang valid: true (default): WAF mencoba ulang. false: WAF tidak mencoba ulang.	true
KeepaliveRequests	integer	Jumlah permintaan yang menggunakan kembali koneksi persisten. Nilai yang valid: 60 hingga 1.000. Catatan Jumlah koneksi persisten yang digunakan kembali setelah fitur koneksi persisten diaktifkan.	1000
KeepaliveTimeout	integer	Periode timeout untuk koneksi persisten yang menganggur. Nilai yang valid: 1 hingga 60. Nilai default: 15. Satuan: detik. Catatan Periode waktu selama koneksi persisten yang digunakan kembali dapat tetap dalam status Idle sebelum koneksi tersebut dilepas.	15
XffProto	boolean	Menunjukkan apakah X-Forward-For-Proto meneruskan protokol WAF. Nilai yang valid: true (default): X-Forward-For-Proto meneruskan protokol WAF. false: X-Forward-For-Proto tidak meneruskan protokol WAF.	true
BackupBackends `deprecated`	array<object>	Array alamat cadangan server origin. Catatan Parameter ini akan ditinggalkan. Kami menyarankan agar Anda menggunakan BackUpBackendList sebagai gantinya.
	object	Alamat IP atau Nama domain server origin.
Backend	string	Alamat IP cadangan atau Nama domain server origin.	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	Menunjukkan apakah WAF diizinkan menimpa header X-Client-IP. Nilai yang valid: true (default): WAF diizinkan menimpa header. false: WAF tidak diizinkan menimpa header.	true
XTrueIp	boolean	Menunjukkan 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	Menunjukkan 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	Menunjukkan 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. Catatan Fitur ini hanya tersedia untuk Edisi Ultimate.	2
Http2Origin	boolean	Menunjukkan apakah HTTP/2 diaktifkan untuk pengambilan asal.	true
Http2OriginMaxConcurrency	integer	Jumlah koneksi bersamaan untuk pengambilan asal HTTP/2.	128
ProxyProtocol	boolean	Menunjukkan apakah fitur Proxy Protocol diaktifkan. Nilai yang valid: true: Fitur Proxy Protocol diaktifkan. Setelah fitur ini diaktifkan, layanan backend dapat melihat alamat IP asli client. false: Fitur Proxy Protocol dinonaktifkan.
BackendList	array	Daftar alamat IP atau Nama domain server origin untuk Nama domain.
	string	Alamat IP atau Nama domain server origin.	1.1.XX.XX
BackUpBackendList	array	Daftar alamat IP atau Nama domain server origin cadangan untuk Nama domain.
	string	Alamat IP atau Nama domain server origin cadangan.	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 kembali-ke-asal.	80
Protocol	string	Protokol port listener. Nilai yang valid: http: HTTP https: HTTPS	http
ResourceManagerResourceGroupId	string	ID kelompok sumber daya.	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	Awal periode validitas Sertifikat SSL. Tentukan timestamp Unix dalam UTC. Satuan: milidetik.	1677772800000
EndTime	integer	Akhir periode validitas Sertifikat SSL. Tentukan timestamp Unix dalam UTC. Satuan: milidetik.	1685590400000
CommonName	string	Nama umum.	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 tentang Sertifikat SM.
Name	string	Nama Sertifikat.	test-sm2-cert-name
Id	string	ID Sertifikat SSL.	123-cn-hangzhou
StartTime	integer	Awal periode validitas Sertifikat SSL. Tentukan timestamp Unix dalam UTC. Satuan: milidetik.	1657551525000
EndTime	integer	Akhir periode validitas Sertifikat SSL. Tentukan timestamp Unix dalam UTC. Satuan: milidetik.	1665590400000
CommonName	string	Nama umum.	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": 0
  },
  "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
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.