List Log Shipper
Last Updated：2025-11-14
Description
Check the list of logshippers that match the query conditions.
Request
- Request syntax
GET /v1/logshipper?&logShipperID={}&logShipperName={}&project={}&logStoreName={}&destType={}&status={}&orderBy={}&order={}&pageNo={}&pageSize={} HTTP/1.1
Host: bls-log.{region}.baidubce.com
Authorization: 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 | no | query | Support fussy query by task ID |
| logShipperName | string | no | query | Support fussy query by task name |
| project | string | no | query | Support query by project name |
| logStoreName | string | no | query | Support query by logstore name |
| destType | string | no | query | Query by delivery destination location type currently supporting BOS only; default: BOS |
| status | string | no | query | Filter by task status; options: Running, Abnormal, Paused |
| orderBy | string | no | query | Sorting column, currently only the createDateTime column is available; default createDateTime |
| order | string | no | query | Options: asc/desc; default: desc |
| pageNo | int | no | query | Page, starting from 1, default: 1 |
| pageSize | int | no | query | Page size, minimum: 10, maximum: 100, default: 10 |
Response
- Response headers
No additional headers are required beyond the standard response headers.
- Response parameters
| Parameter name | Types | Can it be empty | Description |
|---|---|---|---|
| totalCount | int | no | Total entries |
| result | list<ShipperSummary> | yes | Logshipper list |
ShipperSummary structure:
| Parameter name | Types | Can it be empty | Description |
|---|---|---|---|
| createDateTime | string | no | Creation time |
| destType | string | no | Delivery destination location type |
| errMessage | string | yes | The empty runtime error message indicates 『No Exception』 |
| logShipperID | string | no | Task ID |
| logShipperName | string | no | Task name |
| project | string | no | Project name |
| logStoreName | string | no | Logstore name |
| status | string | no | Running status, options: Running, Normal or Paused |
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
GET /v1/logshipper?logShipperID=2323&logShipperName=logshipper1&project=default&logStoreName=logstore1&destType=BOS&status=Running&orderBy=createDateTime&order=desc&pageNo=1&pageSize=10 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- Response example
HTTP/1.1 200
Content-Type: application/json; charset=utf-8
{
"totalCount" : 20,
"result":[
{
"logShipperID":"232323",
"logShipperName":"logshipper1",
"project": "default",
"logStoreName": "logstore1",
"destType": "BOS",
"status": "Running",
"createDateTime"："2021-03-09 09:10:11",
"errMessage":""
},
....
]
}