On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Log Tank Service/ API Reference/ APIs/ Log Stream Management/ Querying All Log Streams in a Specified Log Group

Querying All Log Streams in a Specified Log Group

Updated on 2025-04-30 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to query all log streams in a specified log group. You can obtain the details about these log streams and their log events, addressing various log management needs.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/groups/{log_group_id}/streams

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: Project ID. For details about how to obtain it, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Constraints: N/A. Value range: N/A. Default value: N/A.
log_group_id	Yes	String	Parameter description: Log group ID. For details about how to obtain it, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Constraints: N/A. Value range: N/A. Default value: N/A.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Parameter description: User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token. Constraints: N/A. Value range: N/A. Default value: N/A.
Content-Type	Yes	String	Parameter description: Set this parameter to application/json;charset=UTF-8. Constraints: N/A. Value range: N/A. Default value: N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
log_streams	Array of LogStreamResBody objects	Parameter description: Log streams. Value range: N/A.

**Table 4** LogStreamResBody
Parameter	Type	Description
creation_time	Long	Parameter description: Creation time. Value range: Minimum value: 1577808000000 Maximum value: 4102416000000
log_stream_id	String	Parameter description: Log stream ID. Value range: N/A.
log_stream_name	String	Parameter description: Log stream name. Value range: N/A.
log_stream_name_alias	String	Parameter description: Log stream alias. Value range: N/A.
tag	Map<String,String>	Parameter description: Log stream tags. Value range: N/A.
filter_count	Integer	Parameter description: Number of filters. Value range: N/A.
is_favorite	Boolean	Parameter description: Whether to add a log stream to favorites. Value range: N/A.
whether_log_storage	Boolean	Parameter description: Whether to enable log storage. Value range: N/A.
hot_cold_separation	Boolean	Parameter description: Whether to enable cold storage. Value range: N/A.
auth_web_tracking	Boolean	Parameter description: Anonymous write switch. Value range: N/A.
ttl_in_days	Integer	Parameter description: Log storage period. Value range: N/A.
hot_storage_days	Integer	Parameter description: Standard storage period. Value range: N/A.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Parameter description: Error code. Value range: N/A.
error_msg	String	Parameter description: Error message. Value range: N/A.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Parameter description: Error code. Value range: N/A.
error_msg	String	Parameter description: Error message. Value range: N/A.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Parameter description: Error code. Value range: N/A.
error_msg	String	Parameter description: Error message. Value range: N/A.

Example Requests

Query all log streams in a specified log group.

GET https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams

/v2/{project_id}/groups/{log_group_id}/streams

Example Responses

Status code: 200

The request is successful.

{
  "log_streams" : [ {
    "log_stream_name_alias" : "3",
    "creation_time" : 1723102152593,
    "auth_web_tracking" : false,
    "log_stream_name" : "3",
    "is_favorite" : false,
    "hot_storage_days" : -1,
    "tag" : {
      "_sys_enterprise_project_id" : "0"
    },
    "hot_cold_separation" : false,
    "filter_count" : 0,
    "log_stream_id" : "667293b4-7f6d-4efb-9b30-xxxxxxx",
    "ttl_in_days" : -1,
    "whether_log_storage" : true
  }, {
    "log_stream_name_alias" : "5",
    "creation_time" : 1723102172632,
    "auth_web_tracking" : false,
    "log_stream_name" : "5",
    "is_favorite" : false,
    "hot_storage_days" : -1,
    "tag" : {
      "_sys_enterprise_project_id" : "0"
    },
    "hot_cold_separation" : false,
    "filter_count" : 0,
    "log_stream_id" : "fb08a859-69ed-4bbe-9ba0-xxxxxxxx",
    "ttl_in_days" : -1,
    "whether_log_storage" : true
  } ]
}

Status code: 401

Authentication failed. Check the token and try again.

{
  "error_code" : "LTS.0003",
  "error_msg" : "Invalid token"
}

Status code: 403

Request rejected. The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

{
  "error_code" : "LTS.0001",
  "error_msg" : "Invalid projectId"
}

Status code: 500

The server has received the request but encountered an internal error.

{
  "error_code" : "LTS.0010",
  "error_msg" : "The system encountered an internal error"
}

Status Codes


Status Code	Description
200	The request is successful.
401	Authentication failed. Check the token and try again.
403	Request rejected. The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
500	The server has received the request but encountered an internal error.