Mengkueri daftar aturan perlindungan secara berpaginasi.

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

list

*全部资源

*

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_cdnsdf3****
RuleType	string	No	Tipe aturan perlindungan. Nilai valid: whitelist: aturan daftar putih defense (default): aturan perlindungan Catatan Parameter ini diperlukan hanya ketika DefenseType diatur ke template.	whitelist
Query	string	No	Kondisi kueri. Tentukan parameter ini sebagai string JSON. Catatan Hasil kueri untuk aturan perlindungan bervariasi berdasarkan kondisi kueri. Untuk informasi lebih lanjut, lihat Detail parameter kueri.	{\"name\":\"IPblock_20220822_10\",\"scene\":\"custom_acl\",\"templateId\":5327}
PageNumber	integer	No	Nomor halaman yang akan dikembalikan. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang akan dikembalikan pada setiap halaman. Nilai default: 10.	10
DefenseType	string	No	Tipe aturan perlindungan. Nilai valid: template (default): aturan Template perlindungan. resource: aturan untuk objek yang dilindungi. global: aturan global. Valid values: template : template. resource : Sumber daya. global : global.	template
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 parameter kueri.

Aturan perlindungan template (template)

Jika Anda mengatur DefenseType ke template, parameter berikut tersedia.

Deskripsi parameter

Nama	Tipe	Wajib	Contoh	Deskripsi
name	String	Tidak	test	Nama aturan perlindungan yang akan dikueri. Anda dapat mengatur parameter ini untuk melakukan kueri term pada aturan perlindungan.
nameId	String	Tidak	test1	ID atau nama aturan perlindungan yang akan dikueri. Anda dapat mengatur parameter ini untuk melakukan kueri fuzzy pada aturan perlindungan.
nameLike	String	Tidak	test.aliyundoc.c	Nama aturan perlindungan yang akan dikueri. Anda dapat mengatur parameter ini untuk melakukan kueri fuzzy pada aturan perlindungan.
scene	String	Tidak	waf_group	Skenario perlindungan yang ingin dikueri. Anda dapat mengatur parameter ini untuk melakukan kueri term pada aturan perlindungan dalam skenario tertentu. Nilai valid: - waf_group: aturan ekspresi reguler untuk perlindungan dasar. - waf_base: aturan untuk fitur perlindungan inti web baru. - waf_base_compliance: aturan kepatuhan protokol untuk perlindungan dasar. - waf_base_sema: aturan semantik untuk perlindungan dasar. - cc: perlindungan HTTP flood. - antiscan_dirscan: pemblokiran penelusuran direktori untuk perlindungan Pemindaian. - antiscan_highfreq: pemblokiran Pemindaian Frekuensi tinggi untuk perlindungan Pemindaian. - antiscan_scantools: pemblokiran Pemindai untuk perlindungan Pemindaian. - ip_blacklist: daftar blacklist alamat IP. - custom_acl: aturan kustom. - region_block: pemblokiran geografis. - tamperproof: perlindungan perubahan halaman web. - dlp: pencegahan kebocoran data. - custom_response_block: tanggapan kustom.
ruleId	Long	Tidak	33444	ID aturan perlindungan yang akan dikueri. Anda dapat mengatur parameter ini untuk melakukan kueri term pada aturan perlindungan.
ruleIdIn	Array	Tidak	[3334455643,345555]	Rentang ID aturan perlindungan yang akan dikueri. Anda dapat mengatur parameter ini untuk mengkueri beberapa aturan perlindungan. Pisahkan beberapa ID aturan dengan koma (,).
templateId	Long	Tidak	24354	ID Template perlindungan yang akan dikueri. Anda dapat mengatur parameter ini untuk mengkueri aturan perlindungan dalam Template perlindungan.
orderBy	String	Tidak	name	Metode pengurutan untuk aturan perlindungan. Nilai valid: - name: mengurutkan aturan berdasarkan nama. - gmtModified: mengurutkan aturan berdasarkan waktu modifikasi. - id: mengurutkan aturan berdasarkan ID. - templateId: mengurutkan aturan berdasarkan ID template.
desc	Boolean	Tidak	true	Urutan pengurutan. Nilai valid: - false: urutan naik. - true: urutan turun.

Contoh

{
    "name": "test",
    "nameId ": "test1,
    "nameLike": "test.aliyundoc.c",
    "nameIn": "test.aliyundoc.c",
    "InstaneId": "test1.aliyundoc.com,test2.aliyundoc.com",
    "templateId": 24354
}
```.

## Aturan untuk objek yang dilindungi (**resource**)

Jika Anda mengatur **DefenseType** ke **resource**, parameter berikut tersedia.

#### Deskripsi parameter

| Nama     | Tipe   | Wajib | Contoh      | Deskripsi                                                                                                                                                                                                                                                                        |
| -------- | ------ | ----- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| resource | String | Tidak | sec****-waf | Objek yang dilindungi tempat aturan diterapkan.                                                                                                                                                                                                                                  |
| scene    | String | Tidak | waf_group   | Skenario perlindungan yang ingin dikueri. Anda dapat mengatur parameter ini untuk melakukan kueri term pada aturan perlindungan dalam skenario tertentu. Nilai valid:<br>\- **account_identifier**: aturan pengambilan akun.<br>\- **custom_response**: tanggapan kustom baru. |

#### Contoh

```json
{
    "resource": "sec****-waf",
    "scene ": "account_identifier"
}

Aturan global (global)

Jika Anda mengatur DefenseType ke global, parameter berikut tersedia.

Deskripsi parameter

Nama	Tipe	Wajib	Contoh	Deskripsi
scene	String	Tidak	regular_custom	Skenario perlindungan yang ingin dikueri. Anda dapat mengatur parameter ini untuk melakukan kueri term pada aturan perlindungan dalam skenario tertentu. Nilai valid: - regular_custom: aturan ekspresi reguler kustom. - custom_response: tanggapan kustom baru.
detectType	String	Tidak	sqli	Modul deteksi yang akan dikueri. Nilai valid: - sqli: injeksi SQL. - xss: cross-site scripting (XSS). - cmdi: injeksi perintah OS. - expression_injection: injeksi ekspresi. - java_deserialization: deserialisasi Java. - dot_net_deserialization: deserialisasi .NET. - php_deserialization: deserialisasi PHP. - code_exec: eksekusi kode. - ssrf: server-side request forgery (SSRF). - path_traversal: penelusuran path. - arbitrary_file_uploading: unggah file arbitrer. - webshell: webshell. - rfilei: remote file inclusion (RFI). - lfilei: local file inclusion (LFI). - protocol_violation: pelanggaran protokol. - scanner_behavior: perilaku Pemindai. - logic_flaw: bug logika bisnis. - arbitrary_file_reading: baca file arbitrer. - arbitrary_file_download: unduh file arbitrer. - xxe: injeksi entitas eksternal. - csrf: cross-site request forgery. - crlf: CRLF. - other: lainnya. Penting Parameter ini didukung hanya ketika scene diatur ke regular_custom.
riskLevel	String	Tidak	strict	Tingkat ancaman yang akan dikueri. Nilai valid: - super_strict: Sangat Ketat. - strict: Ketat. - medium: Sedang. - loose: Longgar. Penting Parameter ini didukung hanya ketika scene diatur ke regular_custom.
templateId	Long	Tidak	24354	ID Template perlindungan yang akan dikueri. Anda dapat mengatur parameter ini untuk mengkueri aturan perlindungan dalam Template perlindungan. Penting Parameter ini didukung hanya ketika scene diatur ke regular_custom.

Contoh

{
    "detectType": "sqli",
    "riskLevel ": "strict",
    "templateId": 24354
}
```.

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of returned entries.	2
RequestId	string	The request ID.	80736FA5-FA87-55F6-AA69-C5477C6FE6D0
Rules	array<object>	The list of protection rules.
	object	The protection rule.
Status	integer	The status of the protection rule. Valid values: 0: disabled. 1: enabled.	1
DefenseOrigin	string	The source of the protection rule. Valid values: custom: The rule is created by the user. system: The rule is automatically generated by the system.	custom
Config	string	The details of the protection rule. The value is a JSON string. For more information, see the description of the Rule parameter in CreateDefenseRule.	{\"policyId\":1012,\"action\":\"block\"}
RuleId	integer	The ID of the protection rule.	42755
DefenseScene	string	The protection scenario. If the DefenseType request parameter is set to template, the valid values are: waf_group: regular expression rules for basic protection. waf_base: rules for the new web core protection feature. waf_base_compliance: protocol compliance rules for basic protection. waf_base_sema: semantic rules for basic protection. cc: HTTP flood protection. antiscan_dirscan: directory traversal blocking for scan protection. antiscan_highfreq: high-frequency scan blocking for scan protection. antiscan_scantools: scanner blocking for scan protection. ip_blacklist: IP address blacklist. custom_acl: custom rules. region_block: Geo-blocking. tamperproof: webpage tamper protection. dlp: data leakage prevention. custom_response_block: custom response. spike_throttle: peak traffic throttling. If the DefenseType request parameter is set to resource, the valid values are: account_identifier: account fetch. custom_response: new custom response. waf_codec: decoding. If the DefenseType request parameter is set to global, the valid values are: regular_custom: custom regular expression. address_book: address book. custom_response: new custom response.	waf_group
GmtModified	integer	The time when the protection rule was last modified. This value is a UNIX timestamp. Unit: milliseconds.	1665460629000
RuleName	string	The name of the protection rule.	rules_41
TemplateId	integer	The ID of the protection template.	5673
GmtCreate	integer	The time when the protection rule was created. This value is a UNIX timestamp. Unit: milliseconds.	1665460629000
Resource	string	The protected object to which the rule is applied. Catatan This parameter is returned only when the DefenseType request parameter is set to resource.	rencs***-waf
DefenseType	string	The type of the protection rule. Valid values: template (default): template protection rules. resource: rules for protected objects. global: global rules.	template
Description `deprecated`	string	This parameter is deprecated.	rule description
RuleType `deprecated`	string	This parameter is deprecated.	custom_cc
ActionExternal `deprecated`	string	This parameter is deprecated.	42755
DetailRuleIds `deprecated`	string	This parameter is deprecated.	42755
ExternalInfo `deprecated`	string	This parameter is deprecated.	{\"DetectType\":\"sqli\"}

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 2,
  "RequestId": "80736FA5-FA87-55F6-AA69-C5477C6FE6D0",
  "Rules": [
    {
      "Status": 1,
      "DefenseOrigin": "custom",
      "Config": "{\\\"policyId\\\":1012,\\\"action\\\":\\\"block\\\"}",
      "RuleId": 42755,
      "DefenseScene": "waf_group",
      "GmtModified": 1665460629000,
      "RuleName": "rules_41",
      "TemplateId": 5673,
      "GmtCreate": 1665460629000,
      "Resource": "rencs***-waf",
      "DefenseType": "template",
      "Description": "rule description",
      "RuleType": "custom_cc",
      "ActionExternal": "42755",
      "DetailRuleIds": "42755",
      "ExternalInfo": "{\\\"DetectType\\\":\\\"sqli\\\"}"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.