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

Descrição da operação

Antes de chamar esta operação, certifique-se de que o serviço de log esteja ativado para a instância do WAF. Chame a operação DescribeInstance para consultar os detalhes da instância. Se o parâmetro de resposta Details.LogService for true, o serviço de log está ativado. Se o serviço de log não estiver ativado, faça login no console do WAF e atualize a instância para ativar o serviço de log.

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

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 DescribeInstance para consultar o ID da instância atual do WAF.	waf_v3prepaid_public_cn-0*****
DeliveryType	string	Não	O tipo de entrega. Valores válidos: sls: Simple Log Service.	sls
RegionId	string	Não	A região onde a instância do WAF reside. 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-aek24******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
AddList	string	A lista de campos de log configurados além dos campos de log padrão, no formato "a,b,c,...".	acl_action,acl_rule_id
RequestId	string	O ID da solicitação.	653778B4-4D47-5223-855B-4E******
LogDeliveryStrategy	string	A estratégia de entrega de logs. Várias estratégias são suportadas. O valor é uma string convertida a partir de um array JSON construído com uma série de parâmetros. Nota Para mais informações sobre os parâmetros, consulte a descrição do parâmetro LogDeliveryStrategy na operação ModifyUserLogFieldConfig.	[{\"logType\":\"blockLog\",\"rate\":100},{\"logType\":\"normalRequestLog\",\"rate\":100},{\"logType\":\"checkLog\",\"rate\":100}]
ExtendConfig	string	A configuração estendida para entrega de logs. O valor é uma string convertida a partir de um objeto JSON construído com uma série de parâmetros. Nota Para mais informações sobre os parâmetros, consulte a descrição do parâmetro ExtendConfig na operação ModifyUserLogFieldConfig.	{\"request_header\":\"Ali-Cdn-Real-Ip\"}
ConfigStatus	string	O status da configuração de campos de log. Valores válidos: initial: A configuração está em estado de inicialização. updating: A configuração está sendo atualizada. failed_finished: A configuração falhou. success_finished: A configuração foi bem-sucedida.	success_finished
DelList	string	A lista de campos de log excluídos dos campos de log padrão, no formato "a,b,c,...".	waf_rule_id,waf_rule_type
FieldList	string	A lista de campos de log a serem entregues, no formato "a,b,c,...".	account,acl_action,acl_rule_id,acl_rule_type
DeliveryType	string	O tipo de entrega. Valores válidos: sls: Simple Log Service.	sls

Exemplos

Resposta de sucesso

JSON formato

{
  "AddList": "acl_action,acl_rule_id",
  "RequestId": "653778B4-4D47-5223-855B-4E******",
  "LogDeliveryStrategy": "[{\\\"logType\\\":\\\"blockLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"normalRequestLog\\\",\\\"rate\\\":100},{\\\"logType\\\":\\\"checkLog\\\",\\\"rate\\\":100}]",
  "ExtendConfig": "{\\\"request_header\\\":\\\"Ali-Cdn-Real-Ip\\\"}",
  "ConfigStatus": "success_finished",
  "DelList": "waf_rule_id,waf_rule_type",
  "FieldList": "account,acl_action,acl_rule_id,acl_rule_type",
  "DeliveryType": "sls"
}

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.