GetWafRule - Edge Security Acceleration - Alibaba Cloud Documentation Center

Mengambil detail aturan WAF tertentu, termasuk konfigurasi dan statusnya.

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

esa:GetWafRule

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Id	integer	Yes	ID aturan WAF. Anda dapat memperoleh ID ini dengan memanggil operasi ListWafRules.	20000001
SiteId	integer	Yes	ID situs. Anda dapat memperoleh ID ini dengan memanggil operasi ListSites.	1

Elemen respons

Element	Type	Description	Example
	object	Objek respons.
RequestId	string	ID permintaan.	36af3fcc-43d0-441c-86b1-428951dc8225
UpdateTime	string	Waktu terakhir aturan diperbarui.	2024-01-01T00:00:00Z
Id	integer	ID aturan WAF. Anda dapat memperoleh ID ini dengan memanggil operasi ListWafRules.	2000001
Position	integer	Posisi aturan dalam ruleset.	1
Name	string	Nama aturan.	example
Status	string	Status aturan.	on
Phase	string	Fase eksekusi aturan WAF. `http_whitelist`: Aturan daftar putih `http_custom`: Aturan kustom `http_managed`: Aturan terkelola `http_anti_scan`: Aturan perlindungan pemindaian `http_ratelimit`: Aturan pembatasan laju `ip_access_rule`: Aturan akses IP `http_bot`: Aturan manajemen bot `http_security_level_rule`: Aturan keamanan	http_custom
Config	WafRuleConfig	Konfigurasi aturan.
RulesetId	integer	ID ruleset WAF. Anda dapat memperoleh ID ini dengan memanggil operasi ListWafRulesets.

Contoh

Respons sukses

JSONformat

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "UpdateTime": "2024-01-01T00:00:00Z",
  "Id": 2000001,
  "Position": 1,
  "Name": "example",
  "Status": "on",
  "Phase": "http_custom",
  "Config": {
    "Status": "",
    "Action": "",
    "Actions": {
      "Response": {
        "Id": 0,
        "Code": 0
      },
      "Bypass": {
        "Skip": "",
        "RegularRules": [
          0
        ],
        "CustomRules": [
          0
        ],
        "RegularTypes": [
          ""
        ],
        "Tags": [
          ""
        ]
      }
    },
    "ManagedList": "",
    "ManagedRulesets": [
      {
        "ProtectionLevel": 0,
        "Action": "",
        "ManagedRules": [
          {
            "Status": "",
            "Action": "",
            "Id": 0
          }
        ],
        "AttackType": 0,
        "NumberTotal": 0,
        "NumberEnabled": 0
      }
    ],
    "Sigchl": [
      ""
    ],
    "Name": "",
    "AppSdk": {
      "CustomSign": {
        "Value": "",
        "Key": ""
      },
      "CustomSignStatus": "",
      "FeatureAbnormal": [
        ""
      ]
    },
    "RateLimit": {
      "Characteristics": {
        "Logic": "",
        "Criteria": [
          {
            "Logic": "",
            "Criteria": [
              {
                "Logic": "",
                "Criteria": [
                  {
                    "MatchType": "",
                    "MatchOperator": "",
                    "MatchValue": "",
                    "Negate": true,
                    "ConvertToLower": true
                  }
                ],
                "MatchType": "",
                "MatchOperator": "",
                "MatchValue": "",
                "Negate": true,
                "ConvertToLower": true
              }
            ],
            "MatchType": "",
            "MatchOperator": "",
            "MatchValue": "",
            "Negate": true,
            "ConvertToLower": true
          }
        ],
        "MatchType": "",
        "MatchOperator": "",
        "MatchValue": "",
        "Negate": true,
        "ConvertToLower": true
      },
      "OnHit": true,
      "TTL": 0,
      "Threshold": {
        "ManagedRulesBlocked": 0,
        "DistinctManagedRules": 0,
        "ResponseStatus": {
          "Ratio": 0,
          "Count": 0,
          "Code": 0
        },
        "Traffic": "",
        "Request": 0
      },
      "Interval": 0
    },
    "Type": "",
    "AppPackage": {
      "PackageSigns": [
        {
          "Sign": "",
          "Name": ""
        }
      ]
    },
    "ManagedGroupId": 0,
    "Timer": {
      "Scopes": "",
      "Zone": 0,
      "Periods": [
        {
          "Start": "",
          "End": ""
        }
      ],
      "WeeklyPeriods": [
        {
          "Days": "",
          "DailyPeriods": [
            {
              "Start": "",
              "End": ""
            }
          ]
        }
      ]
    },
    "Expression": "",
    "SecurityLevel": {
      "Value": ""
    },
    "Value": "",
    "Id": 0,
    "Notes": ""
  },
  "RulesetId": 0
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.