新建一个实时日志投递任务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| esa:CreateSiteDeliveryTask | none |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| BusinessType | string | 是 | 业务类型，取值：
| dcdn_log_access_l1 |
| SiteId | long | 是 | 站点 ID，可通过调用 ListSites 接口获取。 | 12312312112*** |
| DataCenter | string | 是 | 数据中心。取值为：
| cn |
| TaskName | string | 是 | 任务名称。 | dcdn-test-task |
| FieldName | string | 是 | 日志所选的字段，以英文逗号“，”隔开。 | user_agent,ip_adress,ip_port |
| DeliveryType | string | 是 | 投递类型：
| sls |
| DiscardRate | float | 否 | 丢弃率不填则默认为 0。 | 0.0 |
| S3Delivery | object | 否 | S3/S3 兼容投递配置参数。 | |
| Region | string | 否 | 服务所在区域。 | cn-beijing |
| BucketPath | string | 否 | Bucket 路径。 | logriver-test/log |
| AccessKey | string | 否 | S3 账号使用的 AccessKey ID。 | LTAIKh*** |
| SecretKey | string | 否 | S3 账号使用的 SecretKey ID。 | LDSIKh*** |
| Endpoint | string | 否 | 服务器 Endpoint，当 S3Cmpt 为 true 时必填。 | https://s3.oss-cn-hangzhou.aliyuncs.com |
| PrefixPath | string | 否 | 存储路径前缀。 | logriver-test/log |
| S3Cmpt | boolean | 否 | 是否为 S3 兼容。 | true |
| OssDelivery | object | 否 | OSS 投递配置。 | |
| Region | string | 否 | OSS 区域。 | cn-shanghai |
| Aliuid | string | 否 | 阿里云账号 ID。 | 1234*** |
| BucketName | string | 否 | Bucket 名称。 | test_rlog |
| PrefixPath | string | 否 | OSS 存储路径前缀。 | test/ |
| HttpDelivery | object | 否 | HTTP 投递配置参数。 | |
| DestUrl | string | 否 | HTTP 服务器投递地址。 | http://xxx.aliyun.com/v1/log/upload |
| StandardAuthOn | boolean | 否 | 是否使用标态鉴权。 | true |
| StandardAuthParam | object | 否 | 标态鉴权参数。 | |
| PrivateKey | string | 否 | 私钥。 | *** |
| ExpiredTime | integer | 否 | 加密超时时间。 说明
大于 0 值，建议 300 以上
| 300 |
| UrlPath | string | 否 | 标态鉴权 uri 路径。 | v1/log/upload |
| MaxBatchSize | long | 否 | 单次投递最大条数。 | 1000 |
| MaxBatchMB | long | 否 | 单次投递最大字节数，单位为 MB。 | 5 |
| MaxRetry | long | 否 | 最大重试次数。 | 3 |
| TransformTimeout | long | 否 | 超时等待时间，单位为秒。 | 10 |
| LogBodyPrefix | string | 否 | 日志投递包前缀。 | cdnVersion:1.0 |
| LogBodySuffix | string | 否 | 日志投递包尾缀。 | cdnVersion:1.0 |
| Compress | string | 否 | 压缩方式，默认不压缩。 | gzip |
| HeaderParam | object | 否 | 自定义 Header 头。 | |
| object | 否 | Header 请求参数。 | ||
| StaticValue | string | 否 | 静态变量。 | alicdn |
| QueryParam | object | 否 | 自定义请求参数。 | |
| object | 否 | 请求参数结构体。 | ||
| StaticValue | string | 否 | 静态变量。 | alicdn |
| KafkaDelivery | object | 否 | Kafka 投递配置参数。 | |
| Topic | string | 否 | Kafka 消息主题。 | dqc_test2 |
| UserAuth | boolean | 否 | 是否开启用户鉴权。 | true |
| MachanismType | string | 否 | 加密方式。 | plain |
| UserName | string | 否 | 用户名。 | xxx |
| Password | string | 否 | 加密密码。 | *** |
| Brokers | array | 否 | 服务器数组。 | |
| string | 否 | Kafka Broker 服务器列表。 | 192.168.xxx.xxx:9902 | |
| Compress | string | 否 | 压缩方式。 | lz4 |
| Balancer | string | 否 | 负载均衡方式。 | kafka.LeastBytes |
| SlsDelivery | object | 否 | SLS 投递配置。 | |
| SLSRegion | string | 否 | SLS 实时日志区域名称。 | cn-hangzhou |
| SLSProject | string | 否 | SLS 实时日志名称。 | dcdn-test20240417 |
| SLSLogStore | string | 否 | SLS 实时日志库名称。 | accesslog-test |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "9358E852-992D-5BC7-8BD7-975CA02773A8",
"TaskName": "er-oss",
"SiteId": "123456****",
"DataCenter": "cn"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | 输入参数规范校验失败。 |
| 400 | RealTimeLog.ProjectExistError | The real-time log delivery task name already exists. Check the task name and try again. | 该实时日志任务名称已存在，请重新检查任务名称后重试。 |
| 400 | InternalError | An internal exception occurred, please try again later. | 触发内部异常，请稍后再试。 |
| 403 | RealTimeLog.KafkaBrokersExceedError | The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50). | 您可投递的实时日志Kafka Broker服务器地址数量超过上限(最高为50个)。 |
| 403 | RealTimeLog.S3EndpointInvalidError | Invalid S3 information for the delivery task. Check your configurations and try again. | 您投递的S3地址不正确，请检查投递地址后重试。 |
| 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. | 边缘安全加速服务(ESA)未开通 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-18 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-09-27 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-09-24 | OpenAPI 错误码发生变更 | 查看变更详情 |