ListLogStream
更新时间:2024-09-11
描述
获取用户指定日志集的日志流列表。
请求
- 请求语法
GET /v1/logstore/{logStoreName}/logstream?project={project} HTTP/1.1
Host: <Endpoint>
Authorization: <Authorization String>
- 请求头域
除公共请求头域外,无其它特殊头域。
- 请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
project | String | Yes | Query | 指定筛选日志组的关键字 |
logStoreName | String | Yes | Path | 指定筛选日志流的关键字 |
namePattern | String | No | Query | 指定筛选名称的关键字 |
order | String | No | Query | 排序规则,desc为降序,asc为升序,默认为 desc |
orderBy | String | No | Query | 排序字段,默认为创建时间 |
pageNo | Int | No | Query | 起始页码,默认为 1 |
pageSize | Int | No | Query | 每页显示数据大小,默认为 10 |
响应
- 响应头域
除公共响应头域外,无其它特殊头域。
- 响应参数
参数名称 | 类型 | 描述 |
---|---|---|
order | String | 排序规则,desc为降序,asc为升序 |
orderBy | String | 排序字段 |
pageNo | Int | 起始页码 |
pageSize | Int | 每页显示数据大小 |
totalCount | Int | 总数目 |
result | List<LogStream> | LogStream 列表 |
上表中的 result 数组中的每个 LogStream 元素结构如下:
字段名称 | 类型 | 描述 |
---|---|---|
creationDateTime | DateTime | 日志流创建的时间 |
logStreamName | String | 日志流名称 |
错误码
除了通用的错误码,还可能出现如下错误码:
错误码 | 错误消息 | 描述 | HTTP状态码 |
---|---|---|---|
LogStoreNotFound | LogStore [logStoreName] not exists | LogStore 不存在 | 404 |
注:错误消息中 [logStoreName] 部分会用具体的名称来替换
示例
- 请求示例
GET /v1/logstore/demo/logstream?project=default&namePattern=my-stream&order=asc&orderBy=creationDateTime&pageNo=1&pageSize=10 HTTP/1.1
Host: bls-log.bj.baidubce.comn
Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304
- 返回示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"result": [
{
"creationDateTime": "2019-09-10T15:30:20Z",
"logStreamName": "my-stream1"
}
],
"order": "asc",
"orderBy": "creationDateTime",
"pageNo": 1,
"pageSize": 10,
"totalCount": 1
}