DescribeRuleGroups - Web Application Firewall: Central de Documentação do Alibaba Cloud

Consulta uma lista paginada de grupos de regras de expressões regulares.

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

yundun-waf:DescribeRuleGroups

get

*All Resource

*

acs:ResourceGroupId

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância do WAF. Nota Chame a operação DescribeInstance para consultar o ID da instância do WAF.	waf_cdnsdf3****
SearchType	string	Não	O tipo de consulta. Valores válidos: id: Consulta por ID do grupo de regras. name: Consulta por nome do grupo de regras. Há suporte para nomes em chinês e inglês.	name
SearchValue	string	Não	O conteúdo a ser consultado.	test
PageNumber	integer	Não	O número da página dos resultados a serem retornados. O valor padrão é 1, que retorna a primeira página de resultados.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. O valor padrão é 10.	10
RegionId	string	Não	A região onde a instância do WAF está implantada. Valores válidos: cn-hangzhou: a parte continental da China. ap-southeast-1: fora da parte continental da China.	cn-hangzhou
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
TotalCount	integer	O número total de entradas retornadas.	24
RequestId	string	O ID da solicitação.	02E9A4B8-90FB-5F41-A049-C82277EB82FB
RuleGroups	array<object>	A lista de grupos de regras de expressões regulares.
	object	A lista de grupos de regras de expressões regulares.
RuleGroupId	integer	O ID do grupo de regras.	115361
RuleTotalCount	integer	O número de regras integradas.	4444
RuleGroupName	string	O nome do grupo de regras.	ssssss
IsSubscribe	integer	O status de atualização automática do grupo de regras. 1: As atualizações automáticas estão ativadas. 2: As atualizações automáticas estão desativadas.	1
GmtModified	integer	A hora da última atualização do grupo de regras.	1664336364000
ParentRuleGroupId	integer	O ID do grupo de regras do qual o grupo de regras atual herda. 0: O grupo de regras é criado do zero e não herda de outro grupo de regras. 1011: O grupo de regras Strict. 1012: O grupo de regras Medium. 1013: O grupo de regras Loose.	1012

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 24,
  "RequestId": "02E9A4B8-90FB-5F41-A049-C82277EB82FB",
  "RuleGroups": [
    {
      "RuleGroupId": 115361,
      "RuleTotalCount": 4444,
      "RuleGroupName": "ssssss",
      "IsSubscribe": 1,
      "GmtModified": 1664336364000,
      "ParentRuleGroupId": 1012
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.