CreateLogDeliveryConfig - 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 a instância do WAF tenha nós de extensão de nuvem híbrida adquiridos. Você pode chamar a operação DescribeInstance para consultar os detalhes da instância. Se o valor do parâmetro de resposta Details.HybridCloudNodeExtend for maior que 0, os nós de extensão de nuvem híbrida foram adquiridos. Caso contrário, faça login no console do WAF e atualize a instância para adquirir nós de extensão de nuvem híbrida.

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

create

*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-0xldbqt****
DeliveryName	string	Sim	O nome da configuração de entrega de logs.	test1
DeliveryType	string	Sim	O tipo da configuração de entrega de logs. Valores válidos: syslog: entrega logs para um serviço syslog. kafka: entrega logs para um serviço Kafka.	syslog
DeliveryDetail	string	Sim	O conteúdo da configuração de entrega de logs. O valor é uma string JSON construída a partir de uma série de parâmetros. Nota Os parâmetros variam com base no tipo de entrega (DeliveryType) especificado. Para mais informações, consulte Descrição dos parâmetros de conteúdo da configuração de entrega.	{ "rfcVersion": "rfc3164", "protocol": "tcp", "servers": [ { "address": "1.1.1.1", "port": 20 } ] }
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-acfm***q

Descrição dos parâmetros de conteúdo da configuração de entrega.

Entregar logs para um serviço syslog (syslog)

Descrição dos parâmetros

Nome	Tipo	Obrigatório	Exemplo	Descrição
servers	Array	Sim	[{"address":"11.11.XX.XX","port":8000}]	A configuração de endereço remoto do serviço syslog. Quando o tipo de entrega é syslog, apenas um endereço é suportado. Campos: - address: o nome de domínio ou endereço IP do servidor. IPv4 e IPv6 são suportados. Obrigatório. - port: a porta do servidor. Obrigatório.
rfcVersion	String	Não	rfc3164	A versão RFC do syslog. Valores válidos: - rfc3164 (padrão): RFC 3164. - rfc5424: RFC 5424.
protocol	String	Sim	tcp	O tipo de protocolo do syslog. Valores válidos: - tcp: conexão TCP. - udp: conexão UDP.

Exemplo

{
	"InstanceId": "waf_v2_public_cn-n*******",
	"DeliveryName": "test1",
	"DeliveryType": "syslog",
	"DeliveryDetail": "{\"rfcVersion\":\"rfc3164\",\"protocol\":\"tcp\",\"servers\":[{\"address\":\"11.11.XX.XX\",\"port\":8000}]}"
}

Entregar logs para um serviço Kafka (kafka)

Descrição dos parâmetros

Nome	Tipo	Obrigatório	Exemplo	Descrição
servers	Array	Sim	[{"address":"a.com","port":8000}]	A configuração de endereço remoto do serviço Kafka. Quando o tipo de entrega é kafka, até três endereços são suportados. Campos: - address: o nome de domínio ou endereço IP do servidor. IPv4 e IPv6 são suportados. Obrigatório. - port: a porta do servidor. Obrigatório.
kafkaTopic	String	Sim	test	O ID ou nome do tópico do Kafka.
protocol	String	Sim	PLAINTEXT	O protocolo de segurança do Kafka. Valores válidos: - PLAINTEXT (padrão): protocolo PLAINTEXT. - SASL_PLAINTEXT: protocolo SASL_PLAINTEXT. - SASL_SSL: protocolo SASL_SSL.
saslUserName	String	Não	user123	O nome de usuário para autenticação SASL do Kafka. Obrigatório quando o protocolo de segurança (protocol) está definido como SASL_PLAINTEXT ou SASL_SSL.
saslPassword	String	Não	user***	A senha para autenticação SASL do Kafka. Obrigatória quando o protocolo de segurança (protocol) está definido como SASL_PLAINTEXT ou SASL_SSL.
pemCert	String	Não	Cert	O certificado personalizado para o Kafka. O formato PEM é suportado.
compressionCodec	String	Não	none	O tipo de compressão do Kafka. Valores válidos: - none (padrão): sem compressão. - gzip: compressão gzip. - zstd: compressão zstd. - lz4: compressão lz4. - snappy: compressão snappy.

Exemplo

{
	"InstanceId": "waf_v2_public_cn-n*********",
	"DeliveryName": "test2",
	"DeliveryType": "kafka",
	"DeliveryDetail": "{\"kafkaTopic\":\"topictest1\",\"protocol\":\"SASL_PLAINTEXT\",\"servers\":[{\"address\":\"a.com\",\"port\":1000},{\"address\":\"ba.com\",\"port\":1000},{\"address\":\"c.com\",\"port\":1000}],\"saslUserName\":\"user123\",\"saslPassword\":\"user****\"}"
}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
DeliveryName	string	O nome da configuração de entrega de logs.	test1
RequestId	string	O ID da solicitação.	26E46541-7AAB-5565-801D-F14DBDC5****

Exemplos

Resposta de sucesso

JSON formato

{
  "DeliveryName": "test1",
  "RequestId": "26E46541-7AAB-5565-801D-F14DBDC5****"
}

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.