Queries logs in a project by using an SQL statement.

Description

  • The query statement that is used in this operation is a standard SQL statement.
  • You must specify a project in the domain name of the request.
  • You must specify a Logstore in the FROM clause of the query statement. A Logstore can be regarded as an SQL table.
  • You must specify a time range in the SQL statement by using the __date__ parameter (timestamp) or __time__ parameter (UNIX timestamp).
  • If the number of logs in the Logstore greatly changes, Log Service cannot predict how many times this operation needs to be called to obtain the complete results. In this case, you must check the value of the x-log-progress parameter in the returned results of each request. Based on the value, you can decide whether to call this operation again to obtain the complete results. Each time you call this operation, the same number of charge units (CUs) are consumed.

Request syntax

GET /logs query=SELECT avg(latency) as avg_latency FROM  where __date__ >'2017-09-01 00:00:00' and __date__ < '2017-09-02 00:00:00'
Authorization: <AuthorizationString>
Date: Wed, 3 Sept. 2014 08:33:46 GMT
Host: big-game.cn-hangzhou.log.aliyuncs.com
x-log-bodyrawsize: 0
x-log-apiversion: 0.6.0
x-log-signaturemethod: hmac-sha1

Request parameters

  • Request headers

    The GetProjectLogs operation does not have operation-specific request headers. For information about the common request headers of Log Service API operations, see Common request headers.

  • Parameters
    Parameter Type Required Example Description
    query string Yes * | SELECT * FROM <logStoreName> where __line__ = 'abc' and __date__ >'2017-09-01 00:00:00' and __date__ < '2017-09-02 00:00:00'&line=20&offset=0 HTTP/1.1 The SQL statement

Response parameters

  • Response headers
    For information about the common response headers of Log Service API operations, see Common response headers. The following table describes the response headers specific to this operation.
    Parameter Type Description
    x-log-progress String The status of the query results. Valid values: Incomplete and Complete.
    x-log-count Integer The total number of logs in the query results.
    x-log-processed-rows Integer The number of rows that are processed in the query.
    x-log-elapsed-millisecond Integer The number of milliseconds that are consumed by the query.
  • Response elements
    The response body of the GetProjectLogs operation is an array that contains the information of each log. The following table describes the parameters of the response body.
    Parameter Type Description
    __time__ Integer The log timestamp. The timestamp follows the UNIX time format. It is the number of seconds that have elapsed since 00:00:00 Thursday, January 1, 1970.
    __source__ String The log source, which is specified when logs are written.
    [content] Key-value pair The original content of logs.

Examples

In this example, the logs whose topic is groupA are queried in a Logstore named app_log. The Logstore belongs to a project named big-game in the China (Hangzhou) region. The time range is from September 1, 2014, 00:00:00 to September 1, 2014, 22:00:00 and the keyword is "error". The query starts from the beginning of the time range. A maximum of 20 logs can be returned.
  • Sample requests 
    GET /logs/? query=SELECT * FROM <logStoreName> where __line__ = 'abc' and __date__ >'2017-09-01 00:00:00' and __date__ < '2017-09-02 00:00:00'&line=20&offset=0 HTTP/1.1
Authorization: <AuthorizationString>
Date: Wed, 3 Sept. 2014 08:33:46 GMT
Host: big-game.cn-hangzhou.log.aliyuncs.com // big-game is the project name. Replace it with the actual project name.
x-log-bodyrawsize: 0
x-log-apiversion: 0.4.0
x-log-signaturemethod: hmac-sha1
  • Sample responses 
    HTTP/1.1 200 OK
Content-MD5: 36F9F7F0339BEAF571581AF1B0AAAFB5
Content-Type: application/json
Content-Length: 269
Date: Wed, 3 Sept. 2014 08:33:47 GMT
x-log-requestid: efag01234-12341-15432f
x-log-progress : Complete
x-log-count : 10000
x-log-processed-rows: 10000
x-log-elapsed-millisecond:5
{
    "progress": "Complete",
    "count": 2,
    "logs": [
        {
            "__time__": 1409529660,
            "__source__": "10.237.0.17",
            "Key1": "error",
            "Key2": "Value2"
        },
        {
            "__time__": 1409529680,
            "__source__": "10.237.0.18",
            "Key3": "error",
            "Key4": "Value4"
        }
    ]
}

    In the sample response, the value of the x-log-progress parameter is Complete. This value indicates that all logs are queried and the returned results are complete. In this query, two logs that meet the query conditions are found. If the value of the x-log-progress parameter is Incomplete, you must resend the request to obtain the complete results.

Error codes

HTTP status code Error codes Error message Description
400 ParameterInvalid parameter is invalid. The error message returned because the specified parameter is invalid.

For more information about the error codes, see Common error codes.