获取日志投递列表ListLogShipper
更新时间：2026-06-23
- 查看符合查询条件的投递任务列表。
API Explorer
去调试
您可以在 API Explorer 中直接运行该接口，免去您计算签名的困扰。运行成功后，API Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1GET /v{version}/logshipper?&logShipperID={logShipperID}&logShipperName={logShipperName}&project={project}&logStoreName={logStoreName}&destType={destType}&status={status}&orderBy={orderBy}&order={order}&pageNo={pageNo}&pageSize={pageSize} HTTP/1.1
2Host: xxx.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其他特殊头域
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值为1 |
| logShipperID | string | 否 | Query参数 | 可按任务ID模糊查询 |
| logShipperName | string | 否 | Query参数 | 可按任务名称模糊查询 |
| project | string | 否 | Query参数 | 可按日志组名称查询 |
| logStoreName | string | 否 | Query参数 | 可按日志集名称查询 |
| destType | string | 否 | Query参数 | 按投递目的端类型查询，目前仅支持BOS，默认BOS |
| status | string | 否 | Query参数 | 按任务状态过滤，可选：运行中（Running）、异常（Abnormal）、已暂停（Paused） |
| orderBy | string | 否 | Query参数 | 排序列，当前只有创建时间列createDateTime，默认createDateTime |
| order | string | 否 | Query参数 | 可选asc/desc, 默认降序desc |
| pageNo | int | 否 | Query参数 | 页码，从1开始，默认1 |
| pageSize | int | 否 | Query参数 | 页大小，最小10，最大100，默认10 |
返回状态码
成功返回200，失败返回见错误码
返回头域
除公共头域外，无其他特殊头域
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 请求是否成功 |
| code | String | 请求码，成功为OK，错误为具体的错误码 |
| totalCount | int | 总数目 |
| result | list<ShipperSummary> | 投递任务列表 |
请求示例
Plain Text
1GET /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
2HOST bls-log.bj.baidubce.com
3Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02响应示例
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 "totalCount" : 20,
10 "result":[
11 {
12 "logShipperID":"232323",
13 "logShipperName":"logshipper1",
14 "project": "default",
15 "logStoreName": "logstore1",
16 "destType": "BOS",
17 "status": "Running",
18 "createDateTime"："2021-03-09 09:10:11",
19 "errMessage":""
20 }
21 ]
22}评价此篇文章