Querying Log Streams

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

Online Debugging

CLI Examples

View PDF

Function

This API is used to query log stream details. It helps you learn about the running and management status of the log streams and provides comprehensive and accurate data support.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/log-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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
log_group_name	No	String	Parameter description: Log group name. Constraints: N/A. Value range: N/A. Default value: N/A.
log_stream_name	No	String	Parameter description: Log stream name. Constraints: N/A. Value range: N/A. Default value: N/A.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
log_streams	Array of LogStreamNoIsFavorite objects	Parameter description: List of log groups. Value range: N/A.

**Table 5** LogStreamNoIsFavorite
Parameter	Type	Description
creation_time	Long	Parameter description: Log stream creation time. Value range: N/A.
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: Parameter description: Log stream tags. Value range: N/A.
filter_count	Integer	Parameter description: Number of filters. This parameter has been brought offline. Value range: N/A.
hot_cold_separation	String	Parameter description: Hot and cold storage switch. Value range: N/A.
whether_log_storage	String	Parameter description: Whether to enable log storage. Value range: N/A.
auth_web_tracking	String	Parameter description: Anonymous write switch. Value range: N/A.
ttl_in_days	Integer	Parameter description: Log storage period (days). Value range: N/A.
hot_storage_days	Integer	Parameter description: Standard storage period (days). Value range: N/A.
is_favorite	Boolean	Parameter description: Whether to favorite the log stream. Value range: N/A.

Status code: 400

**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

If you leave the request body empty, all log streams are queried. If log_group_name and log_stream_name are specified, the corresponding log stream is queried.

GET https://{endpoint}/v2/{project_id}/log-streams

/v2/{project_id}/log-streams /v2/{project_id}/log-streams?log_group_name={log_group_name} 
/v2/{project_id}/log-streams?log_stream_name={log_stream_name}  
/v2/{project_id}/log-streams?log_stream_name={log_stream_name} &log_group_name={log_group_name}

Example Responses

Status code: 200

Log stream information is returned.

{
  "log_streams" : [ {
    "log_stream_name_alias" : "lts-topic-xxxx",
    "creation_time" : 1698915657847,
    "auth_web_tracking" : false,
    "log_stream_name" : "lts-topic-xxxx",
    "is_favorite" : false,
    "hot_storage_days" : -1,
    "tag" : {
      "_sys_enterprise_project_id" : "xxxxxx"
    },
    "hot_cold_separation" : false,
    "filter_count" : 0,
    "log_stream_id" : "xxxxxxx",
    "ttl_in_days" : 7,
    "whether_log_storage" : true
  }, {
    "log_stream_name_alias" : "lts-topic-xxxx",
    "creation_time" : 1698915650021,
    "auth_web_tracking" : false,
    "log_stream_name" : "lts-topic-xxxx",
    "is_favorite" : false,
    "hot_storage_days" : -1,
    "tag" : {
      "_sys_enterprise_project_id" : "xxxxxxx"
    },
    "hot_cold_separation" : false,
    "filter_count" : 0,
    "log_stream_id" : "xxxxxxxxxxxxxxxxxxx",
    "ttl_in_days" : 7,
    "whether_log_storage" : true
  } ]
}

Status code: 400

Invalid request. Modify the request based on the description in error_msg before a retry.

{
  "error_code" : "LTS.0205",
  "error_msg" : "The log stream name has been existed"
}

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	Log stream information is returned.
400	Invalid request. Modify the request based on the description in error_msg before a retry.
500	The server has received the request but encountered an internal error.