Queries logs in a project. You can use this operation to query logs at the project level.
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 Resource Access Management (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.
- Indexes are configured before you query logs. For more information, see Create indexes.
- Limits are imposed when you use Simple Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see Log search overview and Log analysis overview.
- You must set query to a standard SQL statement.
- You must specify a Logstore in the FROM clause of an SQL statement. A Logstore can be used as an SQL table.
- You must specify a time range in an SQL statement by using the __date__ or __time__ parameter. The value of the __date__ parameter is a timestamp. The value of the __time__ parameter is an integer, and the unit of the value is seconds.
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:GetProjectLogs | acs:log:{#regionId}:{#accountId}:project/{#ProjectName} |
Debugging
Authorization information
Request syntax
GET /logs HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| project | string | Yes | The name of the project. | ali-test-project |
| query | string | Yes | The standard SQL statement. In this example, the SQL statement queries the number of page views (PVs) from 2022-03-01 10:41:40 to 2022-03-01 10:56:40 in a Logstore whose name is nginx-moni. | SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400 |
| powerSql | boolean | No | Specifies whether to enable the Dedicated SQL feature. For more information, see Enable Dedicated SQL. Valid values:
You can use the powerSql or query parameter to configure Dedicated SQL. | false |
Sample requests
GET /logs?query=SELECT COUNT(*) as pv FROM nginx-moni where time > 1646102500 and time < 1646103400&powerSql=false HTTP/1.1 Host:ali-test-project.ch-hangzhou.log.aliyuncs.com Content-Type:application/json
Response parameters
Examples
Sample success responses
JSONformat
[
{
"key": "{\"Key1\" : \"value\"}"
}
]Error codes
For a list of error codes, visit the Service error codes.