ListWafRules - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Lista todas as regras ou filtra regras por condições específicas no Web Application Firewall (WAF). Você pode usar esta operação para consultar informações detalhadas sobre as regras do WAF de forma paginada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

esa:ListWafRules

list

*Site

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SiteId	integer	Sim	O ID do site. Você pode chamar a operação ListSites para obter o ID do site.	1
SiteVersion	integer	Não	O número da versão da configuração do site. Para sites com gerenciamento de versão ativado, você pode usar este parâmetro para especificar a versão do site na qual a configuração entra em vigor. O valor padrão é 0.	0
Phase	string	Sim	A fase de execução da regra do WAF. Valores válidos: http_whitelist: regra de lista de permissões http_custom: regra personalizada http_managed: regra gerenciada http_anti_scan: regra de proteção contra varredura http_ratelimit: regra de controle de frequência ip_access_rule: regra de acesso por IP http_bot: bots no modo avançado http_security_level_rule: regra de segurança	http_custom
RulesetId	integer	Não	O ID do conjunto de regras do WAF. Você pode chamar a operação ListWafRulesets para obter o ID do conjunto de regras.	10000001
QueryArgs	object	Não	As condições de filtro da consulta.	http_custom
Id	integer	Não	O ID da regra do WAF para correspondência exata.	20000001
NameLike	string	Não	O nome da regra do WAF para correspondência aproximada.	example
IdNameLike	string	Não	O ID ou nome da regra do WAF para correspondência aproximada.	example
Status	string	Não	O status da regra do WAF para correspondência exata.	on
ConfigValueLike	string	Não	O valor no controle de acesso por IP para correspondência aproximada.	10.0.0.1
OrderBy	string	Não	Ordena a lista retornada por uma coluna especificada.	position
Desc	boolean	Não	Especifica se a ordem de classificação deve ser invertida.	true
PageNumber	integer	Não	O número da página para paginação.	1
PageSize	integer	Não	O tamanho da página para paginação.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	36af3fcc-43d0-441c-86b1-428951dc8225
SiteUsage	integer	O uso do site.	5
InstanceUsage	integer	O número de regras usadas na fase do WAF para a instância associada ao site.	10
TotalCount	integer	O número total de regras após a filtragem.	20
Rules	array<object>	A lista de regras retornada.
	object	Os detalhes da regra.
UpdateTime	string	A hora da última modificação da regra. Formato: RFC 3339 / ISO 8601, fuso horário UTC (terminando com Z). Exemplo: 2026-06-10T14:23:45Z	2024-01-01T00:00:00Z
RulesetId	integer	O ID do conjunto de regras.	10000001
Id	integer	O ID da regra.	20000001
Position	integer	A posição da regra no conjunto de regras correspondente.	1
Phase	string	A fase de execução da regra do WAF. Valores válidos: http_whitelist: regra de lista de permissões http_custom: regra personalizada http_managed: regra gerenciada http_anti_scan: regra de proteção contra varredura http_ratelimit: regra de controle de frequência ip_access_rule: regra de acesso por IP http_bot: bots no modo avançado http_security_level_rule: regra de segurança	http_custom
Type	string	O tipo da regra.	http_custom
Name	string	O nome da regra.	example
Status	string	O status da regra.	on
Fields	array	A lista de campos de correspondência da regra.
	string	O valor do campo de correspondência da regra.	ip.geoip.asnum
CharacteristicsFields	array	A lista de objetos estatísticos para regras de controle de frequência.
	string	O objeto estatístico para regras de controle de frequência.	ip.src
Action	string	A ação associada à regra. Valores válidos: deny: Bloquear. monitor: Monitorar. js: Desafio JavaScript. captcha: Desafio de controle deslizante.	deny
Skip	string	A propriedade de salto para regras de lista de permissões.	part
Tags	array	A lista de fases do WAF a serem ignoradas para regras de lista de permissões.
	string	O valor da fase do WAF a ser ignorado para regras de lista de permissões.	http_custom
Timer	WafTimer	A configuração do período de vigência da regra.
Config	WafRuleConfig	A configuração da regra.
PageNumber	integer	O número da página.	1
PageSize	integer	O tamanho da página.	20

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "SiteUsage": 5,
  "InstanceUsage": 10,
  "TotalCount": 20,
  "Rules": [
    {
      "UpdateTime": "2024-01-01T00:00:00Z",
      "RulesetId": 10000001,
      "Id": 20000001,
      "Position": 1,
      "Phase": "http_custom",
      "Type": "http_custom",
      "Name": "example",
      "Status": "on",
      "Fields": [
        "ip.geoip.asnum"
      ],
      "CharacteristicsFields": [
        "ip.src"
      ],
      "Action": "deny",
      "Skip": "part",
      "Tags": [
        "http_custom"
      ],
      "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"
              }
            ]
          }
        ]
      },
      "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": false,
                        "ConvertToLower": false
                      }
                    ],
                    "MatchType": "ip.src",
                    "MatchOperator": "eq",
                    "MatchValue": "1.1.1.1",
                    "Negate": false,
                    "ConvertToLower": false
                  }
                ],
                "MatchType": "ip.src",
                "MatchOperator": "eq",
                "MatchValue": "1.1.1.1",
                "Negate": false,
                "ConvertToLower": false
              }
            ],
            "MatchType": "ip.src",
            "MatchOperator": "eq",
            "MatchValue": "1.1.1.1",
            "Negate": false,
            "ConvertToLower": false
          },
          "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 10.0.0.1",
        "SecurityLevel": {
          "Value": "low"
        },
        "Value": "10.0.0.1",
        "Id": 20000001,
        "Notes": "example notes"
      }
    }
  ],
  "PageNumber": 1,
  "PageSize": 20
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	The specified parameter is invalid.	Falha na validação do formato do parâmetro de entrada.
400	InternalException	Failed to call the service. Try again later or contact technical support.	A chamada do serviço falhou. Tente novamente mais tarde ou entre em contato com o suporte ao cliente para obter detalhes.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.