Gunakan CreateDomain untuk menambahkan domain - Web Application Firewall

Menambahkan nama domain ke instance Web Application Firewall (WAF) untuk perlindungan.

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:CreateDomain

create

*DefenseResource

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans WAF. Catatan Panggil operasi DescribeInstance untuk menanyakan ID instans WAF.	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	No	ID kelompok sumber daya Alibaba Cloud.	rg-acfm***q
Domain	string	Yes	Nama domain yang ingin Anda tambahkan.	www.aliyundoc.com
Listen	object	Yes	Konfigurasi pendengar (listening).
HttpsPorts	array	No	Port pendengar untuk HTTPS.
	integer	No	Nomor port pendengar HTTPS.	[443,8443]
HttpPorts	array	No	Port pendengar untuk HTTP.
	integer	No	Nomor port pendengar HTTP.	[80,81]
Http2Enabled	boolean	No	Menunjukkan apakah HTTP/2 diaktifkan. Parameter ini tersedia hanya jika Anda menentukan HttpsPorts (menandakan bahwa nama domain menggunakan HTTPS). Nilai yang valid: true: HTTP/2 diaktifkan. false (default): HTTP/2 dinonaktifkan.	true
CertId	string	No	ID sertifikat. Parameter ini tersedia hanya jika Anda menentukan HttpsPorts (menandakan bahwa nama domain menggunakan HTTPS).	123
SM2Enabled	boolean	No	Menunjukkan apakah enkripsi berbasis sertifikat SM diaktifkan.	true
SM2CertId	string	No	ID sertifikat SM. Parameter ini tersedia hanya jika Anda mengatur SM2Enabled ke true.	123-cn-hangzhou
SM2AccessOnly	boolean	No	Menunjukkan apakah akses dibatasi hanya untuk klien berbasis sertifikat SM. Parameter ini tersedia hanya jika Anda mengatur SM2Enabled ke true. Nilai yang valid: true: Hanya klien berbasis sertifikat SM yang dapat mengakses domain. false: Baik klien berbasis sertifikat SM maupun non-SM dapat mengakses domain.	true
TLSVersion	string	No	Versi Transport Layer Security (TLS) minimum. Parameter ini tersedia hanya jika Anda menentukan HttpsPorts (menandakan bahwa nama domain menggunakan HTTPS). Nilai yang valid: tlsv1 tlsv1.1 tlsv1.2	tlsv1
EnableTLSv3	boolean	No	Menunjukkan apakah TLS 1.3 didukung. Parameter ini tersedia hanya jika Anda menentukan HttpsPorts (menandakan bahwa nama domain menggunakan HTTPS). Nilai yang valid: true: TLS 1.3 didukung. false: TLS 1.3 tidak didukung.	true
CipherSuite	integer	No	Jenis paket sandi. Parameter ini tersedia hanya jika Anda menentukan HttpsPorts (menandakan bahwa nama domain menggunakan HTTPS). Nilai yang valid: 1: Semua paket sandi. 2: Paket sandi kuat. Nilai ini tersedia hanya jika Anda mengatur TLSVersion ke tlsv1.2. 99: Paket sandi kustom.	2
CustomCiphers	array	No	Paket sandi kustom.
	string	No	Paket sandi kustom. Parameter ini tersedia hanya jika Anda mengatur CipherSuite ke 99.	["xxx","ffas"]
FocusHttps	boolean	No	Menunjukkan apakah pengalihan paksa dari HTTP ke HTTPS diaktifkan untuk permintaan yang diterima. Parameter ini tersedia hanya jika Anda menentukan HttpsPorts dan membiarkan HttpPorts kosong. Nilai yang valid: true: Pengalihan paksa dari HTTP ke HTTPS diaktifkan. false: Pengalihan paksa dari HTTP ke HTTPS dinonaktifkan.	true
XffHeaderMode	integer	No	Metode yang digunakan WAF untuk mendapatkan alamat IP asal klien. Nilai yang valid: 0 (default): Trafik klien tidak melewati proxy Lapisan 7 lain sebelum mencapai WAF. 1: WAF menggunakan nilai pertama dalam header X-Forwarded-For (XFF) sebagai alamat IP klien. 2: WAF menggunakan nilai bidang header kustom yang Anda tentukan sebagai alamat IP klien.	1
XffHeaders	array	No	Bidang header kustom yang digunakan untuk mendapatkan alamat IP asal klien.
	string	No	Bidang header kustom yang digunakan untuk mendapatkan alamat IP asal klien. Catatan Parameter ini wajib hanya jika Anda mengatur XffHeaderMode ke 2 (menandakan bahwa WAF menggunakan nilai bidang header kustom yang Anda tentukan sebagai alamat IP klien).	["Client-ip","cip"]
