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

Menambahkan nama domain ke instans WAF dengan menggunakan Konfigurasi Situs Web 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 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 listening.
HttpsPorts	array	No	Port listening untuk HTTPS.
	integer	No	Daftar port listening untuk HTTPS, dalam format [port1,port2,......,portN].	[443,8443]
HttpPorts	array	No	Port listening untuk HTTP.
	integer	No	Daftar port listening untuk HTTP, dalam format [port1,port2,……].	[80,81]
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: HTTP/2 diaktifkan. false (default): HTTP/2 tidak diaktifkan.	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 Enkripsi China (SM).	true
SM2CertId	string	No	ID sertifikat Enkripsi China (SM) yang akan ditambahkan. Parameter ini hanya digunakan ketika SM2Enabled diatur ke true.	123-cn-hangzhou
SM2AccessOnly	boolean	No	Apakah hanya klien Enkripsi China (SM) yang dapat mengakses nama domain. Parameter ini hanya digunakan ketika SM2Enabled diatur ke true. true: Hanya klien Enkripsi China (SM) yang dapat mengakses nama domain. false: Klien Enkripsi China (SM) dan non-Enkripsi China (SM) dapat mengakses nama domain.	true
TLSVersion	string	No	Versi TLS yang akan ditambahkan. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong, yang menunjukkan bahwa nama domain menggunakan HTTPS. Nilai valid: tlsv1 tlsv1.1 tlsv1.2	tlsv1
EnableTLSv3	boolean	No	Apakah akan mendukung TLS 1.3. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong, yang menunjukkan bahwa nama domain menggunakan HTTPS. Nilai valid: true: TLS 1.3 didukung. false: TLS 1.3 tidak didukung.	true
CipherSuite	integer	No	Jenis paket sandi yang akan ditambahkan. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong, yang menunjukkan bahwa nama domain menggunakan HTTPS. Nilai valid: 1: semua paket sandi. 2: paket sandi kuat. Nilai ini hanya tersedia ketika TLSVersion diatur ke tlsv1.2. 99: paket sandi kustom.	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.	["xxx","ffas"]
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: Pengalihan HTTPS wajib diaktifkan. false: Pengalihan HTTPS wajib tidak diaktifkan.	true
XffHeaderMode	integer	No	Metode yang digunakan WAF untuk memperoleh alamat IP asal klien. Nilai valid: 0 (default): Trafik klien belum diteruskan oleh proxy Layer 7 apa pun sebelum mencapai WAF. 1: WAF membaca nilai pertama dalam header X-Forwarded-For (XFF) sebagai alamat IP klien. 2: WAF membaca nilai bidang Header Kustom yang Anda tentukan sebagai alamat IP klien.	1
XffHeaders	array	No	Daftar bidang Header Kustom yang digunakan untuk memperoleh alamat IP klien.
	string	No	Daftar bidang Header Kustom yang digunakan untuk memperoleh alamat IP klien, dalam format ["header1","header2",……]. Catatan Parameter ini diperlukan hanya ketika XffHeaderMode diatur ke 2, yang menunjukkan bahwa WAF membaca nilai bidang Header Kustom yang Anda tentukan sebagai alamat IP klien.	["Client-ip","cip"]
IPv6Enabled	boolean	No	Apakah akan mengaktifkan IPv6. Nilai valid: true: IPv6 diaktifkan. false (default): IPv6 tidak diaktifkan.	true
ProtectionResource	string	No	Jenis Sumber daya perlindungan yang akan digunakan. Nilai valid: share (default): kluster bersama. gslb: load balancing cerdas berbasis kluster bersama.	share
ExclusiveIp	boolean	No	Apakah akan mengaktifkan alamat IP Eksklusif. Parameter ini hanya digunakan ketika IPv6Enabled diatur ke false (yang menunjukkan bahwa IPv6 tidak diaktifkan) dan ProtectionResource diatur ke share (yang menunjukkan bahwa kluster bersama digunakan). Nilai valid: true: Alamat IP Eksklusif diaktifkan. false (default): Alamat IP Eksklusif tidak diaktifkan.	true
HstsIncludeSubDomain	boolean	No	Apakah HSTS mencakup subdomain. Nilai valid: true: Diaktifkan. false: Tidak diaktifkan.
HstsPreload	boolean	No	Apakah akan mengaktifkan pramuat HSTS. Fitur ini dinonaktifkan secara default. Nilai valid: true: Diaktifkan. false: Dinonaktifkan.	false
HstsMaxAge	integer	No	Pengatur waktu kedaluwarsa HSTS. Unit: detik.	365000
Redirect	object	Yes	Konfigurasi penerusan.
Backends	array	No	Alamat IP atau nama domain back-to-origin dari server origin yang sesuai dengan nama domain.
	string	No	Alamat IP atau nama domain back-to-origin dari server origin yang sesuai dengan nama domain. Anda hanya dapat menetapkan satu jenis: alamat IP server origin atau nama domain back-to-origin. Ketika alamat back-to-origin adalah nama domain, hanya IPv4 yang didukung. IPv6 tidak didukung. Untuk menetapkan alamat IP server origin, gunakan format ["ip1","ip2",……]. Maksimal 20 alamat IP didukung. Untuk menetapkan nama domain back-to-origin, gunakan format ["domain"]. Maksimal 20 alamat nama domain didukung.	[ "1.1.XX.XX", "2.2.XX.XX" ]
