CreateUserDeliveryTask_边缘安全加速_API文档

插件下载了解更多
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语法正确性,确保过滤逻辑符合预期。
  • 根据实际需求调整高级参数如重试次数、超时时间等,以优化投递效率与稳定性。

流控信息

请求速率为30/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
esa:CreateUserDeliveryTask
Create
全部资源
*

请求参数

字段名称字段详情
BusinessTypestring

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

示例值:dcdn_log_access_l1
DataCenterstring

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

示例值:cn
TaskNamestring

任务名。

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

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

示例值:user_agent,ip_address,ip_port
DeliveryTypestring

投递类型:展开详情

示例值:sls参考取值来源:
    GetUserDeliveryTask
    ListUserDeliveryTasks
    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

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InternalError
An internal exception occurred, please try again later.诊断
400
InvalidParameter
Invalid parameter. Check the parameter configuration.诊断
403
ErService.NotOpen
Er service has not opend.诊断
403
RealTimeLog.S3EndpointInvalidError
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).诊断
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.诊断
403
EsaService.NotOpen
ESA service has not opend.诊断

变更历史

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

相关示例