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

Obtém os conjuntos de regras WAF para uma instância especificada, permitindo filtragem por fase, nome e outros critérios.

Descrição da operação

Solicitação

InstanceId é um parâmetro obrigatório que especifica a instância WAF a ser consultada.
O parâmetro Phase filtra os conjuntos de regras por fase de processamento do WAF, como regras personalizadas e regras de limitação de taxa.
Use NameLike em QueryArgs para realizar uma pesquisa difusa nos nomes dos conjuntos de regras.
Os parâmetros PageNumber e PageSize controlam a paginação e têm como valor padrão 1 e 20, respectivamente.
A resposta inclui o ID da solicitação, o uso atual do plano, a contagem total de registros e uma lista de detalhes dos conjuntos de regras.

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

none

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	esa-xxxxxxx
Phase	string	Não	Especifica a fase de execução da regra WAF. `http_whitelist`: regra de lista branca `http_custom`: regra personalizada `http_managed`: regra gerenciada `http_anti_scan`: regra anti-varredura `http_ratelimit`: regra de limitação de taxa `ip_access_rule`: regra de acesso por IP `http_bot`: bot em modo avançado `http_security_level_rule`: regra de segurança	http_custom
QueryArgs	object	Não	Parâmetros para filtragem e ordenação dos resultados.
NameLike	string	Não	Uma string para pesquisa difusa de nomes de conjuntos de regras.	example
OrderBy	string	Não	O campo pelo 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 a ser retornada.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema de resposta.
RequestId	string	O ID da solicitação.	36af3fcc-43d0-441c-86b1-428951dc8225
InstanceUsage	integer	O uso da instância.	10
TotalCount	integer	O número total de registros após a filtragem.	5
Rulesets	array<object>	Uma lista de objetos de conjunto de regras WAF.
	object	Um objeto de conjunto de regras WAF.
Id	integer	O ID do conjunto de regras WAF.	10000001
Position	integer	A posição do conjunto de regras WAF.	1
Phase	string	A fase de execução da regra WAF. Valores possíveis: `http_whitelist`: regra de lista branca `http_custom`: regra personalizada `http_managed`: regra gerenciada `http_anti_scan`: regra de proteção contra varredura `http_ratelimit`: regra de limitação de taxa `ip_access_rule`: regra de acesso por IP `http_bot`: regra de bot `http_security_level_rule`: regra de segurança	http_custom
Name	string	O nome do conjunto de regras WAF.	example
Description	string	A descrição do conjunto de regras WAF.	example
Status	string	O status do conjunto de regras WAF.	on
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas retornadas por página.	20

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "InstanceUsage": 10,
  "TotalCount": 5,
  "Rulesets": [
    {
      "Id": 10000001,
      "Position": 1,
      "Phase": "http_custom",
      "Name": "example",
      "Description": "example",
      "Status": "on"
    }
  ],
  "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.	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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.