Gunakan CreateDomain untuk menambahkan domain - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Menambahkan nama domain ke instans WAF untuk perlindungan Konfigurasi Situs Web.

Deskripsi operasi

Sebelum Anda memanggil operasi ini, nama domain (Domain) harus memenuhi persyaratan berikut.

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 Anda dapat memanggil DescribeInstance untuk mengkueri ID instans WAF saat ini.	waf_cdnsdf3****
ResourceManagerResourceGroupId	string	No	ID kelompok sumber daya Alibaba Cloud.	rg-acfm***q
Domain	string	Yes	Nama domain yang akan dikueri.	www.aliyundoc.com
Listen	object	Yes	Konfigurasi pendengaran.
HttpsPorts	array	No	Port pendengaran untuk HTTPS.
	integer	No	Daftar Port pendengaran untuk HTTPS, dalam format [port1,port2,......,portN].	443
HttpPorts	array	No	Port pendengaran untuk HTTP.
	integer	No	Daftar Port pendengaran untuk HTTP, dalam format [port1,port2,......].	80
Http2Enabled	boolean	No	Apakah akan mengaktifkan HTTP/2. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong, yang menunjukkan bahwa nama domain menggunakan HTTPS. Nilai valid:	true
CertId	string	No	ID sertifikat yang akan ditambahkan. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong, yang menunjukkan bahwa nama domain menggunakan HTTPS.	123
SM2Enabled	boolean	No	Apakah akan mengaktifkan sertifikat SM2.	true
SM2CertId	string	No	ID sertifikat SM2 yang akan ditambahkan. Parameter ini hanya digunakan ketika SM2Enabled diatur ke true.	123-cn-hangzhou
SM2AccessOnly	boolean	No	Apakah akan mengizinkan hanya akses klien SM2. Parameter ini hanya digunakan ketika SM2Enabled diatur ke true.	true
TLSVersion	string	No	Versi TLS yang akan ditambahkan. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong, yang menunjukkan bahwa nama domain menggunakan protokol HTTPS. Nilai valid: tlsv1: Mendukung TLS 1.0 dan versi lebih baru. Kompatibilitas tertinggi dan keamanan terendah. tlsv1.1: Mendukung TLS 1.1 dan versi lebih baru. Kompatibilitas baik dan keamanan baik. tlsv1.2: Mendukung TLS 1.2 dan versi lebih baru. Kompatibilitas baik dan keamanan tertinggi. tlsv1.3: Hanya mendukung TLS 1.3. Keamanan tertinggi dan kompatibilitas terendah.	tlsv1
EnableTLSv3	boolean	No	Apakah akan mendukung TLS 1.3. Nilai valid:	true
CipherSuite	integer	No	Tipe paket sandi yang akan ditambahkan. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong, yang menunjukkan bahwa nama domain menggunakan HTTPS. Nilai valid:	2
CustomCiphers	array	No	Paket sandi kustom yang akan ditambahkan.
	string	No	Paket sandi kustom yang akan ditambahkan. Parameter ini hanya digunakan ketika CipherSuite diatur ke 99.	ECDHE-ECDSA-AES256-SHA384
FocusHttps	boolean	No	Apakah akan mengaktifkan pengalihan HTTPS wajib. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong (yang menunjukkan bahwa nama domain menggunakan HTTPS) dan HttpPorts kosong (yang menunjukkan bahwa nama domain tidak menggunakan HTTP). Nilai valid:	true
XffHeaderMode	integer	No	Metode yang digunakan WAF untuk memperoleh alamat IP asli klien. Nilai valid:	1
XffHeaders	array	No	Bidang header kustom yang digunakan untuk memperoleh alamat IP klien.
	string	No	Bidang header kustom yang digunakan untuk memperoleh alamat IP klien, dalam format ["header1","header2",......].	Client-ip
IPv6Enabled	boolean	No	Apakah akan mengaktifkan IPv6. Nilai valid:	true
ProtectionResource	string	No	Tipe Sumber daya perlindungan yang akan digunakan. Nilai valid:	share
ExclusiveIp	boolean	No	Apakah akan mengaktifkan alamat IP eksklusif. Parameter ini hanya digunakan ketika IPv6Enabled diatur ke false (yang menunjukkan bahwa IPv6 dinonaktifkan) dan ProtectionResource diatur ke share (yang menunjukkan bahwa kluster bersama digunakan). Nilai valid:	true
HstsIncludeSubDomain	boolean	No	Apakah HSTS mencakup subdomain. Nilai valid:	true
HstsPreload	boolean	No	Apakah akan mengaktifkan pemuatan awal HSTS. Fitur ini dinonaktifkan secara default. Nilai valid:	false
HstsMaxAge	integer	No	Pengatur waktu kedaluwarsa HSTS. Unit: detik.	365000
Redirect	object	Yes	Konfigurasi penerusan.
Backends	array	No	Alamat IP atau nama domain server asal yang sesuai dengan nama domain.
	string	No	Alamat IP atau nama domain server asal yang sesuai dengan nama domain. Anda hanya dapat menetapkan satu tipe: alamat IP server asal atau nama domain server asal. Ketika alamat back-to-origin adalah nama domain, hanya IPv4 yang didukung. IPv6 tidak didukung.	1.1.XX.XX
