List LogStream
Updated at：2025-11-03
Description
Retrieve a list of logstreams within the user-specified logstore.
Request
- Request syntax
Http
1GET /v1/logstore/{logStoreName}/logstream?project={project} HTTP/1.1
2Host: <Endpoint>
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 |
|---|---|---|---|---|
| project | String | Yes | Query | Specify the keywords for project filtering |
| logStoreName | String | Yes | Path | Specify the keywords for logstream filtering |
| namePattern | String | No | Query | Specify the keywords for name filtering |
| order | String | No | Query | Sort rule, desc: descending; asc: ascending; default: desc |
| orderBy | String | No | Query | Sorting field, defaulting to creation time |
| pageNo | Int | No | Query | Start page, default: 1 |
| pageSize | Int | No | Query | Data volume shown on each page, default: 10 |
Response
- Response headers
No additional headers are required beyond the standard response headers.
- Response parameters
| Parameter name | Types | Description |
|---|---|---|
| order | String | Sort rule, desc: descending; asc: ascending |
| orderBy | String | Sorting field |
| pageNo | Int | Start page |
| pageSize | Int | Data volume shown on each page |
| totalCount | Int | Total entries |
| result | List<LogStream> | Logstream list |
The element structure of each logstream in the result array in the above table is as follows:
| Field name | Types | Description |
|---|---|---|
| creationDateTime | DateTime | Creation time of logstream |
| logStreamName | String | Logstream name |
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 exists | 404 |
Note: [logStoreName] in error message may be replaced with a specific name.
Example
- Request example
Text
1GET /v1/logstore/demo/logstream?project=default&namePattern=my-stream&order=asc&orderBy=creationDateTime&pageNo=1&pageSize=10 HTTP/1.1
2Host: bls-log.bj.baidubce.comn
3Authorization:bce-auth-v1/18717522d39411e9b721df098b0b908c/2019-09-10T07:00:20Z/1800/content-type;host;x-bce-date;x-bce-request-id/6a7cb6c9ac7ec156c805e55e7d0bcfc443b47feee97cf099c1c0d93a0b4c8304- Response example
Text
1HTTP/1.1 200 OK
2Content-Type: application/json; charset=utf-8
3{
4 "result": [
5 {
6 "creationDateTime": "2019-09-10T15:30:20Z",
7 "logStreamName": "my-stream1"
8 }
9 ],
10 "order": "asc",
11 "orderBy": "creationDateTime",
12 "pageNo": 1,
13 "pageSize": 10,
14 "totalCount": 1
15}