Gunakan API ModifyDomain untuk mengubah konfigurasi domain yang diakses CNAME - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Memperbarui nama domain berbasis CNAME yang di-onboard 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:ModifyDomain

update

DefenseResource

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

DefenseResource

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instance WAF. Catatan Panggil operasi DescribeInstance untuk menanyakan ID instance WAF.	waf_cdnsdf3****
Domain	string	No	Nama domain yang konfigurasinya ingin Anda modifikasi.	www.aliyundoc.com
DomainId	string	No	ID nama domain.	www.aliyundoc.com-waf
Listen	object	Yes	Pengaturan listening.
HttpsPorts	array	No	Port listening HTTPS. Formatnya adalah [port1,port2,...].
	integer	No	Sebuah port listening HTTPS.	443
HttpPorts	array	No	Port listening HTTP. Formatnya adalah [port1,port2,...].
	integer	No	Sebuah port listening HTTP.	80
Http2Enabled	boolean	No	Menunjukkan apakah HTTP/2 diaktifkan. Parameter ini tersedia hanya jika HttpsPorts tidak kosong, yang menunjukkan bahwa domain menggunakan HTTPS. Nilai yang valid: true: HTTP/2 diaktifkan. false (default): HTTP/2 dinonaktifkan.	true
CertId	string	No	ID sertifikat.	123
SM2Enabled	boolean	No	Menunjukkan apakah sertifikat SM diaktifkan.	true
SM2CertId	string	No	ID sertifikat SM. Parameter ini diperlukan hanya jika SM2Enabled diatur ke true.	123-cn-hangzhou
SM2AccessOnly	boolean	No	Menunjukkan apakah akses diizinkan hanya dari klien SM. Parameter ini tersedia hanya jika SM2Enabled diatur ke true. Nilai yang valid: true: Hanya klien SM yang dapat mengakses situs web. false: Baik klien SM maupun non-SM dapat mengakses situs web.	true
TLSVersion	string	No	Versi TLS. Parameter ini tersedia hanya jika HttpsPorts tidak kosong, yang menunjukkan bahwa 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 HttpsPorts tidak kosong, yang menunjukkan bahwa domain menggunakan HTTPS. Nilai yang valid: true: TLS 1.3 didukung. false: TLS 1.3 tidak didukung.	true
CipherSuite	integer	No	Tipe dari cipher suite. Parameter ini tersedia hanya jika HttpsPorts tidak kosong, yang menunjukkan bahwa domain menggunakan HTTPS. Nilai yang valid: 1: semua cipher suite. 2: cipher suite kuat. Anda dapat memilih nilai ini hanya jika Anda mengatur TLSVersion ke tlsv1.2. 99: cipher suite kustom.	2
CustomCiphers	array	No	Cipher suite kustom. Parameter ini tersedia hanya jika Anda mengatur CipherSuite ke 99.
	string	No	Sebuah cipher suite kustom.	["xxx","ffas"]
FocusHttps	boolean	No	Menunjukkan apakah pengalihan HTTPS paksa diaktifkan. Parameter ini tersedia hanya jika domain menggunakan HTTPS tetapi bukan HTTP. Nilai yang valid: true: Pengalihan HTTPS paksa diaktifkan. false: Pengalihan HTTPS paksa dinonaktifkan.	true
XffHeaderMode	integer	No	Metode yang digunakan WAF untuk memperoleh alamat IP asli dari klien. Nilai yang valid: 0 (default): WAF memperoleh alamat IP klien dari koneksi TCP. Opsi ini cocok jika tidak ada proxy Layer 7 yang di-deploy di depan WAF. 1: WAF memperoleh alamat IP klien dari nilai pertama header X-Forwarded-For (XFF). 2: WAF memperoleh alamat IP klien dari field header kustom.	2
XffHeaders	array	No	Field header kustom yang digunakan untuk memperoleh alamat IP klien. Formatnya adalah ["header1","header2",...]. Catatan Parameter ini diperlukan hanya jika Anda mengatur XffHeaderMode ke 2.
	string	No	Sebuah field header kustom dari mana alamat IP klien diambil.	Client-ip
