ListLogShipper
更新时间：2024-09-11
描述
查看符合查询条件的投递任务列表。
请求
- 请求语法
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- 请求头域
除公共请求头域外，无其它特殊头域。
- 请求参数
| 参数名称 | 类型 |
是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| logShipperID | string | no | query | 可按任务ID模糊查询 |
| logShipperName | string | no | query | 可按任务名称模糊查询 |
| project | string | no | query | 可按日志组名称查询 |
| logStoreName | string | no | query | 可按日志集名称查询 |
| destType | string | no | query | 按投递目的端类型查询，目前仅支持BOS，默认BOS |
| status | string | no | query | 按任务状态过滤，可选：运行中（Running）、异常（Abnormal）、已暂停（Paused） |
| orderBy | string | no | query | 排序列，当前只有创建时间列createDateTime，默认createDateTime |
| order | string | no | query | 可选asc/desc, 默认降序desc |
| pageNo | int | no | query | 页码，从1开始，默认1 |
| pageSize | int | no | query | 页大小，最小10，最大100，默认10 |
响应
- 响应头域
除公共响应头域外，无其它特殊头域。
- 响应参数
| 参数名称 | 类型 | 是否可以为空 | 描述 |
|---|---|---|---|
| totalCount | int | no | 总数目 |
| result | list<ShipperSummary> | yes | 投递任务列表 |
ShipperSummary结构：
| 参数名称 | 类型 | 是否可以为空 | 描述 |
|---|---|---|---|
| createDateTime | string | no | 创建时间 |
| destType | string | no | 投递目的端类型 |
| errMessage | string | yes | 运行错误信息，为空，表示『无异常』 |
| logShipperID | string | no | 任务ID |
| logShipperName | string | no | 任务名称 |
| project | string | no | 日志组名称 |
| logStoreName | string | no | 日志集名称 |
| status | string | no | 运行状态, 可为运行中（Running）、异常（Abnormal）、已暂停（Paused） |
错误码
除了通用的错误码，还可能出现如下错误码：
| 错误码 | 错误消息 | 描述 | HTTP状态码 |
|---|---|---|---|
| LogStoreNotFound | LogStore [logStoreName] not exists | LogStore 不存在 | 404 |
注：错误消息中 [logStoreName] 部分会用具体的名称来替换
示例
- 请求示例
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- 响应示例
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":""
},
....
]
}