Loadbalance	string	Yes	Algoritma load balancing yang digunakan untuk back-to-origin. Nilai valid: iphash: algoritma hash IP. roundRobin: algoritma round-robin. leastTime: algoritma Waktu paling singkat. Nilai ini hanya tersedia ketika ProtectionResource diatur ke gslb, yang menunjukkan bahwa load balancing cerdas berbasis kluster bersama digunakan.	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: Back-to-origin HTTP wajib diaktifkan. false: Back-to-origin HTTP wajib tidak diaktifkan.	true
SniEnabled	boolean	No	Apakah akan mengaktifkan Sumber SNI back-to-origin. Parameter ini hanya digunakan ketika HttpsPorts tidak kosong, yang menunjukkan bahwa nama domain menggunakan HTTPS. Nilai valid: true: Sumber SNI back-to-origin diaktifkan. false (default): Sumber SNI back-to-origin tidak diaktifkan.	true
SniHost	string	No	Nilai bidang ekstensi SNI kustom. Jika parameter ini tidak diatur, nilai bidang Host dalam header permintaan digunakan sebagai nilai bidang ekstensi SNI secara default. Dalam kebanyakan kasus, Anda tidak perlu menyesuaikan SNI kecuali layanan Anda memiliki persyaratan konfigurasi khusus dan Anda ingin WAF menggunakan SNI yang berbeda dari Host permintaan aktual dalam permintaan back-to-origin (SNI kustom yang diatur di sini). Catatan Parameter ini diperlukan hanya ketika SniEnabled diatur ke true, yang menunjukkan bahwa Sumber SNI back-to-origin diaktifkan.	www.aliyundoc.com
RequestHeaders	array<object>	No	Bidang dan nilai tanda trafik nama domain, digunakan untuk menandai trafik yang diproses oleh WAF. Dengan menentukan bidang header permintaan kustom dan nilai yang sesuai, ketika trafik akses nama domain melewati WAF, WAF secara otomatis menambahkan nilai bidang kustom yang ditentukan ke header permintaan sebagai tanda trafik, yang membantu layanan backend mengumpulkan informasi terkait.
	object	No	Nilai parameter ini dalam format [*{"k":"key","v":"value"}]. key* menunjukkan bidang header permintaan kustom yang ditentukan, dan *value* menunjukkan nilai yang diatur untuk bidang tersebut.
Key	string	No	Bidang header permintaan kustom yang ditentukan.	aaa
Value	string	No	Nilai yang diatur untuk bidang header permintaan kustom.	bbb
ConnectTimeout	integer	No	Periode waktu tunggu koneksi. Unit: detik. Nilai valid: 1 hingga 3600. Nilai default: 5.	120
ReadTimeout	integer	No	Periode waktu tunggu baca. Unit: detik. Nilai valid: 1 hingga 3600. Nilai default: 120.	200
WriteTimeout	integer	No	Periode waktu tunggu tulis. Unit: detik. Nilai valid: 1 hingga 3600. Nilai default: 120.	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 struktur yang berisi bidang berikut: rs: Tipe Array \| Daftar alamat IP back-to-origin atau Nama Domain CNAME back-to-origin. backupRs: Tipe Array \| Daftar alamat IP back-to-origin cadangan atau Nama Domain CNAME back-to-origin cadangan. Bidang ini diperlukan. Gunakan [] untuk menunjukkan bahwa tidak ada cadangan yang diatur. location: Tipe String \| Nama node perlindungan. locationId: Tipe Long \| ID node perlindungan.	[ { "rs": [ "1.1.XX.XX" ], "backupRs": [ "2.2.XX.XX" ], "locationId": 535, "location": "test1111" } ]
Keepalive	boolean	No	Apakah akan mengaktifkan koneksi persisten. Nilai valid: true (default): Koneksi persisten diaktifkan. false: Koneksi persisten tidak diaktifkan.	true
Retry	boolean	No	Apakah akan mencoba lagi ketika WAF gagal meneruskan permintaan ke server origin. Nilai valid: true (default): Pencobaan ulang diaktifkan. false: Pencobaan ulang tidak diaktifkan.	true
KeepaliveRequests	integer	No	Jumlah permintaan yang menggunakan kembali koneksi persisten. Nilai valid: 60 hingga 1000. Nilai default: 1000. Catatan Jumlah koneksi persisten yang digunakan kembali setelah koneksi persisten diaktifkan.	1000
KeepaliveTimeout	integer	No	Periode waktu tunggu idle untuk koneksi persisten. Nilai valid: 1 hingga 60. Nilai default: 15. Unit: detik. Catatan Waktu idle setelah koneksi persisten yang digunakan kembali dilepaskan.	15
XffProto	boolean	No	Apakah akan menggunakan X-Forward-For-Proto 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.	false
BackupBackends	array	No	Alamat IP server origin cadangan atau nama domain back-to-origin yang sesuai dengan nama domain.
	string	No	Alamat IP server origin cadangan atau nama domain back-to-origin yang sesuai dengan nama domain. Anda hanya dapat menetapkan satu jenis: alamat IP server origin atau nama domain back-to-origin. Ketika alamat back-to-origin adalah nama domain, hanya IPv4 yang didukung. IPv6 tidak didukung. Untuk menetapkan alamat IP server origin, gunakan format ["ip1","ip2",……]. Maksimal 20 alamat IP didukung. Untuk menetapkan nama domain back-to-origin, gunakan format ["domain"]. Maksimal 20 alamat nama domain didukung.	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	No	Apakah akan mengizinkan WAF menimpa X-Client-IP. Nilai valid: true (default): WAF diizinkan untuk menimpa. false: WAF tidak diizinkan untuk menimpa.	true
