Rute log Hybrid Cloud WAF ke Syslog atau Kafka - Web Application Firewall - Alibaba Cloud - Web Application Firewall

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

create

*全部资源

*

acs:ResourceGroupId

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans WAF. Catatan Panggil operasi DescribeInstance untuk mengkueri ID instans WAF.	waf_elasticity-cn-0xldbqt****
DeliveryName	string	Yes	Nama konfigurasi pengiriman log.	test1
DeliveryType	string	Yes	Tipe konfigurasi pengiriman log. Nilai valid: syslog: Mengirimkan log ke layanan syslog. kafka: Mengirimkan log ke layanan Kafka.	syslog
DeliveryDetail	string	Yes	Detail konfigurasi pengiriman log. Nilainya adalah string JSON yang dihasilkan dari serangkaian parameter. Catatan Parameter bervariasi berdasarkan nilai DeliveryType. Untuk informasi lebih lanjut, lihat Parameter untuk detail konfigurasi pengiriman log.	{ "rfcVersion": "rfc3164", "protocol": "tcp", "servers": [ { "address": "1.1.1.1", "port": 20 } ] }
RegionId	string	No	Wilayah tempat instans WAF berada. Nilai valid: cn-hangzhou: Tiongkok daratan. ap-southeast-1: di luar Tiongkok daratan.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	ID kelompok sumber daya Alibaba Cloud.	rg-acfm***q

Detail konfigurasi pengiriman log.

Mengirimkan log ke layanan syslog (syslog).

Parameter

Nama	Tipe	Wajib	Contoh	Deskripsi
servers	Array	Ya	[{"address":"11.11.XX.XX","port":8000}]	Alamat remote layanan syslog. Jika DeliveryType diatur ke syslog, Anda hanya dapat menentukan satu alamat. Alamat mencakup parameter berikut: - address: Nama domain atau alamat IP server. Alamat IPv4 dan IPv6 didukung. Parameter ini wajib. - port: Port server. Parameter ini wajib.
rfcVersion	String	Tidak	rfc3164	Versi RFC untuk syslog. Nilai valid: - rfc3164 (default): RFC 3164. - rfc5424: RFC 5424.
protocol	String	Ya	tcp	Protokol untuk syslog. Nilai valid: - tcp: TCP. - udp: UDP.

{
	"InstanceId": "waf_v2_public_cn-n*******",
	"DeliveryName": "test1",
	"DeliveryType": "syslog",
	"DeliveryDetail": "{\"rfcVersion\":\"rfc3164\",\"protocol\":\"tcp\",\"servers\":[{\"address\":\"11.11.XX.XX\",\"port\":8000}]}"
}
```.

### Mengirimkan log ke layanan Kafka (**kafka**).

#### Parameter

| Nama             | Tipe   | Wajib | Contoh                             | Deskripsi                                                                                                                                                                                                                                                                                                                                                          |
| ---------------- | ------ | ----- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| servers          | Array  | Ya    | \[{"address":"a.com","port":8000}] | Alamat remote layanan Kafka. Jika DeliveryType diatur ke **kafka**, Anda dapat menentukan hingga tiga alamat. Setiap alamat mencakup parameter berikut:<br>\- **address**: Nama domain atau alamat IP server. Alamat IPv4 dan IPv6 didukung. Parameter ini wajib.<br>\- **port**: Port server. Parameter ini wajib. |
| kafkaTopic       | String | Ya    | test                               | ID atau nama topik untuk Kafka.                                                                                                                                                                                                                                                                                                                                      |
| protocol         | String | Ya    | PLAINTEXT                          | Protokol keamanan untuk Kafka. Nilai valid:<br>\- **PLAINTEXT** (default): PLAINTEXT.<br>\- **SASL_PLAINTEXT**: SASL_PLAINTEXT.<br>\- **SASL_SSL**: SASL_SSL.                                                                                                                                                                                                     |
| saslUserName     | String | Tidak | user123                            | Nama pengguna untuk autentikasi SASL layanan Kafka. Parameter ini wajib jika **protocol** diatur ke **SASL_PLAINTEXT** atau **SASL_SSL**.                                                                                                                                                                                                                  |
| saslPassword     | String | Tidak | user***                            | Kata sandi untuk autentikasi SASL layanan Kafka. Parameter ini wajib jika **protocol** diatur ke **SASL_PLAINTEXT** atau **SASL_SSL**.                                                                                                                                                                                                                  |
| pemCert          | String | Tidak | Cert                               | Sertifikat kustom untuk layanan Kafka. Sertifikat harus dalam format PEM.                                                                                                                                                                                                                                                                             |
| compressionCodec | String | Tidak | none                               | Tipe kompresi untuk Kafka. Nilai valid:<br>\- **none** (default): tanpa kompresi.<br>\- **gzip**: Gzip.<br>\- **zstd**: Zstandard.<br>\- **lz4**: LZ4.<br>\- **snappy**: Snappy.                                                                                                                                                                               |

```json
{
	"InstanceId": "waf_v2_public_cn-n*********",
	"DeliveryName": "test2",
	"DeliveryType": "kafka",
	"DeliveryDetail": "{\"kafkaTopic\":\"topictest1\",\"protocol\":\"SASL_PLAINTEXT\",\"servers\":[{\"address\":\"a.com\",\"port\":1000},{\"address\":\"ba.com\",\"port\":1000},{\"address\":\"c.com\",\"port\":1000}],\"saslUserName\":\"user123\",\"saslPassword\":\"user****\"}"
}
```.

Elemen respons

Element	Type	Description	Example
	object
DeliveryName	string	The name of the log delivery configuration.	test1
RequestId	string	The ID of the request.	26E46541-7AAB-5565-801D-F14DBDC5****

Contoh

Respons sukses

JSONformat

{
  "DeliveryName": "test1",
  "RequestId": "26E46541-7AAB-5565-801D-F14DBDC5****"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.