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

Lista os conjuntos de regras na fase de execução atual do WAF. Consulta informações básicas e o status dos conjuntos de regras com suporte a paginação.

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:ListWafRulesets

get

*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 o gerenciamento de versão de configuração ativado, você pode usar este parâmetro para especificar a versão do site para a qual a configuração entra em vigor. Valor padrão: 0.	0
Phase	string	Sim	A fase de execução de regras do WAF. Valores válidos: http_whitelist: regras de lista de permissões http_custom: regras personalizadas http_managed: regras gerenciadas http_anti_scan: regras de proteção contra varredura http_ratelimit: regras de controle de frequência ip_access_rule: regras de acesso por IP http_bot: bots no modo avançado http_security_level_rule: regras de segurança	http_bot
QueryArgs	object	Não	Os parâmetros de consulta, passados no formato JSON, incluindo várias condições de filtro.	http_bot
NameLike	string	Não	A string de correspondência aproximada para o nome do conjunto de regras.	example
AnyLike	string	Não	A string de correspondência aproximada para o ID do conjunto de regras, o nome do conjunto de regras, o ID da regra ou o nome da regra.	example
OrderBy	string	Não	A coluna pela qual ordenar os resultados.	id
Desc	boolean	Não	Especifica se os resultados devem ser ordenados em ordem decrescente.
PageNumber	integer	Não	O número da página. Especifica o número da página atual para consultas paginadas.	1
PageSize	integer	Não	O tamanho da página. Especifica o número de registros por página para consultas paginadas.	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 número de conjuntos de regras do WAF usados pelo site nesta fase de execução do WAF.	5
InstanceUsage	integer	O número de conjuntos de regras do WAF usados pela instância nesta fase de execução do WAF.	10
TotalCount	integer	O número total de registros após a filtragem.	5
Rulesets	array<object>	A lista de conjuntos de regras, incluindo informações detalhadas sobre cada conjunto de regras.
	object	As informações do conjunto de regras.
UpdateTime	string	A hora da última modificação do conjunto de regras. Formato: RFC 3339 / ISO 8601, fuso horário UTC (terminando com Z). Exemplo: 2026-06-10T14:23:45Z	2024-01-01T00:00:00Z
Id	integer	O ID do conjunto de regras do WAF. Você pode chamar a operação ListWafRulesets para obter o ID do conjunto de regras.	10000001
Name	string	O nome do conjunto de regras.	example
Status	string	O status do conjunto de regras.	on
Phase	string	A fase de execução de regras do WAF. Valores válidos: http_whitelist: regras de lista de permissões http_custom: regras personalizadas http_managed: regras gerenciadas http_anti_scan: regras de proteção contra varredura http_ratelimit: regras de controle de frequência ip_access_rule: regras de acesso por IP http_bot: bots no modo avançado http_security_level_rule: regras de segurança	http_bot
Types	array	A lista de tipos de regra.
	string	O tipo de regra.	http_custom_cc
Target	string	O tipo de alvo de proteção em http_bot.	web
Fields	array	A lista de objetos de correspondência.
	string	O objeto de correspondência.	http.request.headers
PageNumber	integer	O número da página atual.	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": 5,
  "Rulesets": [
    {
      "UpdateTime": "2024-01-01T00:00:00Z",
      "Id": 10000001,
      "Name": "example",
      "Status": "on",
      "Phase": "http_bot",
      "Types": [
        "http_custom_cc"
      ],
      "Target": "web",
      "Fields": [
        "http.request.headers"
      ]
    }
  ],
  "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.