IPv6Enabled	boolean	No	Menunjukkan apakah IPv6 diaktifkan. Nilai yang valid: true: IPv6 diaktifkan. false (default): IPv6 dinonaktifkan.	true
ProtectionResource	string	No	Jenis sumber daya perlindungan. Nilai yang valid: share (default): Kluster bersama. gslb: Penyeimbangan beban cerdas untuk kluster bersama.	share
ExclusiveIp	boolean	No	Menunjukkan apakah fitur alamat IP eksklusif diaktifkan. Parameter ini tersedia hanya jika Anda mengatur IPv6Enabled ke false (menandakan bahwa IPv6 dinonaktifkan) dan ProtectionResource ke share (menandakan bahwa kluster bersama digunakan). Nilai yang valid: true: Fitur alamat IP eksklusif diaktifkan. false (default): Fitur alamat IP eksklusif dinonaktifkan.	true
HstsIncludeSubDomain	boolean	No	Menunjukkan apakah HSTS mencakup subdomain. Nilai yang valid: true: HSTS mencakup subdomain. false: HSTS tidak mencakup subdomain.
HstsPreload	boolean	No	Menunjukkan apakah preloading HSTS diaktifkan. Nilai yang valid: true: Preloading HSTS diaktifkan. false: Preloading HSTS dinonaktifkan.	false
HstsMaxAge	integer	No	Waktu hidup (TTL) untuk HSTS. Satuan: detik.	365000
Redirect	object	Yes	Konfigurasi pengalihan.
Backends	array	No	Alamat IP atau nama domain server origin.
	string	No	Alamat IP atau nama domain server origin. Anda hanya dapat menggunakan salah satu jenis alamat. Jika Anda menggunakan jenis nama domain, nama domain tersebut hanya dapat di-resolve ke alamat IPv4: Untuk menentukan alamat IP, gunakan format ["ip1","ip2",……]. Anda dapat menentukan hingga 20 alamat IP. Untuk menentukan nama domain, gunakan format ["domain"]. Anda dapat memasukkan hingga 20 nama domain.	[ "1.1.XX.XX", "2.2.XX.XX" ]
Loadbalance	string	Yes	Algoritma penyeimbangan beban yang ingin Anda gunakan saat WAF meneruskan permintaan ke server origin. Nilai yang valid: iphash: Algoritma IP hash. roundRobin: Algoritma round-robin. leastTime: Algoritma Least Time. Nilai ini tersedia hanya jika Anda mengatur ProtectionResource ke gslb (menandakan bahwa penyeimbangan beban cerdas untuk kluster bersama digunakan).	roundRobin
FocusHttpBackend	boolean	No	Menunjukkan apakah pengalihan paksa dari HTTPS ke HTTP diaktifkan untuk permintaan kembali-ke-asal. Parameter ini tersedia hanya jika Anda menentukan HttpsPorts (menandakan bahwa nama domain menggunakan HTTPS). Nilai yang valid: true: Pengalihan paksa dari HTTPS ke HTTP diaktifkan untuk permintaan kembali-ke-asal. false: Pengalihan paksa dari HTTPS ke HTTP dinonaktifkan untuk permintaan kembali-ke-asal.	true
SniEnabled	boolean	No	Menunjukkan apakah fitur Indikasi Nama Server (SNI) diaktifkan untuk permintaan kembali-ke-asal. Parameter ini tersedia hanya jika Anda menentukan HttpsPorts (menandakan bahwa nama domain menggunakan HTTPS). Nilai yang valid: true: Fitur SNI diaktifkan untuk permintaan kembali-ke-asal. false (default): Fitur SNI dinonaktifkan untuk permintaan kembali-ke-asal.	true
SniHost	string	No	Nilai kustom untuk field SNI. Jika Anda tidak menentukan parameter ini, nilai header Host dalam permintaan akan digunakan sebagai nilai field SNI. Parameter ini opsional. Jika Anda ingin WAF menggunakan nilai field SNI yang berbeda dari nilai field Host dalam permintaan kembali-ke-asal, Anda dapat menentukan nilai kustom untuk field SNI. Catatan Parameter ini wajib hanya jika Anda mengatur SniEnabled ke true (menandakan bahwa fitur SNI diaktifkan untuk permintaan kembali-ke-asal).	www.aliyundoc.com
RequestHeaders	array<object>	No	Pasangan kunci-nilai yang ingin Anda gunakan untuk memberi label permintaan yang melewati instans WAF. Saat permintaan melewati WAF, WAF secara otomatis menambahkan field header kustom ke permintaan untuk menandai permintaan tersebut. Dengan cara ini, layanan backend dapat mengidentifikasi permintaan yang diproses oleh WAF.
	object	No	Field header kustom. Tentukan key untuk nama field header kustom dan value untuk nilai field tersebut.
