新建一個實時日志投遞任務。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| esa:CreateSiteDeliveryTask | none | *Site acs:esa:{#regionId}:{#accountId}:site/{#SiteId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 錯誤碼發生變更 | 查看變更詳情 |