ListLogStream
Last Updated：2020-10-21
Description
Get the log stream list of the specified log set.
Request
- Request syntax
GET /v1/logstore/{logStoreName}/logstream HTTP/1.1
Host: <Endpoint>
Authorization: <Authorization String> - Request header
Except for the public request header, there are no other special headers.
- Request parameter
| Parameter name | Type | Required or not | Parameter location | Description |
|---|---|---|---|---|
| logStoreName | String | Yes | Path | Specify keywords to filter the log stream |
| namePattern | String | No | Query | Specify the keyword to filter the name |
| order | String | No | Query | Sorting rules, desc is descending order, asc is ascending order, the default is desc |
| orderBy | String | No | Query | Sort field, creation time by default |
| pageNo | Int | No | Query | Start page number, 1 by default |
| pageSize | Int | No | Query | Display data size per page, 10 by default |
Response
- Response header
Except for the public response header, there are no other special headers.
- Response parameter
| Parameter name | Type | Description |
|---|---|---|
| order | String | Sorting rules, desc is descending order, asc is ascending order |
| orderBy | String | Sort field |
| pageNo | Int | Starting page number |
| pageSize | Int | Display data size per page |
| totalCount | Int | Total number |
| result | List<LogStream> | LogStream list |
The structure of each LogStream element in the result array in the above table is as follows:
| Field name | Type | Description |
|---|---|---|
| creationDateTime | DateTime | Time to create the log stream |
| logStreamName | String | Log stream name |
Error Code
In addition to general error codes, the following error codes may also appear:
| Error code | Error message | Description | HTTP status code |
|---|---|---|---|
| LogStoreNotFound | LogStore [logStoreName] not exists | LogStore does not exist | 404 |
Note: The [logStoreName] part of the error message will be replaced with a specific name.
Example
- Request example
GET /v1/logstore/demo/logstream?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 - Return example
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
}