Key	string	No	Kunci field header kustom.	aaa
Value	string	No	Nilai field header kustom.	bbb
ConnectTimeout	integer	No	Periode timeout untuk koneksi. Satuan: detik. Nilai yang valid: 1 hingga 3600. Nilai default: 5.	120
ReadTimeout	integer	No	Periode timeout untuk operasi baca. Satuan: detik. Nilai yang valid: 1 hingga 3600. Nilai default: 120.	200
WriteTimeout	integer	No	Periode timeout untuk operasi tulis. Satuan: detik. Nilai yang valid: 1 hingga 3600. Nilai default: 120.	200
CnameEnabled	boolean	No	Menunjukkan apakah fitur disaster recovery cloud publik diaktifkan untuk nama domain. Nilai yang valid: true: Fitur disaster recovery cloud publik diaktifkan. false (default): Fitur disaster recovery cloud publik dinonaktifkan.	true
RoutingRules	string	No	Aturan pengalihan untuk mode cloud hibrida. Nilai berisi field berikut: rs: Alamat IP atau nama kanonis server origin. backupRs: Alamat IP cadangan atau nama kanonis server origin. Wajib. Array kosong [] berarti tidak ada cadangan yang dikonfigurasi. location: Nama node perlindungan. locationId: ID node perlindungan.	[ { "rs": [ "1.1.XX.XX" ], "backupRs": [ "2.2.XX.XX" ], "locationId": 535, "location": "test1111" } ]
Keepalive	boolean	No	Menunjukkan apakah fitur koneksi persisten diaktifkan. Nilai yang valid: true (default): Fitur koneksi persisten diaktifkan. false: Fitur koneksi persisten dinonaktifkan.	true
Retry	boolean	No	Menunjukkan apakah WAF melakukan retry ketika WAF gagal meneruskan permintaan ke server origin. Nilai yang valid: true (default): WAF melakukan retry. false: WAF tidak melakukan retry.	true
KeepaliveRequests	integer	No	Jumlah koneksi persisten yang digunakan kembali. Nilai yang valid: 60 hingga 1000. Nilai default: 1000. Catatan Jumlah koneksi persisten yang digunakan kembali setelah fitur koneksi persisten diaktifkan.	1000
KeepaliveTimeout	integer	No	Periode timeout untuk koneksi persisten yang idle. Nilai yang valid: 1 hingga 60. Nilai default: 15. Satuan: detik. Catatan Parameter ini menentukan waktu koneksi persisten yang digunakan kembali dapat tetap dalam status Idle sebelum koneksi persisten ditutup.	15
XffProto	boolean	No	Menunjukkan apakah header X-Forward-For-Proto digunakan untuk mengidentifikasi protokol yang digunakan WAF untuk meneruskan permintaan ke server origin. Nilai yang valid: true (default): Header X-Forward-For-Proto digunakan untuk mengidentifikasi protokol. false: Header X-Forward-For-Proto tidak digunakan.	false
BackupBackends	array	No	Alamat IP sekunder atau nama domain server origin.
	string	No	Alamat IP sekunder atau nama domain server origin. Anda hanya dapat menggunakan salah satu jenis alamat. Jika Anda menggunakan jenis nama domain, nama domain tersebut hanya dapat di-resolve ke alamat IPv4: Untuk menentukan alamat IP, gunakan format ["ip1","ip2",……]. Anda dapat menentukan hingga 20 alamat IP. Untuk menentukan nama domain, gunakan format ["domain"]. Anda dapat memasukkan hingga 20 nama domain.	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	No	Menunjukkan apakah WAF diizinkan untuk menimpa header X-Client-IP. Nilai yang valid: true (default): WAF menimpa header. false: WAF tidak menimpa header.	true