XTrueIp	boolean	No	Apakah akan mengizinkan WAF menimpa X-True-IP. Nilai valid: true (default): WAF diizinkan untuk menimpa. false: WAF tidak diizinkan untuk menimpa.	true
WebServerType	boolean	No	Apakah akan mengizinkan WAF menimpa Web-Server-Type. Nilai valid: true (default): WAF diizinkan untuk menimpa. false: WAF tidak diizinkan untuk menimpa.	true
WLProxyClientIp	boolean	No	Apakah akan mengizinkan WAF menimpa WL-Proxy-Client-IP. Nilai valid: true (default): WAF diizinkan untuk menimpa. false: WAF tidak diizinkan untuk menimpa.	true
MaxBodySize	integer	No	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	No	Apakah akan mengaktifkan back-to-origin HTTP/2. Nilai valid: true: Back-to-origin HTTP/2 diaktifkan. false: Back-to-origin HTTP/2 tidak diaktifkan.	true
Http2OriginMaxConcurrency	integer	No	Jumlah maksimum koneksi bersamaan untuk back-to-origin HTTP/2. 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 listening.	80
BackendPort	integer	No	Port back-to-origin.	80
Protocol	string	No	Protokol Port listening. Nilai valid: http: Protokol Port listening adalah HTTP. https: Protokol Port listening adalah HTTPS.	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 Tampilan alamat IP asal klien. false: Fitur pelestarian IP sumber klien tidak diaktifkan.	false
RegionId	string	Yes	Wilayah tempat instans WAF diterapkan. Nilai valid: cn-hangzhou: Tiongkok daratan. ap-southeast-1: luar Tiongkok daratan.	cn-hangzhou
AccessType	string	No	Jenis akses instans WAF. Nilai valid: share (default): akses Nama Domain CNAME. hybrid_cloud_cname: akses Nama Domain CNAME Cloud Hibrida.	share
Tag	array<object>	No	Daftar tag, yang berisi maksimal 20 item.
	object	No	Tag Sumber daya. Maksimal 20 item didukung.
Key	string	No	Kunci tag.	Tagkey1
Value	string	No	Nilai tag.	TagValue1

Elemen respons

Element	Type	Description	Example
	object	Tanggapan 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 ke 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 ingin Anda tambahkan 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 terindikasi pelanggaran. Jika Anda memiliki pertanyaan, ajukan Tiket. Sumber daya yang melanggar: %s.
400	Waf.Pullin.Http2OriginMustOnHttp2Enable	When HTTP2 origin is enabled, HTTP2 listening must be enabled.	Pendengar HTTP/2 harus diaktifkan saat HTTP/2 back-to-origin diaktifkan.
400	Waf.Pullin.Http2OriginMustOnKeepaliveEnable	When the HTTP2 origin is turned on, the keepalive must be turned on.	Koneksi persisten harus diaktifkan saat HTTP/2 back-to-origin diaktifkan.
400	Waf.Pullin.Http2OriginEnabledFocusHttpBackendForbidden	When HTTP2 origin is enabled, HTTP origin cannot be enabled.	HTTP back-to-origin tidak dapat diaktifkan saat HTTP/2 back-to-origin diaktifkan.
400	Waf.Pullin.BatchDnsScheduleCheckFailed	Batch dns scheduling is in progress, and access related operations are prohibited.	Penjadwalan DNS batch sedang berlangsung. Operasi terkait tidak diizinkan.
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. Saat 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. Saat HstsPreload diatur ke true, HstsIncludeSubDomain 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 pada pengatur waktu yang sama.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.