Querying All Log Streams in a Specified Log Group

Function

This API is used to query information about all log streams in a specified log group.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	[Project ]ID. For details about how to obtain a project ID, see Obtaining the Account Tenant ID, Log Group ID, and Log Stream ID. Default: None Minimum: 32 Maximum: 32
log_group_id	Yes	String	ID of the log group whose log streams will be queried. Default: None Minimum: 36 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. Default: None Minimum: 1000 Maximum: 2000
Content-Type	Yes	String	Set this parameter to application/json;charset=UTF-8. Default: None Minimum: 30 Maximum: 30

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
log_streams	Array of LogStream objects	List of log groups. Array Length: 0 - 100

**Table 4** LogStream
Parameter	Type	Description
creation_time	Long	Creation time.
log_stream_name	String	Log stream name. Minimum: 1 Maximum: 64
log_stream_id	String	Log stream ID. Minimum: 36 Maximum: 36
filter_count	Integer	Number of filters. Minimum: 0 Maximum: 5
tag	Map<String,String>	Log stream tags.
is_favorite	Boolean	Indicates whether to favorite the media asset.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 503

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

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" : [ {
    "creation_time" : 1684725311230,
    "log_stream_name" : "lts-xxxx-lmytest-0522-12",
    "is_favorite" : true,
    "tag" : {
      "_sys_enterprise_project_id" : "0",
      "tag8" : "test8",
      "tag6" : "test6",
      "tag" : "66666@.com",
      "tag5" : "test5",
      "tag2" : "test"
    },
    "filter_count" : 0,
    "log_stream_id" : "xxxx-cce5-46xxx89-8b8a-90d269f7db76"
  }, {
    "creation_time" : 1684740643926,
    "log_stream_name" : "lts-topic-test001002",
    "is_favorite" : false,
    "tag" : {
      "_sys_enterprise_project_id" : "0"
    },
    "filter_count" : 0,
    "log_stream_id" : "7cdc28ce-xxxx-4f4b-9247-6edd42808f8a"
  } ]
}

Status code: 401

AuthFailed. Authentication failed. Check the token and try again.

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

Status code: 403

Forbidden.The request is 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

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

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

Status code: 503

ServiceUnavailable. The requested service is unavailable.

{
  "error_code" : "LTS.0403",
  "error_msg" : "ServiceUnavailable"
}

Status Codes

Status Code	Description
200	The request is successful.
401	AuthFailed. Authentication failed. Check the token and try again.
403	Forbidden.The request is 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	InternalServerError. The server has received the request but encountered an internal error.
503	ServiceUnavailable. The requested service is unavailable.