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

Consulta as regras de configuração para políticas de segurança de API.

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

get

*Todos os recursos.

*

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 Você pode chamar a operação DescribeInstance para consultar o ID da instância atual do WAF.	waf_elasticity-cn-0x***
Type	string	Sim	O tipo de regra. Valores válidos: risk: Detecção de riscos. event: Eventos de segurança. sensitive_word: Dados sensíveis. auth_flag: Credenciais de autenticação. api_tag: Propósito de negócios. desensitization: Mascaramento de dados. whitelist: Lista de permissões. recognition: Identificação de API. offline_api: Gerenciamento de ciclo de vida.	risk
Level	string	Não	O nível da regra. Para detecção de riscos (risk) e eventos de segurança (event), valores válidos: high: Alto risco. medium: Risco médio. low: Baixo risco. Para dados sensíveis (sensitive_word), valores válidos: S1: Nível S1. S2: Nível S2. S3: Nível S3. S4: Nível S4.	high
Name	string	Não	O nome da regra.	information leakage
Origin	string	Não	A origem da regra. Valores válidos: custom: Personalizado. default: Integrado.	custom
Status	integer	Não	O status de ativação da regra. Valores válidos: 1: Ativado. 0: Desativado.	1
PageNumber	integer	Não	O número da página a ser retornado em uma consulta paginada. Valor padrão: 1, que indica a primeira página da paginação.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página em uma consulta paginada. Valor padrão: 10, que indica 10 entradas por paginação.	10
RegionId	string	Não	A região onde a instância do WAF está localizada. Valores válidos: cn-hangzhou: China continental. ap-southeast-1: fora da China continental.	cn-hangzhou
ResourceManagerResourceGroupId	string	Não	O ID do grupo de recursos do Alibaba Cloud.	rg-acfm***q
Lang	string	Não	O idioma das regras retornadas. Valores válidos: zh (padrão): Chinês. en: Inglês.	zh

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado da solicitação.
Data	array<object>	A lista de regras.
	object	As informações da regra.
Id	integer	O ID da regra.	34933
Rule	string	Os detalhes da regra, formatados como uma string JSON construída a partir de uma série de parâmetros.	{ "ext": "Date", "regex": "-", "code": "2009", "level": "S1", "origin": "default", "name": "2009" }
Status	integer	O status da regra. Valores válidos: 1: Ativado. 0: Desativado.	1
Type	string	O tipo de regra. Valores válidos: risk: Detecção de riscos. event: Eventos de segurança. sensitive_word: Dados sensíveis. auth_flag: Credenciais de autenticação. api_tag: Propósito de negócios. desensitization: Mascaramento de dados. whitelist: Lista de permissões. recognition: Identificação de API. offline_api: Gerenciamento de ciclo de vida.	risk
UpdateTime	integer	A hora de atualização da regra. A hora é um carimbo de data e hora UNIX em UTC. Unidade: segundos.	1721095301
RequestId	string	O ID da solicitação.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
TotalCount	integer	O número total de entradas retornadas.	6

Exemplos

Resposta de sucesso

JSON formato

{
  "Data": [
    {
      "Id": 34933,
      "Rule": "{\n    \"ext\": \"Date\",\n    \"regex\": \"-\",\n    \"code\": \"2009\",\n    \"level\": \"S1\",\n    \"origin\": \"default\",\n    \"name\": \"2009\"\n}\n",
      "Status": 1,
      "Type": "risk",
      "UpdateTime": 1721095301
    }
  ],
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "TotalCount": 6
}

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.