CreateUserDeliveryTask - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Cria uma tarefa personalizada de entrega de logs para SLS, HTTP, OSS, S3 ou Kafka.

Descrição da operação

Use esta API para criar uma tarefa de entrega para dados de log específicos. Ela oferece suporte a vários destinos de entrega, incluindo SLS, serviços HTTP, Alibaba Cloud OSS, armazenamento compatível com S3 e filas de mensagens Kafka. Você pode definir um nome de tarefa personalizado, selecionar campos de log, especificar um data center, definir a taxa de descarte, escolher um tipo de entrega e configurar os detalhes de entrega para o tipo selecionado.

Filtragem de campos: Use FieldName para especificar os campos de log a serem entregues.
Regras de filtro: Use FilterRules para filtrar dados de log antes da entrega.
Destinos de entrega suportados: Entregue logs em vários destinos, incluindo SLS, HTTP(S), Alibaba Cloud OSS, armazenamento compatível com S3 e Kafka. Cada método possui parâmetros de configuração específicos.

Observações

Certifique-se de que sua AccessKey e SecretKey tenham as permissões necessárias para a operação de entrega.
Se um método de entrega exigir criptografia ou autenticação, configure seus parâmetros de segurança de acordo.
Verifique se a sintaxe de FilterRules está correta.
Ajuste parâmetros avançados, como o número de tentativas e o tempo limite, para otimizar a eficiência e a estabilidade da entrega.

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

esa:CreateUserDeliveryTask

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
BusinessType	string	Sim	O tipo de log em tempo real. Valores válidos: dcdn_log_access_l1 (padrão): log de acesso. dcdn_log_er: log de função de borda. dcdn_log_waf: log do WAF. dcdn_log_ipa: log de aceleração da camada 4.	dcdn_log_access_l1
DataCenter	string	Não	O data center. Valores válidos: cn: China continental. sg: global (exceto a China continental).	cn
TaskName	string	Sim	O nome da tarefa.	test_project
FieldName	string	Sim	Os campos a serem entregues. Separe vários campos com uma vírgula.	user_agent,ip_address,ip_port
DeliveryType	string	Sim	O destino de entrega de logs. Valores válidos: sls: Log Service (SLS). http: um serviço HTTP. aws3: Amazon S3. oss: Object Storage Service (OSS). kafka: Kafka. aws3cmpt: um serviço compatível com S3.	sls
DiscardRate	number	Não	A taxa de descarte de logs. O valor padrão é 0.	0
S3Delivery	object	Não	Configuração para entrega de logs no Amazon S3 ou em um serviço compatível com S3.
Region	string	Não	A região de destino.	cn-shanghai
BucketPath	string	Não	O caminho do bucket.	logriver-test/log
AccessKey	string	Não	O ID da chave de acesso da conta S3.	g0f46623ll0g0
SecretKey	string	Não	A chave de acesso secreta da conta S3.	***
Endpoint	string	Não	O endpoint do S3.	https://s3.oss-cn-hangzhou.aliyuncs.com
PrefixPath	string	Não	O prefixo da chave do objeto.	logriver-test/log
S3Cmpt	boolean	Não	Especifica se o destino é um serviço compatível com S3.	true
ServerSideEncryption	boolean	Não
VertifyType	string	Não
OssDelivery	object	Não	Configuração para entrega de logs no Object Storage Service (OSS).
Region	string	Não	A região do bucket OSS de destino.	cn-hangzhou
Aliuid	string	Não	O ID da conta Alibaba Cloud.	1234***
BucketName	string	Não	O nome do bucket.	test_rlog
PrefixPath	string	Não	O prefixo da chave do objeto.	test/
HttpDelivery	object	Não	Configuração para entrega de logs em um endpoint HTTP ou HTTPS.
DestUrl	string	Não	A URL do endpoint de destino.	http://xxx.aliyun.com/v1/log/upload
StandardAuthOn	boolean	Não	Especifica se a autenticação padrão deve ser ativada.	true
StandardAuthParam	object	Não	Configuração para autenticação padrão.
PrivateKey	string	Não	A chave privada.	xxxx
ExpiredTime	integer	Não	O tempo de expiração, em segundos.	300
UrlPath	string	Não	O caminho da URL.	v1/log/upload
MaxBatchSize	integer	Não	O número máximo de entradas de log por solicitação de entrega.	1000
MaxBatchMB	integer	Não	O tamanho máximo de um lote de entrega, em MB.	5
MaxRetry	integer	Não	O número máximo de tentativas se uma entrega falhar.	3
TransformTimeout	integer	Não	O tempo limite de entrega, em segundos.	10
LogBodyPrefix	string	Não	O prefixo a ser adicionado ao payload de entrega de logs.	cdnVersion:1.0
LogBodySuffix	string	Não	O sufixo a ser adicionado ao payload de entrega de logs.	cdnVersion:1.0
Compress	string	Não	O método de compactação.	gzip
LogSplitWords	string	Não	O delimitador para entradas de log.	\n
HeaderParam	object	Não	Cabeçalhos HTTP personalizados.
	object	Não	O nome do cabeçalho personalizado.
