Referensi DescribeResourceLogFieldConfig API - Web Application Firewall - Alibaba Cloud - Web Application Firewall

Mengkueri konfigurasi field log untuk objek yang dilindungi.

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

get

*All Resource

*

acs:ResourceGroupId

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID Instans Web Application Firewall (WAF). Catatan Panggil operasi DescribeInstance untuk mengkueri ID Instans WAF.	waf_v3prepaid_public_cn-zpr3*******
DeliveryType	string	Yes	Tipe Pengiriman log. Nilai valid: sls: Simple Log Service. kafka: Kafka. syslog: Syslog.	sls
ResourceManagerResourceGroupId	string	No	ID kelompok sumber daya tempat Instans WAF berada.	rg-acfm***q
RegionId	string	No	Wilayah tempat Instans WAF berada. Nilai valid: ap-southeast-1: Tiongkok daratan. ap-southeast-1: di luar Tiongkok daratan.	cn-hangzhou
Resource	string	Yes	Objek yang dilindungi yang konfigurasi field log-nya ingin Anda kueri.	test.waf.com-waf

Elemen respons

Element	Type	Description	Example
	object
AddList	string	The extra log fields that are configured in addition to the default log fields. The fields are specified as a string of comma-separated values.	acl_test,acl_action,acl_rule_id,waf_test,acl_rule_type
RequestId	string	The request ID.	7B53B47C-D368-5344-BB5E-79******
LogDeliveryStrategy	string	The log delivery policies. Multiple policies are supported. The value is a string that is converted from a JSON array of parameters. Catatan For more information about the parameters, see the description of the LogDeliveryStrategy parameter in ModifyResourceLogFieldConfig.	[{\"logType\":\"blockLog\",\"rate\":100},{\"logType\":\"normalRequestLog\",\"rate\":100},{\"logType\":\"checkLog\",\"rate\":100}]
ExtendConfig	string	The extended configuration for log delivery. The value is a string that is converted from a JSON object of parameters. Catatan For more information about the parameters, see the description of the ExtendConfig parameter in ModifyResourceLogFieldConfig.	{\"request_header\":\"Ali-Cdn-Real-Ip\"}
DelList	string	The log fields that are removed from the default log fields. The fields are specified as a string of comma-separated values.	waf_rule_id,waf_rule_type
FieldList	string	The list of delivered log fields. The fields are specified as a string of comma-separated values.	account,acl_action,acl_rule_id,acl_rule_type,acl_test,antiscan_action,antiscan_rule_id,antiscan_rule_type,antiscan_test,body_bytes_sent,bypass_matched_ids
DeliveryType	string	The log delivery type. Valid values: sls: Simple Log Service. kafka: Kafka. syslog: Syslog.	sls

Contoh

Respons sukses

JSONformat

{
  "AddList": "acl_test,acl_action,acl_rule_id,waf_test,acl_rule_type",
  "RequestId": "7B53B47C-D368-5344-BB5E-79******",
  "LogDeliveryStrategy": "[{\\\"logType\\\":\\\"blockLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"normalRequestLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"checkLog\\\",\\\"rate\\\":100}]",
  "ExtendConfig": "{\\\"request_header\\\":\\\"Ali-Cdn-Real-Ip\\\"}",
  "DelList": "waf_rule_id,waf_rule_type",
  "FieldList": "account,acl_action,acl_rule_id,acl_rule_type,acl_test,antiscan_action,antiscan_rule_id,antiscan_rule_type,antiscan_test,body_bytes_sent,bypass_matched_ids",
  "DeliveryType": "sls"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.