ListLogStores - Simple Log Service

Queries all Logstores or Logstores that match specific conditions in a project.

Operation description

Usage notes

Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
An AccessKey pair is created and obtained. For more information, see AccessKey pair.

The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.

The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see Manage a project.

Authentication resources

The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.

Action	Resource
`log:ListLogStores`	`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/*`

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
log:ListLogStores	get	LogStore acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/*	log:TLSVersion	none

Request syntax

GET /logstores HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project
offset	integer	No	The line from which the query starts. Default value: 0.	0
size	integer	No	The number of entries per page. Maximum value: 500. Default value: 500.	10
logstoreName	string	No	The name of the Logstore. Fuzzy match is supported. For example, if you enter test, Logstores whose name contains test are returned.	my-logstore
telemetryType	string	No	The type of the data that you want to query. Valid values: None: logs Metrics: metrics	None
mode	string	No	The type of the Logstore. Valid values: standard and query. standard: Standard Logstore. This type of Logstore supports the log analysis feature and is suitable for scenarios such as real-time monitoring and interactive analysis. You can also use this type of Logstore to build a comprehensive observability system. query: Query Logstore. This type of Logstore supports high-performance queries. The index traffic fee of a Query Logstore is approximately half that of a Standard Logstore. Query Logstores do not support SQL analysis. Query Logstores are suitable for scenarios in which the volume of data is large, the log retention period is long, or log analysis is not required. Log retention periods of weeks or months are considered long.	standard

Response parameters

Parameter	Type	Description	Example
headers	object
Server	string	The name of the server.	nginx
Content-Type	string	The format in which the response body is returned.	application/json
Content-Length	string	The length of the response body.	0
Connection	string	Indicates whether the connection is persistent. Valid values: close: The connection is non-persistent. A new TCP connection is established for each HTTP request. keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth are consumed to re-establish connections.	close
Date	string	The time when the response was returned.	Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string	The request ID.	5B0A6B60BB6EE39764D458B5
	object	The body of the response.
total	integer	The number of the Logstores that meet the query conditions.	2
count	integer	The number of entries returned on the current page.	2
logstores	array	The Logstores that meet the query conditions.
	string	The information about the Logstore.	test-1,test-2

Examples

Sample success responses

JSONformat

{
  "total": 2,
  "count": 2,
  "logstores": [
    "test-1,test-2"
  ]
}

Error codes

For a list of error codes, visit the Service error codes.