Kueri kebijakan mitigasi WAF dengan menggunakan DescribeDcdnWafPolicies - Edge Security Acceleration

Mengambil detail kebijakan mitigasi Web Application Firewall (WAF) yang telah dikonfigurasi.

Deskripsi operasi

Catatan

Satu pengguna dapat melakukan hingga 20 panggilan per detik.

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

dcdn:DescribeDcdnWafPolicies

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
QueryArgs	string	No	Kueri kondisional, berupa string yang diserialisasi dalam format JSON. Formatnya sebagai berikut: `QueryArgs={"PolicyIds":"ID kebijakan mitigasi","RuleIds":"rentang ID aturan mitigasi","PolicyNameLike":"nama kebijakan mitigasi","DomainNames":"Nama domain yang dilindungi","PolicyType":"default","DefenseScenes":"waf_group","PolicyStatus":"on","OrderBy":"GmtModified","Desc":"false"}` Catatan Jika parameter ini tidak ditentukan, semua kebijakan mitigasi akan diambil.	{"PolicyNameLIike":"test_policy"}
PageNumber	integer	No	Nomor halaman. Nilai default: 1. Nilai yang valid: 1 hingga 100000.	1
PageSize	integer	No	Jumlah kebijakan mitigasi yang ditampilkan per halaman. Nilai default: 20. Nilai yang valid: bilangan bulat dari 1 hingga 500.	20

Parameter QueryArgs

Name	Type	Required	Example	Description
PolicyIds	string	No	10000001,10000002	Daftar ID kebijakan mitigasi. Ini adalah kueri tepat. Pisahkan beberapa ID dengan koma (,).
RuleIds	string	No	20000001,20000055	Daftar ID aturan. Ini adalah kueri tepat. Pisahkan beberapa ID dengan koma (,).
PolicyNameLike	string	No	policy_test	Nama kebijakan mitigasi. Ini adalah kueri fuzzy. Nama dapat berisi karakter Tionghoa, huruf (case-sensitive), angka (0 hingga 9), dan garis bawah (_).
DomainNames	string	No	example.com	Daftar Nama domain yang dilindungi. Ini adalah kueri tepat. Anda dapat menentukan hingga 50 Nama domain. Pisahkan beberapa Nama domain dengan koma (,).
PolicyType	string	No	default	Menentukan apakah kebijakan tersebut merupakan kebijakan mitigasi default. Nilai yang valid: `default`: kebijakan mitigasi default. `custom`: kebijakan mitigasi kustom.
DefenseScenes	string	No	custom_acl	Skenario mitigasi. Ini adalah kueri tepat. Pisahkan beberapa skenario dengan koma (,). Skenario yang didukung: `waf_group`: perlindungan web dasar. `custom_acl`: kebijakan mitigasi kustom. `whitelist`: daftar putih.
PolicyStatus	string	No	on	Status kebijakan. Nilai yang valid: `on`: diaktifkan. `off`: dinonaktifkan.
OrderBy	string	No	GmtModified	Bidang yang digunakan untuk mengurutkan hasil. Nilai yang valid: `GmtModified`, `PolicyId`, `PolicyName`, dan `PolicyStatus`.
Desc	Boolean	No	false	Urutan pengurutan. Nilai yang valid: `true`: descending. `false` (default): ascending.

Elemen respons

Element	Type	Description	Example
	object
PageSize	integer	Jumlah kebijakan mitigasi yang ditampilkan per halaman. Nilai default: 20. Nilai yang valid: bilangan bulat dari 1 hingga 500.	20
RequestId	string	ID permintaan.	153ca2cd-3c01-44be-2e83-64dbc6c88630
PageNumber	integer	Nomor halaman. Nilai yang valid: 1 hingga 100000. Nilai default: 1.	1
TotalCount	integer	Total jumlah kebijakan mitigasi.	15
Policies	array<object>	Daftar kebijakan mitigasi.
	object
PolicyStatus	string	Status kebijakan mitigasi. Nilainya sama dengan bidang `PolicyStatus` pada parameter permintaan `QueryArgs`.	on
DefenseScene	string	Skenario mitigasi. Nilainya sama dengan bidang `DefenseScenes` pada parameter permintaan `QueryArgs`.	custom_acl
DomainCount	integer	Jumlah Nama domain yang menggunakan kebijakan mitigasi tersebut.	22
PolicyName	string	Nama kebijakan mitigasi.	policy_test
PolicyId	integer	ID kebijakan mitigasi.	100001
RuleCount	integer	Jumlah aturan dalam kebijakan mitigasi.	9
GmtModified	string	Waktu terakhir kebijakan dimodifikasi. Waktu dalam standar ISO 8601 dengan format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2021-12-29T17:08:45Z
PolicyType	string	Menunjukkan apakah kebijakan tersebut merupakan kebijakan mitigasi default. Nilainya sama dengan bidang `PolicyType` pada parameter permintaan `QueryArgs`.	default

Contoh

Respons sukses

JSONformat

{
  "PageSize": 20,
  "RequestId": "153ca2cd-3c01-44be-2e83-64dbc6c88630",
  "PageNumber": 1,
  "TotalCount": 15,
  "Policies": [
    {
      "PolicyStatus": "on",
      "DefenseScene": "custom_acl",
      "DomainCount": 22,
      "PolicyName": "policy_test",
      "PolicyId": 100001,
      "RuleCount": 9,
      "GmtModified": "2021-12-29T17:08:45Z",
      "PolicyType": "default"
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.