IPv6Enabled	boolean	No	Menunjukkan apakah IPv6 diaktifkan. Nilai yang valid: true: IPv6 diaktifkan. false (default): IPv6 dinonaktifkan.	true
ProtectionResource	string	No	Tipe dari resource proteksi. Nilai yang valid: share (default): sebuah cluster bersama. gslb: sebuah cluster bersama dengan global server load balancing.	share
ExclusiveIp	boolean	No	Menunjukkan apakah alamat IP eksklusif diaktifkan. Parameter ini tersedia hanya jika Anda mengatur IPv6Enabled ke false dan ProtectionResource ke share. Nilai yang valid: true: Alamat IP eksklusif diaktifkan. false (default): Alamat IP eksklusif dinonaktifkan.	true
HstsIncludeSubDomain	boolean	No	Menunjukkan apakah subdomain disertakan dalam kebijakan HTTP Strict Transport Security (HSTS). Nilai yang valid: true: Subdomain disertakan. false: Subdomain tidak disertakan.	false
HstsPreload	boolean	No	Menunjukkan apakah HSTS preload diaktifkan. Nilai default: false. Nilai yang valid: true: HSTS preload diaktifkan. false: HSTS preload dinonaktifkan.	false
HstsMaxAge	integer	No	Time-to-live (TTL) dari kebijakan HSTS. Satuan: detik.	365000
Redirect	object	Yes	Pengaturan forwarding.
Backends	array	No	Alamat IP atau nama domain dari server origin. Anda hanya dapat menentukan satu jenis alamat. Jika Anda menentukan sebuah nama domain, hanya IPv4 yang didukung. IPv6 tidak didukung. Alamat IP: Formatnya adalah ["ip1","ip2",...]. Anda dapat menentukan hingga 20 alamat IP. Nama domain: Formatnya adalah ["domain"]. Anda dapat menentukan hingga 20 nama domain.
	string	No	Sebuah alamat IP atau nama domain dari server origin.	1.1.XX.XX
Loadbalance	string	Yes	Algoritma load balancing untuk permintaan back-to-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.	iphash
FocusHttpBackend	boolean	No	Menunjukkan apakah HTTP back-to-origin paksa diaktifkan. Parameter ini tersedia hanya jika Anda menentukan HttpsPorts. Nilai yang valid: true: HTTP back-to-origin paksa diaktifkan. false: HTTP back-to-origin paksa dinonaktifkan.	true
SniEnabled	boolean	No	Menunjukkan apakah Server Name Indication (SNI) back-to-origin diaktifkan. Parameter ini tersedia hanya jika Anda menentukan HttpsPorts. Nilai yang valid: true: SNI back-to-origin diaktifkan. false (default): SNI back-to-origin dinonaktifkan.	true
SniHost	string	No	Nilai dari field SNI kustom. Jika Anda tidak mengatur parameter ini, nilai field Host dari header permintaan digunakan secara default. Anda biasanya tidak perlu mengatur parameter ini kecuali bisnis Anda memerlukan nilai SNI kustom untuk permintaan back-to-origin. Catatan Parameter ini tersedia hanya jika Anda mengatur SniEnabled ke true.	www.aliyundoc.com
RequestHeaders	array<object>	No	Field header kustom dan nilainya untuk penandaan trafik. WAF menambahkan field dan nilai ini ke header permintaan ketika trafik melewati WAF. Hal ini membantu layanan backend mengidentifikasi dan mengumpulkan statistik trafik yang diproses oleh WAF.
	object	No	Formatnya adalah [*{"k":"key","v":"value"}]. key* menentukan field header kustom, dan value menentukan nilai dari field tersebut. Catatan Jika field header kustom sudah ada dalam permintaan, WAF akan menimpa nilainya dengan nilai yang ditentukan.
Key	string	No	Field header permintaan kustom.	aaa
Value	string	No	Nilai dari field header kustom.	bbb
ConnectTimeout	integer	No	Periode timeout koneksi. Satuan: detik. Nilai yang valid: 1 hingga 3600. Nilai default: 5.	120
ReadTimeout	integer	No	Periode timeout pembacaan. Satuan: detik. Nilai yang valid: 1 hingga 3600. Nilai default: 120.	200
WriteTimeout	integer	No	Periode timeout penulisan. Satuan: detik. Nilai yang valid: 1 hingga 3600. Nilai default: 120.	200
CnameEnabled	boolean	No	Menunjukkan apakah pemulihan bencana public cloud diaktifkan. Nilai yang valid: true: Pemulihan bencana public cloud diaktifkan. false (default): Pemulihan bencana public cloud dinonaktifkan.	true
RoutingRules	string	No	Aturan forwarding untuk deployment hybrid cloud. Parameter ini adalah string yang berisi sebuah array JSON. Setiap elemen dalam array adalah struct yang berisi field berikut: rs: sebuah array string. Alamat IP atau CNAME back-to-origin. backupRs: sebuah array string. Alamat IP atau CNAME back-to-origin cadangan. Field ini diperlukan. Jika Anda tidak ingin menentukan alamat cadangan, atur ke []. location: sebuah string. Nama dari node proteksi. locationId: sebuah long integer. ID dari node proteksi.	[ { "rs": [ "1.1.XX.XX" ], "backupRs": [ "2.2.XX.XX" ], "locationId": 535, "location": "test1111" } ]
Keepalive	boolean	No	Menunjukkan apakah koneksi persisten diaktifkan. Nilai yang valid: true (default): Koneksi persisten diaktifkan. false: Koneksi persisten dinonaktifkan.	true
Retry	boolean	No	Menunjukkan apakah permintaan forwarding ke server origin diulang ketika permintaan gagal. Nilai yang valid: true (default): Permintaan diulang. false: Permintaan tidak diulang.	true
KeepaliveRequests	integer	No	Jumlah permintaan yang dapat digunakan kembali dalam sebuah koneksi persisten. Nilai yang valid: 60 hingga 1000. Nilai default: 1000. Catatan Parameter ini tersedia hanya jika Anda mengaktifkan koneksi persisten.	1000
KeepaliveTimeout	integer	No	Timeout idle untuk sebuah koneksi persisten. Satuan: detik. Nilai yang valid: 1 hingga 60. Nilai default: 15. Catatan Parameter ini menentukan jumlah waktu di mana sebuah koneksi persisten yang idle dapat tetap terbuka.	15
XffProto	boolean	No	Menunjukkan apakah header X-Forwarded-Proto digunakan untuk meneruskan protokol yang digunakan WAF ke server origin. Nilai yang valid: true (default): Protokol WAF diteruskan. false: Protokol WAF tidak diteruskan.	true
BackupBackends	array	No	Alamat IP atau nama domain dari server origin cadangan.
	string	No	Alamat IP atau nama domain dari server origin cadangan. Anda hanya dapat menentukan satu jenis alamat. Jika Anda menentukan sebuah nama domain, hanya IPv4 yang didukung. IPv6 tidak didukung. Alamat IP: Formatnya adalah ["ip1","ip2",...]. Anda dapat menentukan hingga 20 alamat IP. Nama domain: Formatnya adalah ["domain"]. Anda dapat menentukan 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 diizinkan untuk menimpa header tersebut. false: WAF tidak diizinkan untuk menimpa header tersebut.	true
