CreateUserDeliveryTask
用于新建用户自定义的日志投递任务至SLS、HTTP、OSS、S3或Kafka等目标
服务地址:
华东1(杭州)
输入参数
只看必填
BusinessType实时日志类型
DataCenter数据中心
TaskName任务名
FieldName选择字段
DeliveryType投递类型:
DiscardRate丢弃率
S3Deliverys3/s3兼容投递配置参数
Region服务所在区域
BucketPathBucket存储路径
AccessKeys3账号使用的AccessKey ID
SecretKeys3账号使用的SecretKey ID
EndpointS3 endpoint地址
PrefixPath存储路径前缀
S3Cmpt是否为s3兼容
请选择布尔值
ServerSideEncryption
请选择布尔值
VertifyType
OssDeliveryOss投递配置参数
RegionOss区域
Aliuid阿里云账号ID
BucketNameBucket名称
PrefixPathOss存储路径前缀
HttpDeliveryHttp投递配置参数
DestUrlhttp服务器投递地址
StandardAuthOn是否使用标态鉴权
请选择布尔值
StandardAuthParam标态鉴权参数
PrivateKey密钥
ExpiredTime过期时间
UrlPathURL路径
MaxBatchSize单次投递最大条数
MaxBatchMB单次投递最大字节数
MaxRetry最大重试次数
TransformTimeout超时等待时间
LogBodyPrefix日志投递包前缀
LogBodySuffix日志投递包尾缀
MinBackoffMS最小回退时间
MaxBackoffMS最大回退时间
Compress压缩方式
LogSplit是否开启日志分割
LastLogSplit末尾分隔符
LogSplitWords日志分隔符
ResponseBodyKey响应体中
SuccessCode自定义成功状态码
HeaderParam自定义Header头
:
StaticValue自定义Header头值
QueryParam自定义请求参数
:
StaticValue自定义请求参数值
KafkaDeliveryKafka投递配置参数
TopicKafka消息主题
UserAuth是否开启用户鉴权
请选择布尔值
MachanismType加密方式
UserName加密用户名
Password加密密码
Brokers服务器数组
0Kafka broker服务器列表
Compress压缩方式
Balancer负载均衡方式
SlsDeliverySLS投递配置
SLSRegion日志服务(SLS)所在区域
SLSProject日志服务(SLS) Project名称
SLSLogStore日志服务(SLS) LogStore名称
Details
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

本接口允许用户创建针对特定日志数据的投递任务,支持多种投递目标与详细的配置选项,包括但不限于 SLS 存储、HTTP 服务、阿里云 OSS、S3 兼容存储以及 Kafka 消息队列。用户可自定义任务名称、选择日志字段、指定数据中心、设置丢弃率、选择投递类型,并根据所选类型配置相应的投递详情。

  • 字段筛选:通过FieldName指定需要投递的日志字段。
  • 过滤规则:利用FilterRules实现日志数据的预处理过滤。
  • 多样化投递:支持 SLS、HTTP(S)、阿里云 OSS、S3 兼容存储及 Kafka 等多种投递方式,每种方式有其特定的配置参数。

注意事项

  • 确保提供的认证信息(如 AccessKey、SecretKey)具有足够的权限执行投递操作。
  • 当选择加密或鉴权的投递方式时,正确配置相关的安全参数。
  • 验证FilterRules语法正确性,确保过滤逻辑符合预期。
  • 根据实际需求调整高级参数如重试次数、超时时间等,以优化投递效率与稳定性。

请求参数

字段名称字段详情
BusinessTypestring

实时日志类型,取值:展开详情

示例值:dcdn_log_access_l1
DataCenterstring

数据中心。取值:展开详情

示例值:cn
TaskNamestring

任务名。

示例值:test_project参考取值来源:
    ListUploadTasks
FieldNamestring

选择字段,以英文逗号分隔。

示例值:user_agent,ip_address,ip_port
DeliveryTypestring

投递类型:展开详情

示例值:sls参考取值来源:
    GetSiteDeliveryTask
    ListSiteDeliveryTasks
    CreateSiteDeliveryTask
DiscardRatenumber<float>

丢弃率,不填则默认为 0。

示例值:0
S3Deliveryobject

s3/s3 兼容投递配置参数。

OssDeliveryobject

Oss 投递配置参数。

HttpDeliveryobject

Http 投递配置参数。

KafkaDeliveryobject

Kafka 投递配置参数。

SlsDeliveryobject

SLS 投递配置。

Detailsstring

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:2CCD40B1-3F20-5FF0-8A67-E3F34B87744F
TaskNamestring

任务名称。

示例值:er-http
DataCenterstring

数据中心。取值:展开详情

示例值:cn
Statusstring

任务状态。

示例值:online
变更历史
变更时间变更内容概要操作
2024-12-26
新增请求参数Details
2024-10-18
变更错误码403
2024-09-27
变更错误码400
删除错误码500
2024-09-24
变更请求参数S3Delivery