Get Log Shipper
Updated at：2025-11-03
Description
View the specified logshipper details
Request
- Request syntax
Http
1GET /v1/logshipper/{logShipperID} HTTP/1.1
2Host: bls-log.{region}.baidubce.com
3Authorization: authorization string- Request headers
No additional headers are required beyond the standard request headers.
- Request parameters
| Parameter name | Types | Required or not | Parameter location | Description |
|---|---|---|---|---|
| logShipperID | string | yes | path | Task ID |
Response
- Response headers
No additional headers are required beyond the standard response headers.
- Response parameters
| Parameter name | Types | Can it be empty | Description |
|---|---|---|---|
| status | string | no | Running status, options: Running, Normal or Paused |
| logShipperName | string | no | Logshipper name |
| project | string | no | Project name |
| logStoreName | string | no | Logstore name |
| startTime | string | no | Specify logshipper start time |
| destType | string | no | Destination location type |
| destConfig | DestConfig | no | Target configuration details |
DestConfig structure:
| Parameter name | Types | Description |
|---|---|---|
| BOSPath | string | BOSPath consists of a bucket plus a user-defined path |
| partitionFormatTS | string | Disk partition format, for example%Y/%m/%d/%H/%M/ |
| partitionFormatLogStream | bool | Whether to use logstream as a partition level; default: false |
| maxObjectSize | int64 | Maximum object size, unit: MB |
| compressType | string | Compression type, optional parameters: snappy/gzip/bzip2/lzop and none |
| deliverInterval | int | Delivery interval, in minute, limit range: integers between 5 and 60 |
| storageFormat | string | Storage format, optional parameters: parquet, json, csv |
| csvHeadline | bool | Whether to deliver the field name in case of CSV |
| csvDelimiter | string | Separator in case of CSV, options: comma (,), space ( ), pipe (|), or tab (\t) |
| csvQuote | string | Quote character in case of CSV, options: single quote ('), double quote ("), none, or custom |
| nullIdentifier | string | In case of CSV, when column is empty, fill specified content |
| selectedColumnName | string | In case of CSV and parquet, the selected column name, the column name parameters separated by comma |
| selectedColumnType | string | In case of parquet, the selected column type, the column type parameters separated by comma |
Error code
Apart from standard error codes, the following codes may be returned:
| Error code | Error message | Description | HTTP status code |
|---|---|---|---|
| LogStoreNotFound | LogStore [logStoreName] not exists | Logstore not exist | 404 |
Note: [logStoreName] in error message may be replaced with a specific name.
Example
- Request example
Http
1GET /v1/logshipper/2323-2333 HTTP/1.1
2Host: bls-log.bj.baidubce.com
3Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
4Content-Type: application/json; charset=utf-8- Response example
Http
1HTTP/1.1 200
2Content-Type: application/json; charset=utf-8
3{
4 "status":"Running",
5 "logShipperName":"shipper1",
6 "project":"default",
7 "logStoreName":"logstore1",
8 "startTime":"2021-01-12T01:01:00Z",
9 "destType":"BOS",
10 "destConfig":{
11 "BOSPath":"bucket1/path/",
12 "partitionFormatTS":"%Y/%m/%d/%H/%M/",
13 "partitionFormatLogStream":true,
14 "maxObjectSize":50,
15 "compressType":"snappy",
16 "deliverInterval":30,
17 "storageFormat":"csv",
18 "csvHeadline":false,
19 "csvSeparator":",",
20 "csvQuote":"\"",
21 "selectedColumnName":"v1,v2",
22 "selectedColumnType":"string,int32",
23 "nullIdentifier":"null"
24 }
25}