Queries all Logstores or Logstores that match specified conditions in a specified project.
Usage notes
- Host consists of a project name and a Log Service endpoint. You must specify a project in Host.
An AccessKey pair is created and obtained. For more information, see AccessKey pairs.
The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in 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 Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access 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
Request headers
This operation uses only common request headers and does not have operation-specific request headers. For more information, see Common request parameters.
Request syntax
GET /logstores HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
project | String | Host | Yes | ali-test-project | The name of the project. |
offset | Integer | Query | No | 0 | The line from which the query starts. Default value: 0. |
size | Integer | Query | No | 10 | The number of entries per page. Maximum value: 500. Default value: 500. |
logstoreName | String | Query | No | my-logstore | The name of the Logstore. Fuzzy match is supported. For example, if you enter test, all Logstores whose name contains test are returned. |
telemetryType | String | Query | No | None | The type of the data that you want to query. Valid values:
|
mode | String | Query | No | standard | The type of the Logstore. Log Service provides the following types of Logstores: Standard Logstores and Query Logstores. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
Server | String | nginx | The name of the server. |
Content-Type | String | application/json | The format of the response body. |
Content-Length | String | 0 | The length of the response body. |
Connection | String | close | Indicates whether the connection is persistent. Valid values:
|
Date | String | Sun, 27 May 2018 08:25:04 GMT | The time when the response was returned. |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 | The request ID. |
total | Integer | 2 | The number of the Logstores that meet the query conditions. |
count | Integer | 2 | The number of entries returned on the current page. |
logstores | Array of String | test-1,test-2 | The Logstore information. |
Examples
Sample requests
GET /logstores?offset=0&size=10&logstoreName=my-logstore&telemetryType=None&mode=standard HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
Sample success responses
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"total" : 2,
"count" : 2,
"logstores" : [ "test-1", "test-2" ]
}
Error codes
For a list of error codes, see Service error codes.
HttpStatusCode | ErrorCode | ErrorMessage | Description |
404 | ProjectNotExist | Project does not exist. | The specified project does not exist. |
500 | InternalServerError | Specified Server Error Message. | An internal server error has occurred. |
For more information, see Common error codes.