Call the ListLogStores API to query Logstores - Simple Log Service

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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: 200.	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 elements

Element	Type	Description	Example
	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.	["test-1","test-2"]
	string	The information about the Logstore.	test-1,test-2

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.