Kueri kebijakan mitigasi WAF dengan menggunakan DescribeDcdnWafPolicies - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Mengkueri kebijakan mitigasi Web Application Firewall (WAF) yang dikonfigurasi.

Deskripsi operasi

Catatan

A single user can make up to 20 calls per second.

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 bersyarat, yang merupakan string yang di-serialisasi JSON. Formatnya adalah 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 dikueri.	{"PolicyNameLIike":"test_policy"}
PageNumber	integer	No	Nomor halaman. Nilai default: 1. Nilai valid: 1 hingga 100000.	1
PageSize	integer	No	Jumlah kebijakan mitigasi yang ditampilkan di setiap halaman. Nilai default: 20. Nilai valid: bilangan bulat dari 1 hingga 500.	20

Parameter QueryArgs.

Nama	Tipe	Wajib	Contoh	Deskripsi
PolicyIds	string	Tidak	10000001,10000002	Daftar ID kebijakan mitigasi. Ini adalah kueri term. Pisahkan beberapa ID dengan koma (,).
RuleIds	string	Tidak	20000001,20000055	Daftar ID aturan. Ini adalah kueri term. Pisahkan beberapa ID dengan koma (,).
PolicyNameLike	string	Tidak	policy_test	Nama Kebijakan mitigasi. Ini adalah kueri fuzzy. Nama dapat berisi karakter Tionghoa, huruf (peka huruf besar/kecil), digit (0 hingga 9), dan garis bawah (_).
DomainNames	string	Tidak	example.com	Daftar Nama domain yang dilindungi. Ini adalah kueri term. Anda dapat menentukan hingga 50 Nama domain. Pisahkan beberapa Nama domain dengan koma (,).
PolicyType	string	Tidak	default	Apakah Kebijakan tersebut merupakan kebijakan mitigasi default. Nilai valid: `default`: kebijakan mitigasi default. `custom`: kebijakan mitigasi kustom.
DefenseScenes	string	Tidak	custom_acl	Skenario mitigasi. Ini adalah kueri term. Pisahkan beberapa skenario dengan koma (,). Skenario berikut didukung: `waf_group`: perlindungan web dasar. `custom_acl`: kebijakan mitigasi kustom. `whitelist`: whitelist.
PolicyStatus	string	Tidak	on	Status Kebijakan. Nilai valid: `on`: diaktifkan. `off`: dinonaktifkan.
OrderBy	string	Tidak	GmtModified	Bidang yang digunakan untuk mengurutkan hasil. Nilai valid: `GmtModified`, `PolicyId`, `PolicyName`, dan `PolicyStatus`.
Desc	Boolean	Tidak	false	Urutan pengurutan. Nilai valid: `true`: menurun. `false` (default): menaik.

Elemen respons

Element	Type	Description	Example
	object
PageSize	integer	The number of mitigation policies displayed on each page. Default value: 20. Valid values: an integer from 1 to 500.	20
RequestId	string	The request ID.	153ca2cd-3c01-44be-2e83-64dbc6c88630
PageNumber	integer	The page number. Valid values: 1 to 100000. Default value: 1.	1
TotalCount	integer	The total number of mitigation policies.	15
Policies	array<object>	The list of mitigation policies.
	object
PolicyStatus	string	The status of the mitigation policy. The value is the same as the `PolicyStatus` field in the `QueryArgs` request parameter.	on
DefenseScene	string	The mitigation scenario. The value is the same as the `DefenseScenes` field in the `QueryArgs` request parameter.	custom_acl
DomainCount	integer	The number of domain names that use the mitigation policy.	22
PolicyName	string	The name of the mitigation policy.	policy_test
PolicyId	integer	The ID of the mitigation policy.	100001
RuleCount	integer	The number of rules in the mitigation policy.	9
GmtModified	string	The time when the policy was last modified. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-12-29T17:08:45Z
PolicyType	string	Indicates whether the policy is a default mitigation policy. The value is the same as the `PolicyType` field in the `QueryArgs` request parameter.	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.