XTrueIp	boolean	No	Menunjukkan apakah WAF diizinkan untuk menimpa header X-True-IP. Nilai yang valid: true (default): WAF menimpa header. false: WAF tidak menimpa header.	true
WebServerType	boolean	No	Menunjukkan apakah WAF diizinkan untuk menimpa header Web-Server-Type. Nilai yang valid: true (default): WAF menimpa header. false: WAF tidak menimpa header.	true
WLProxyClientIp	boolean	No	Menunjukkan apakah WAF diizinkan untuk menimpa header WL-Proxy-Client-IP. Nilai yang valid: true (default): WAF menimpa header. false: WAF tidak menimpa header.	true
MaxBodySize	integer	No	Ukuran maksimum badan permintaan. Nilai yang valid: 2 hingga 10. Nilai default: 2. Satuan: GB. Catatan Parameter ini hanya didukung oleh Edisi Ultimate.	2
Http2Origin	boolean	No	Menunjukkan apakah HTTP/2 diaktifkan untuk lalu lintas kembali-ke-asal. Nilai yang valid: true: HTTP/2 diaktifkan untuk lalu lintas kembali-ke-asal. false: HTTP/2 dinonaktifkan untuk lalu lintas kembali-ke-asal.	true
Http2OriginMaxConcurrency	integer	No	Jumlah maksimum permintaan kembali-ke-asal HTTP/2 konkuren. Nilai yang valid: 1 hingga 512. Nilai default: 128.	128
BackendPorts	array<object>	No	Konfigurasi port kustom.
	object	No	Konfigurasi port kustom.
ListenPort	integer	No	Port pendengar.	80
BackendPort	integer	No	Port kembali-ke-asal.	80
Protocol	string	No	Protokol port pendengar. Nilai yang valid: http: HTTP. https: HTTPS.	http
ProxyProtocol	boolean	No	Menunjukkan apakah fitur Proxy Protocol diaktifkan untuk mempertahankan alamat IP sumber klien. Nilai yang valid: true: Fitur Proxy Protocol diaktifkan. Setelah fitur ini diaktifkan, layanan backend dapat melihat alamat IP asli klien. false: Fitur Proxy Protocol dinonaktifkan.	false
RegionId	string	Yes	Wilayah tempat instans WAF berada. Nilai yang valid: cn-hangzhou: Tiongkok daratan. ap-southeast-1: Di luar Tiongkok daratan.	cn-hangzhou
AccessType	string	No	Jenis akses instans WAF. Nilai yang valid: share (default): onboarding menggunakan rekaman CNAME. hybrid_cloud_cname: onboarding menggunakan rekaman CNAME cloud hibrida.	share
Tag	array<object>	No	Tag. Anda dapat menentukan hingga 20 tag.
	object	No	Tag. Anda dapat menentukan hingga 20 tag.
Key	string	No	Kunci tag.	Tagkey1
Value	string	No	Nilai tag.	TagValue1

Elemen respons

Element	Type	Description	Example
	object	Struktur respons.
RequestId	string	ID permintaan.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
DomainInfo	object	Detail nama domain yang ditambahkan.
Cname	string	Nama CNAME yang ditetapkan WAF untuk nama domain.	xxxxxwww.****.com
Domain	string	Nama domain yang di-onboard ke WAF.	www.aliyundoc.com
DomainId	string	ID nama domain.	www.aliyundoc.com-waf

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "DomainInfo": {
    "Cname": "xxxxxwww.****.com",
    "Domain": "www.aliyundoc.com",
    "DomainId": "www.aliyundoc.com-waf"
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Waf.Pullin.ResourceExsit	Access resource already exists, resource:%s.
400	Waf.Pullin.BusinessViolation	The web services are suspected of violating regulations. If you have any questions, please submit a work order. Violating resource: %s.
400	Waf.Pullin.Http2OriginMustOnHttp2Enable	When HTTP2 origin is enabled, HTTP2 listening must be enabled.
400	Waf.Pullin.Http2OriginMustOnKeepaliveEnable	When the HTTP2 origin is turned on, the keepalive must be turned on.
400	Waf.Pullin.Http2OriginEnabledFocusHttpBackendForbidden	When HTTP2 origin is enabled, HTTP origin cannot be enabled.
400	Waf.Pullin.BatchDnsScheduleCheckFailed	Batch dns scheduling is in progress, and access related operations are prohibited.
400	Waf.Pullin.InvalidMaxAgeWithPreload	HstsMaxAge the parameter is incorrect, when the HstsPreload is True, the HstsMaxAge must be greater than or equal to 31536000.
400	Waf.Pullin.InvalidIncludeSubDomainWithPreload	The parameter HstsIncludeSubDomain is invalid. When the parameter HstsPreload is true, the HstsIncludeSubDomain must be true.
400	Waf.Pullin.InvalidCustomCiphers	Invalid custom cipher suite.
400	Waf.Pullin.InvalidHttp2OriginWithProxyProtocol	http2Origin and proxyProtocol cannot be opened at the same time.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.