GetWafRule - Edge Security Acceleration - Centre de documentation Alibaba Cloud

Obtient les détails d'une règle unique dans Web Application Firewall (WAF). Vous pouvez utiliser cette opération pour interroger la configuration et l'état d'une règle spécifique.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

esa:GetWafRule

get

*Site

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Id	integer	Oui	L'identifiant de la règle WAF. Vous pouvez appeler l'opération ListWafRules pour obtenir cet identifiant.	20000001
SiteId	integer	Oui	L'identifiant du site. Vous pouvez appeler l'opération ListSites pour obtenir cet identifiant.	1

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	36af3fcc-43d0-441c-86b1-428951dc8225
UpdateTime	string	L'heure de la dernière modification de la règle. Format : RFC 3339 / ISO 8601, fuseau horaire UTC (se terminant par Z). Exemple : 2026-06-10T14:23:45Z	2024-01-01T00:00:00Z
Id	integer	L'identifiant de la règle WAF. Vous pouvez appeler l'opération ListWafRules pour obtenir cet identifiant.	2000001
Position	integer	La position de la règle dans l'ensemble de règles.	1
Name	string	Le nom de la règle.	exemple
Status	string	L'état de la règle.	on
Phase	string	La phase dans laquelle la règle WAF s'exécute. Valeurs valides : http_whitelist : règle de liste blanche http_custom : règle personnalisée http_managed : règle gérée http_anti_scan : règle de protection contre l'analyse http_ratelimit : règle de contrôle de fréquence ip_access_rule : règle d'accès IP http_bot : bots en mode avancé http_security_level_rule : règle de sécurité	http_custom
Config	WafRuleConfig	La configuration de la règle.
RulesetId	integer	L'identifiant de l'ensemble de règles WAF. Vous pouvez appeler l'opération ListWafRulesets pour obtenir cet identifiant.	10000001

Exemples

JSON format

{
  "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": "on",
    "Action": "deny",
    "Actions": {
      "Response": {
        "Id": 50000001,
        "Code": 403
      },
      "Bypass": {
        "Skip": "part",
        "RegularRules": [
          100001
        ],
        "CustomRules": [
          20000001
        ],
        "RegularTypes": [
          "sqli"
        ],
        "Tags": [
          "http_custom"
        ]
      }
    },
    "ManagedList": "intelligence_crawler",
    "ManagedRulesets": [
      {
        "ProtectionLevel": 4,
        "Action": "deny",
        "ManagedRules": [
          {
            "Status": "on",
            "Action": "deny",
            "Id": 100001
          }
        ],
        "AttackType": 11,
        "NumberTotal": 100,
        "NumberEnabled": 50
      }
    ],
    "Sigchl": [
      "sig"
    ],
    "Name": "example",
    "AppSdk": {
      "CustomSign": {
        "Value": "examplesignvalue",
        "Key": "sign"
      },
      "CustomSignStatus": "on",
      "FeatureAbnormal": [
        "wxbb_invalid_sign"
      ]
    },
    "RateLimit": {
      "Characteristics": {
        "Logic": "and",
        "Criteria": [
          {
            "Logic": "and",
            "Criteria": [
              {
                "Logic": "and",
                "Criteria": [
                  {
                    "MatchType": "ip.src",
                    "MatchOperator": "eq",
                    "MatchValue": "1.1.1.1",
                    "Negate": true,
                    "ConvertToLower": true
                  }
                ],
                "MatchType": "ip.src",
                "MatchOperator": "eq",
                "MatchValue": "1.1.1.1",
                "Negate": true,
                "ConvertToLower": true
              }
            ],
            "MatchType": "ip.src",
            "MatchOperator": "eq",
            "MatchValue": "1.1.1.1",
            "Negate": true,
            "ConvertToLower": true
          }
        ],
        "MatchType": "ip.src",
        "MatchOperator": "eq",
        "MatchValue": "1.1.1.1",
        "Negate": true,
        "ConvertToLower": true
      },
      "OnHit": true,
      "TTL": 10,
      "Threshold": {
        "ManagedRulesBlocked": 10,
        "DistinctManagedRules": 10,
        "ResponseStatus": {
          "Ratio": 10,
          "Count": 10,
          "Code": 404
        },
        "Traffic": "10Gb",
        "Request": 10
      },
      "Interval": 10
    },
    "Type": "http_custom",
    "AppPackage": {
      "PackageSigns": [
        {
          "Sign": "sign",
          "Name": "name"
        }
      ]
    },
    "ManagedGroupId": 30000001,
    "Timer": {
      "Scopes": "permanent",
      "Zone": 8,
      "Periods": [
        {
          "Start": "2025-01-01T00:00:00Z",
          "End": "2025-01-01T01:00:00Z"
        }
      ],
      "WeeklyPeriods": [
        {
          "Days": "1",
          "DailyPeriods": [
            {
              "Start": "00:00:00",
              "End": "01:00:00"
            }
          ]
        }
      ]
    },
    "Expression": "ip.src eq 1.1.1.1",
    "SecurityLevel": {
      "Value": "low"
    },
    "Value": "10.0.0.1",
    "Id": 20000001,
    "Notes": "example notes"
  },
  "RulesetId": 10000001
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.