Loadbalance	string	Yes	Algoritma load balancing yang digunakan untuk permintaan back-to-origin. Nilai valid: iphash: Algoritma hash IP. roundRobin: Algoritma round-robin. leastTime: Algoritma Least Time. Nilai ini hanya tersedia ketika ProtectionResource diatur ke gslb (menunjukkan bahwa tipe resource proteksi menggunakan load balancing cerdas dari kluster bersama).	roundRobin
FocusHttpBackend	boolean	No	Apakah akan mengaktifkan back-to-origin HTTP wajib. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong, yang menunjukkan bahwa nama domain menggunakan HTTPS. Nilai valid:	true
SniEnabled	boolean	No	Apakah akan mengaktifkan Server Name Indication (SNI) back-to-origin. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong, yang menunjukkan bahwa nama domain menggunakan HTTPS. Nilai valid:	true
SniHost	string	No	Nilai bidang ekstensi SNI kustom. Jika Anda tidak menetapkan parameter ini, nilai bidang Host dalam header permintaan akan digunakan sebagai nilai bidang ekstensi SNI secara default. Dalam sebagian besar kasus, Anda tidak perlu menyesuaikan SNI kecuali bisnis Anda memiliki persyaratan konfigurasi khusus dan Anda ingin WAF menggunakan SNI yang berbeda dari Host permintaan aktual dalam permintaan back-to-origin (yaitu, SNI kustom yang ditetapkan di sini). Catatan Parameter ini hanya diperlukan jika SniEnabled diatur ke true (menunjukkan bahwa SNI back-to-origin diaktifkan).	www.aliyundoc.com
RequestHeaders	array<object>	No	Bidang header penanda trafik dan nilainya untuk nama domain, digunakan untuk menandai trafik yang diproses oleh WAF.
	object	No	Nilai parameter ini dalam format [*{"k":"key","v":"value"}], di mana key* menentukan bidang header permintaan kustom dan *value* menentukan nilai yang ditetapkan untuk bidang tersebut.
