CreateLogShipper
更新时间：2024-09-11
描述
为指定日志集创建投递任务，需要遵循以下准则：
- 每个日志集可以创建多个投递任务，总投递任务上限为300
- 投递任务名称，最长63个字符，包含字母、数字、-和_
- 投递开始时间，最早为前180天，最迟为后24小时，默认为任务创建时间为开始时间，格式为ISO8601
请求
- 请求语法
POST /v1/logshipper HTTP/1.1
Host: bls-log.{region}.baidubce.com
Authorization: authorization string- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| project | string | no | body | 日志组名称，默认default |
| logStoreName | string | yes | body | 日志集名称 |
| logShipperName | string | yes | body | 投递任务名称 |
| startTime | string | no | body | 投递开始时间 |
| destType | string | no | body | 投递目的端类型，当前仅支持BOS |
| destConfig | DestConfig | yes | body | 目标配置详情 |
DestConfig结构：
| 参数名称 | 类型 |
是否必须 | 描述 |
|---|---|---|---|
| BOSPath | string | yes | BOSPath为Bucket加用户自定义路径组成，最长256个字符 |
| partitionFormatTS | string | no | 分区格式，如%Y/%m/%d/%H/%M/，仅支持到分钟级别，可自定义，可为空，默认为%Y/%m/%d/%H/%M/ |
| partitionFormatLogStream | bool | no | 是否使用logstream作为partition层级，默认false |
| maxObjectSize | int64 | no | 最大对象大小，单位MB，范围为1 ~ 5*1024*1024（5TB），默认64 |
| compressType | string | no | 压缩类型，可选参数：snappy/gzip/bzip2/lzop和不压缩（none），默认不压缩 |
| deliverInterval | int | no | 投递间隔，单位分钟，限制范围为5-60的整数，默认5 |
| storageFormat | string | no | 存储格式，可选参数： parquet, json, csv，默认json |
| csvHeadline | bool | no | csv时是否投递字段名称，默认false，不投递 |
| csvDelimiter | string | no | csv时的分隔符，可选：逗号（，），空格（ ）、竖线（|）、制表符（\t），默认逗号 |
| csvQuote | string | no | csv时的引用符，可选：单引号(')，双引号(")，空(none)，可自定义，默认为空 |
| nullIdentifier | string | no | csv时，列为空时，填写的指定内容，默认为空 |
| selectedColumnName | string | csv和parquet时，必选 | csv和parquet时，选择的列名, 逗号分割的列名参数 |
| selectedColumnType | string | parquet时，必选 | parquet时，选择的列类型，逗号分割的列类型参数 |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 参数名称 | 类型 | 是否可以为空 | 描述 |
|---|---|---|---|
| logShipperID | string | no | 投递任务ID |
错误码
除了通用的错误码，还可能出现如下错误码：
| 错误码 | 错误消息 | 描述 | HTTP状态码 |
|---|---|---|---|
| LogStoreNotFound | LogStore [logStoreName] not exists | LogStore 不存在 | 404 |
注：错误消息中 [logStoreName] 部分会用具体的名称来替换
示例
- 请求示例
POST /v1/logshipper HTTP/1.1
Host: bls-log.bj.baidubce.com
Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
Content-Type: application/json; charset=utf-8
{
"project":"default",
"logStoreName":"logstore1",
"logShipperName":"shipper1",
"startTime":"2021-01-12T01:01:00Z",
"destType":"BOS",
"destConfig":{
"BOSPath":"users-Bucket1/",
"partitionFormatTS":"%Y/%m/%d/%H/%M/",
"partitionFormatLogStream":true,
"maxObjectSize":50,
"compressType":"snappy",
"deliverInterval":30,
"storageFormat":"json"
}
}- 响应示例
HTTP/1.1 201
Content-Type: application/json; charset=utf-8
{
"logShipperID":"123123-xxxxxxx"
}