XTrueIp	boolean	No	Menunjukkan apakah WAF diizinkan untuk menimpa header X-True-IP. Nilai yang valid: true (default): WAF diizinkan untuk menimpa header tersebut. false: WAF tidak diizinkan untuk menimpa header tersebut.	true
WebServerType	boolean	No	Menunjukkan apakah WAF diizinkan untuk menimpa header Web-Server-Type. Nilai yang valid: true (default): WAF diizinkan untuk menimpa header tersebut. false: WAF tidak diizinkan untuk menimpa header tersebut.	true
WLProxyClientIp	boolean	No	Menunjukkan apakah WAF diizinkan untuk menimpa header WL-Proxy-Client-IP. Nilai yang valid: true (default): WAF diizinkan untuk menimpa header tersebut. false: WAF tidak diizinkan untuk menimpa header tersebut.	true
MaxBodySize	integer	No	Ukuran maksimum dari body permintaan. Satuan: GB. Nilai yang valid: 2 hingga 10. Nilai default: 2. Catatan Parameter ini hanya didukung oleh edisi WAF Ultimate.	2
Http2Origin	boolean	No	Menunjukkan apakah HTTP/2 diaktifkan untuk permintaan back-to-origin. Nilai yang valid: true: HTTP/2 diaktifkan untuk permintaan back-to-origin. false: HTTP/2 dinonaktifkan untuk permintaan back-to-origin.	true
Http2OriginMaxConcurrency	integer	No	Jumlah maksimum permintaan HTTP/2 back-to-origin yang bersamaan. Nilai yang valid: 1 hingga 512. Nilai default: 2.	128
ProxyProtocol	boolean	No	Menunjukkan apakah Proxy Protocol diaktifkan untuk mempertahankan alamat IP klien. true: Proxy Protocol diaktifkan. Jika Anda memilih opsi ini, Anda dapat melihat alamat IP klien di server origin. false: Proxy Protocol dinonaktifkan.	false
BackendPorts	array<object>	No	Pemetaan port kustom untuk back-to-origin.
	object	No	Sebuah pemetaan port kustom untuk back-to-origin.
ListenPort	integer	No	Port listening WAF.	80
BackendPort	integer	No	Port dari server origin.	80
Protocol	string	No	Protokol dari port listening. Nilai yang valid: http: HTTP. https: HTTPS.	http
RegionId	string	Yes	Region tempat instance WAF berada. Nilai yang valid: cn-hangzhou: Daratan Tiongkok. ap-southeast-1: di luar Daratan Tiongkok.	cn-hangzhou
AccessType	string	No	Mode akses dari instance WAF. Nilai yang valid: share (default): onboarding dengan menggunakan record CNAME. hybrid_cloud_cname: onboarding dengan menggunakan record CNAME hybrid cloud.	share

Elemen respons

Element	Type	Description	Example
	object	Struktur respons.
RequestId	string	ID dari permintaan.	D7861F61-5B61-46CE-A47C-6B19160D****
DomainInfo	object	Informasi tentang nama domain yang dimodifikasi.
Cname	string	CNAME yang ditetapkan oleh WAF untuk nama domain.	xxxxxcvdaf.****.com
Domain	string	Nama domain yang konfigurasinya dimodifikasi.	www.aliyundoc.com
DomainId	string	ID nama domain.	www.aliyundoc.com-waf

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message
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.Control.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.
400	Waf.Control.DomainAndDomainIdNotMatch	domain and domainId do not match.
400	Waf.Control.DomainIdIsIllegal	The input parameter, the domainId is illegal.
400	Waf.Pullin.BackupBackendConflict	The backup backend configuration conflicts.
400	Waf.Pullin.BackendPortIncompatible	The back-to-source port is incompatible with the listening port, listening protocol:%s, listening port:%s, back-to-source port:%s.
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.