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

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

list

*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 DescribeInstance para consultar o ID da instância do WAF.	waf_v3prepaid_public_cn-l*****
IsRequired	boolean	Não	Especifica se devem ser consultados os campos de log obrigatórios. true: Consulta os campos de log obrigatórios. false: Consulta os campos de log não obrigatórios.	false
IsDefault	boolean	Não	Especifica se devem ser consultados os campos de log padrão. true: Consulta os campos de log padrão. false: Consulta os campos de log não padrão.	true
LogKeyList	array	Não	A lista de campos de log a serem consultados.
	string	Não	O campo de log a ser consultado.	final_action
RegionId	string	Não	A região onde a instância do WAF está localizada. 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-aek2sxgs*****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de campos de log retornados.	6
RequestId	string	O ID da solicitação.	AB0775EB-2594-598A-97E1-51B1*******
LogFieldList	array<object>	A lista de campos de log retornados.
	object	As informações sobre um campo de log.
Status	boolean	O status do campo de log. Valores válidos: 0: offline. 1: online ou em uso. 2: prestes a ser despublicado. 3: prestes a ser publicado.	1
IsDefault	boolean	Indica se o campo de log é um campo padrão. true: O campo de log é um campo padrão. false: O campo de log não é um campo padrão.	true
IsRequired	boolean	Indica se o campo de log é obrigatório. true: O campo de log é obrigatório. false: O campo de log não é obrigatório.	true
LogKey	string	O nome do campo de log. Nota Para obter mais informações sobre os campos de log, consulte Descrições dos campos de log.	final_action

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 6,
  "RequestId": "AB0775EB-2594-598A-97E1-51B1*******",
  "LogFieldList": [
    {
      "Status": true,
      "IsDefault": true,
      "IsRequired": true,
      "LogKey": "final_action"
    }
  ]
}

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.