Key	string	No	Bidang header permintaan kustom.	aaa
Value	string	No	Nilai yang ditetapkan untuk bidang header permintaan kustom.	bbb
ConnectTimeout	integer	No	Periode waktu tunggu koneksi. Unit: detik.	120
ReadTimeout	integer	No	Periode waktu tunggu baca. Unit: detik.	200
WriteTimeout	integer	No	Periode waktu tunggu tulis. Unit: detik.	200
CnameEnabled	boolean	No	Apakah akan mengaktifkan pemulihan bencana cloud publik. Nilai valid: true: Pemulihan bencana cloud publik diaktifkan. false (default): Pemulihan bencana cloud publik tidak diaktifkan.	true
RoutingRules	string	No	Aturan penerusan cloud hibrida. Nilainya adalah string yang dikonversi dari array JSON. Setiap elemen dalam array JSON adalah struct yang berisi bidang berikut:	[
Keepalive	boolean	No	Apakah akan mengaktifkan koneksi persisten. Nilai valid:	true
Retry	boolean	No	Apakah akan mencoba lagi ketika WAF gagal meneruskan permintaan ke server asal. Nilai valid:	true
KeepaliveRequests	integer	No	Jumlah permintaan yang menggunakan kembali koneksi persisten. Nilai valid: 60 hingga 1000. Nilai default: 1000.	1000
KeepaliveTimeout	integer	No	Periode waktu tunggu idle untuk koneksi persisten. Nilai valid: 1 hingga 60. Nilai default: 15. Unit: detik.	15
XffProto	boolean	No	Apakah akan menggunakan X-Forward-For-Proto untuk meneruskan protokol yang digunakan oleh WAF. Nilai valid:	false
BackupBackends	array	No	Alamat IP atau nama domain server asal sekunder yang sesuai dengan nama domain.
	string	No	Alamat IP atau nama domain server asal sekunder yang sesuai dengan nama domain. Anda hanya dapat menetapkan satu tipe: alamat IP server asal atau nama domain server asal. Ketika alamat back-to-origin adalah nama domain, hanya IPv4 yang didukung. IPv6 tidak didukung.	2.2.XX.XX
XClientIp	boolean	No	Apakah akan mengizinkan WAF menimpa X-Client-IP. Nilai valid:	true
XTrueIp	boolean	No	Apakah akan mengizinkan WAF menimpa X-True-IP. Nilai valid:	true
WebServerType	boolean	No	Apakah akan mengizinkan WAF menimpa Web-Server-Type. Nilai valid:	true
WLProxyClientIp	boolean	No	Apakah akan mengizinkan WAF menimpa WL-Proxy-Client-IP. Nilai valid:	true
MaxBodySize	integer	No	Ukuran badan permintaan maksimum. Nilai valid: 2 hingga 10. Nilai default: 2. Unit: GB.	2
Http2Origin	boolean	No	Apakah akan mengaktifkan back-to-origin HTTP/2. Nilai valid:	true
Http2OriginMaxConcurrency	integer	No	Jumlah maksimum koneksi back-to-origin HTTP/2 konkuren. Nilai valid: 1 hingga 512. Nilai default: 128.	128
BackendPorts	array<object>	No	Konfigurasi port kustom.
	object	No	Konfigurasi port kustom.
ListenPort	integer	No	Port pendengaran.	80
BackendPort	integer	No	Port back-to-origin.	80
Protocol	string	No	Protokol Port pendengaran. Nilai valid:	http
ProxyProtocol	boolean	No	Apakah fitur pelestarian IP sumber klien diaktifkan. true: Fitur pelestarian IP sumber klien diaktifkan. Setelah fitur ini diaktifkan, layanan backend dapat melihat alamat IP asal klien. false: Fitur pelestarian IP sumber klien tidak diaktifkan.	false
RegionId	string	Yes	Wilayah tempat instans WAF berada. Nilai valid:	cn-hangzhou
AccessType	string	No	Tipe akses instans WAF. Nilai valid: share (default): Akses CNAME. hybrid_cloud_cname: Akses CNAME cloud hibrida. Catatan Jika nilainya adalah share, atau jika nilainya adalah hybrid_cloud_cname dan pemulihan bencana cloud publik diaktifkan, panggil operasi DescribeVerifyContent dan VerifyDomainOwner untuk memverifikasi kepemilikan nama domain terlebih dahulu. Jika nama domain terhubung ke wilayah di Tiongkok Daratan, Pendaftaran ICP juga harus diselesaikan.	share
Tag	array<object>	No	Daftar tag. Anda dapat menentukan hingga 20 tag.
	object	No	Tag sumber daya. 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	Respons yang dikembalikan setelah nama domain ditambahkan.
RequestId	string	ID permintaan.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
DomainInfo	object	Informasi tentang nama domain yang ditambahkan.
Cname	string	Nama Domain CNAME yang ditetapkan oleh WAF untuk nama domain.	xxxxxwww.****.com
Domain	string	Nama domain yang ditambahkan.	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	Description
400	Waf.Pullin.ResourceExsit	Access resource already exists, resource:%s.	Sumber daya yang terhubung sudah ada. Sumber daya yang ada: %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.	Layanan diduga melanggar aturan. Jika Anda memiliki pertanyaan, ajukan Tiket. Resource yang melanggar: %s.
400	Waf.Pullin.Http2OriginMustOnHttp2Enable	When HTTP2 origin is enabled, HTTP2 listening must be enabled.	Pendengar HTTP/2 harus diaktifkan saat back-to-origin HTTP/2 diaktifkan.
400	Waf.Pullin.Http2OriginMustOnKeepaliveEnable	When the HTTP2 origin is turned on, the keepalive must be turned on.	Keep-alive harus diaktifkan saat back-to-origin HTTP/2 diaktifkan.
400	Waf.Pullin.Http2OriginEnabledFocusHttpBackendForbidden	When HTTP2 origin is enabled, HTTP origin cannot be enabled.	Back-to-origin HTTP tidak dapat diaktifkan saat back-to-origin HTTP/2 diaktifkan.
400	Waf.Pullin.BatchDnsScheduleCheckFailed	Batch dns scheduling is in progress, and access related operations are prohibited.	Penjadwalan DNS batch sedang berlangsung. Operasi terkait koneksi dilarang.
400	Waf.Pullin.InvalidMaxAgeWithPreload	HstsMaxAge the parameter is incorrect, when the HstsPreload is True, the HstsMaxAge must be greater than or equal to 31536000.	Parameter HstsMaxAge tidak valid. Jika HstsPreload diatur ke True, HstsMaxAge harus lebih besar dari atau sama dengan 31536000.
400	Waf.Pullin.InvalidIncludeSubDomainWithPreload	The parameter HstsIncludeSubDomain is invalid. When the parameter HstsPreload is true, the HstsIncludeSubDomain must be true.	Parameter HstsIncludeSubDomain tidak valid. Ketika HstsPreload diatur ke true, HstsIncludeSubDomain juga harus diatur ke true.
400	Waf.Pullin.InvalidCustomCiphers	Invalid custom cipher suite.	Paket sandi kustom tidak valid.
400	Waf.Pullin.InvalidHttp2OriginWithProxyProtocol	http2Origin and proxyProtocol cannot be opened at the same time.	http2Origin dan proxyProtocol tidak dapat diaktifkan secara bersamaan.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.