创建日志投递CreateLogShipper
更新时间：2026-06-23
-
为指定日志集创建投递任务，需要遵循以下准则：
- 每个日志集可以创建多个投递任务，总投递任务上限为300
- 投递任务名称，最长63个字符，包含字母、数字、-和_
- 投递开始时间，最早为前180天，最迟为后24小时，默认为任务创建时间为开始时间，格式为ISO8601
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1POST /v{version}/logshipper HTTP/1.1
2Host: xxx.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "project":<project>,
7 "logStoreName":<logStoreName>,
8 "logShipperName":<logShipperName>,
9 "startTime":<startTime>,
10 "destType":<destType>,
11 "destConfig":<destConfig>
12}请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为1 |
| project | string | 否 | RequestBody参数 | 日志组名称，默认default |
| logStoreName | string | 是 | RequestBody参数 | 日志集名称 |
| logShipperName | string | 是 | RequestBody参数 | 投递任务名称 |
| startTime | string | 否 | RequestBody参数 | 投递开始时间 |
| destType | string | 否 | RequestBody参数 | 投递目的端类型，支持BOS/KAFKA |
| destConfig | DestConfig | 是 | RequestBody参数 | 目标配置详情 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码，成功为OK，错误为具体的错误码 |
请求示例
Plain Text
1目的端是BOS时
2POST /v1/logshipper HTTP/1.1
3HOST bls-log.bj.baidubce.com
4Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
5
6{
7 "project":"default",
8 "logStoreName":"logstore1",
9 "logShipperName":"shipper1",
10 "startTime":"2021-01-12T01:01:00Z",
11 "destType":"BOS",
12 "destConfig":{
13 "BOSPath":"users-Bucket1/",
14 "partitionFormatTS":"%Y/%m/%d/%H/%M/",
15 "partitionFormatLogStream":true,
16 "maxObjectSize":50,
17 "compressType":"snappy",
18 "deliverInterval":30,
19 "storageFormat":"json"
20 }
21}
22
23目的端是KAFKA时
24POST /v1/logshipper HTTP/1.1
25HOST bls-log.bj.baidubce.com
26Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
27
28{
29 "project":"default",
30 "logStoreName":"logstore1",
31 "logShipperName":"shipper1",
32 "startTime":"2021-01-12T01:01:00Z",
33 "destType":"BOS",
34 "destConfig":{
35 "kafkaConfig": {
36 "brokers": ["localhost:9092"],
37 "topic": "test_logshipper",
38 "maxRetries": 2
39 },
40 "deliverInterval": 30,
41 "fieldsName": ["function", "@raw", "@stream", "@timestamp", "@tag_file_path"],
42 "fieldsType": ["string", "string", "string", "long", "string"],
43 "shipperType": "kv"
44 }
45}响应示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9 "success": true
10 "code": "OK"
11}评价此篇文章