StaticValue	string	Não	O valor do cabeçalho personalizado.	aliyun
QueryParam	object	Não	Parâmetros de consulta personalizados.
	object	Não	O nome do parâmetro de consulta personalizado.
StaticValue	string	Não	O valor do parâmetro de consulta personalizado.	v1.1
LogSplit	boolean	Não	Especifica se as entradas de log devem ser divididas. O valor padrão é true.	true
LastLogSplit	boolean	Não	O delimitador final.	\n
KafkaDelivery	object	Não	Configuração para entrega de logs no Kafka.
Topic	string	Não	O tópico do Kafka.	dqc_test2
UserAuth	boolean	Não	Especifica se a autenticação de usuário deve ser ativada.	true
MachanismType	string	Não	O mecanismo de autenticação.	plain
UserName	string	Não	O nome de usuário para autenticação.	xxx
Password	string	Não	A senha para autenticação.	xxx
Brokers	array	Não	Uma lista de brokers do Kafka.
	string	Não	Um broker do Kafka, no formato `host:port`.	192.168.0.1:9902
Compress	string	Não	O método de compactação. Desativado por padrão.	lz4
Balancer	string	Não	O método de balanceamento de carga.	kafka.LeastBytes
SlsDelivery	object	Não	Configuração para entrega de logs no Log Service (SLS).
SLSRegion	string	Não	A região do projeto de destino.	cn-hangzhou
SLSProject	string	Não	O nome do projeto de destino.	dcdn-test20240417
SLSLogStore	string	Não	O nome do logstore de destino.	accesslog-test
Details	string	Não
FilterVer	string	Não

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados na resposta.
RequestId	string	O identificador exclusivo da solicitação.	2CCD40B1-3F20-5FF0-8A67-E3F34B87744F
TaskName	string	O nome da tarefa.	er-http
DataCenter	string	O data center. Valores válidos: cn: China continental. sg: Global (exceto a China continental).	cn
Status	string	O status atual da tarefa.	online

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "2CCD40B1-3F20-5FF0-8A67-E3F34B87744F",
  "TaskName": "er-http",
  "DataCenter": "cn",
  "Status": "online"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InternalError	An internal exception occurred, please try again later.	An inner exception was triggered. Please try again later.
400	InvalidParameter	Invalid parameter. Check the parameter configuration.	Invalid parameter. Check the parameter configuration.
403	ErService.NotOpen	Er service has not opend.	Er service has not opend.
403	RealTimeLog.S3EndpointInvalidError	Invalid S3 information for the delivery task. Check your configurations and try again.	Invalid S3 information for the delivery task. Check your configurations and try again.
403	RealTimeLog.KafkaBrokersExceedError	The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).	The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50).
403	RealTimeLog.StatusQuotaError	The maximum number of real-time log delivery tasks has been reached. Check your plan quota and upgrade the plan to request a quota increase.	The maximum number of real-time log delivery tasks has been reached. Check your plan quota and upgrade the plan to request a quota increase.
403	EsaService.NotOpen	ESA service has not opend.	Edge Security Accelerator (ESA) is not turned on

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.