Help Center/ Log Tank Service/ API Reference/ APIs/ Log Management/ Querying Structured Logs (Log Analysis)
Updated on 2025-08-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Structured Logs (Log Analysis)

Function

This API is used to use SQL statements to query structured logs in a specified log stream (Log Analysis tab page).

For details about the regions that support the query function on the Log Analysis tab page, see section "Log Visualization" in the User Guide. The number of data aggregation results does not exceed 10 billion. Only data generated in the last 30 days can be analyzed using SQL statements.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/streams/{log_stream_id}/struct-content/query

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. It can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

log_stream_id

Yes

String

Definition

Log stream ID. For details about how to obtain it, see Obtaining Log Group and Log Stream IDs.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token.

Constraints:

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Message body format. Set this parameter to application/json;charset=utf8.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

query

Yes

String

Definition

Analysis statement. For more information, see SQL Functions. For example, select time_ceil(__time,'PT1M') as t, count(*) as pv group by t is used to analyze the number of log lines per minute in the query time range.

Constraints

N/A

Range

N/A

Default Value

N/A

format

Yes

String

Definition

Format of the returned query results.

Constraints

N/A

Range

k-v

Default Value

k-v

time_range

Yes

TimeRange object

Definition

Time range for querying logs.

Constraints

The end time must be later than the start time.

The maximum time range is 30 days.

If you specify a time range that exceeds the log retention period set for the log stream, the intersection of the time range and the log retention period is queried by default.

whether_to_rows

No

Boolean

Definition

Whether the returned data is in the line format.

Constraints

N/A

Range

  • true: The returned data is in line format.

  • false: The returned data is in column format.

Default Value

false
Table 4 TimeRange

Parameter

Mandatory

Type

Description

sql_time_zone

No

String

Definition

Time zone setting for a SQL statement. It is used to convert the time zone of any time-related fields or function results returned by the query.

The time zone formats can be -0800, -08:00, America/Los_Angeles, or UTC.

For example, select MILLIS_TO_TIMESTAMP(0) as time converts a timestamp in milliseconds into a time type.

  • When sql_time_zone is set to UTC, the time returned is 1970-01-01T00:00:00.000Z.

  • When sql_time_zone is set to +0800, the time returned is 1970-01-01T08:00:00.000+08:00.

  • When sql_time_zone is set to America/Los_Angeles, the time returned is 1969-12-31T16:00:00.000-08:00.

Constraints

N/A

Range

N/A

Default Value

UTC

start_time

Yes

Long

Definition

Start time of a query. The value is a timestamp, measured in milliseconds from January 1, 1970, 00:00:00.000 UTC.

Constraints

N/A

Range

  • The value must be greater than 0.

  • If the value is less than the log stream's minimum log retention period, the value will be set to that minimum log retention period by default.

Default Value

N/A

end_time

Yes

Long

Definition

End time of a query. The value is a timestamp, measured in milliseconds from January 1, 1970, 00:00:00.000 UTC.

Constraints

N/A

Range

The value must be greater than 0.

Default Value

N/A

start_time_gt

No

Boolean

Definition

Whether the query time range includes the start time.

Constraints

N/A

Range

  • true: The time range includes the start time.

  • false: The time range does not include the start time.

Default Value

false

end_time_lt

No

Boolean

Definition

Whether the query time range includes the end time.

Constraints

N/A

Range

  • true: The time range includes the end time.

  • false: The time range does not include the end time.

Default Value

false

Response Parameters

Status code: 200

The request is successful.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code. For details, see Error Codes.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code. For details, see Error Codes.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Example Requests

  • When query is set to select *:

    POST https://{endpoint}/v2/{project_id}/streams/{log_stream_id}/struct-content/query

{
  "query" : "select *",
  "format" : "k-v",
  "time_range" : {
    "sql_time_zone" : "UTC",
    "start_time" : 1613806109000,
    "end_time" : 1613806110000,
    "start_time_gt" : false,
    "end_time_lt" : false
  }
}

  • When query is set to select count(test3) as mycount, sum(test4) as mysum:

    POST https://{endpoint}/v2/{project_id}/streams/{log_stream_id}/struct-content/query

{
  "query" : "select count(test3) as mycount, sum(test4) as mysum",
  "format" : "k-v",
  "time_range" : {
    "sql_time_zone" : "UTC",
    "start_time" : 1613806109000,
    "end_time" : 1613806110000,
    "start_time_gt" : false,
    "end_time_lt" : false
  }
}

  • When query is set to select count(test3), sum(test4) group by(test1):

    POST https://{endpoint}/v2/{project_id}/streams/{log_stream_id}/struct-content/query

{
  "query" : "select count(test3), sum(test4) group by(test1)",
  "format" : "k-v",
  "time_range" : {
    "sql_time_zone" : "UTC",
    "start_time" : 1613806109000,
    "end_time" : 1613806110000,
    "start_time_gt" : false,
    "end_time_lt" : false
  }
}

  • When whether_to_rows is set to true:

    POST https://{endpoint}/v2/{project_id}/streams/{log_stream_id}/struct-content/query

{
  "query" : "select count(test3), sum(test4) group by(test1)",
  "format" : "k-v",
  "time_range" : {
    "sql_time_zone" : "UTC",
    "start_time" : 1613806109000,
    "end_time" : 1613806110000,
    "start_time_gt" : false,
    "end_time_lt" : false
  },
  "whether_to_rows" : true
}

Example Responses

Status code: 200

The request is successful.

{
  "pv" : [ 90 ]
}

Status code: 400

Invalid request. Modify the request based on the description in error_msg before a retry.

{
  "error_code" : "LTS.2022",
  "error_msg" : "Column 'aa' not found in any table"
}

Status code: 500

The server has received the request but encountered an internal error.

{
  "error_code" : "LTS.0010",
  "error_msg" : "Internal Server Error"
}

SDK Sample Code

The SDK sample code is as follows.

  • When query is set to select *:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;


public class ListStructuredLogsWithTimeRangeSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListStructuredLogsWithTimeRangeRequest request = new ListStructuredLogsWithTimeRangeRequest();
        request.withLogStreamId("{log_stream_id}");
        QueryLtsStructLogParamsNew body = new QueryLtsStructLogParamsNew();
        TimeRange timeRangebody = new TimeRange();
        timeRangebody.withSqlTimeZone("UTC")
            .withStartTime(1613806109000L)
            .withEndTime(1613806110000L)
            .withStartTimeGt(false)
            .withEndTimeLt(false);
        body.withTimeRange(timeRangebody);
        body.withFormat("k-v");
        body.withQuery("select *");
        request.withBody(body);
        try {
            ListStructuredLogsWithTimeRangeResponse response = client.listStructuredLogsWithTimeRange(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • When query is set to select count(test3) as mycount, sum(test4) as mysum:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;


public class ListStructuredLogsWithTimeRangeSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListStructuredLogsWithTimeRangeRequest request = new ListStructuredLogsWithTimeRangeRequest();
        request.withLogStreamId("{log_stream_id}");
        QueryLtsStructLogParamsNew body = new QueryLtsStructLogParamsNew();
        TimeRange timeRangebody = new TimeRange();
        timeRangebody.withSqlTimeZone("UTC")
            .withStartTime(1613806109000L)
            .withEndTime(1613806110000L)
            .withStartTimeGt(false)
            .withEndTimeLt(false);
        body.withTimeRange(timeRangebody);
        body.withFormat("k-v");
        body.withQuery("select count(test3) as mycount, sum(test4) as mysum");
        request.withBody(body);
        try {
            ListStructuredLogsWithTimeRangeResponse response = client.listStructuredLogsWithTimeRange(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • When query is set to select count(test3), sum(test4) group by(test1):

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;


public class ListStructuredLogsWithTimeRangeSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListStructuredLogsWithTimeRangeRequest request = new ListStructuredLogsWithTimeRangeRequest();
        request.withLogStreamId("{log_stream_id}");
        QueryLtsStructLogParamsNew body = new QueryLtsStructLogParamsNew();
        TimeRange timeRangebody = new TimeRange();
        timeRangebody.withSqlTimeZone("UTC")
            .withStartTime(1613806109000L)
            .withEndTime(1613806110000L)
            .withStartTimeGt(false)
            .withEndTimeLt(false);
        body.withTimeRange(timeRangebody);
        body.withFormat("k-v");
        body.withQuery("select count(test3), sum(test4) group by(test1)");
        request.withBody(body);
        try {
            ListStructuredLogsWithTimeRangeResponse response = client.listStructuredLogsWithTimeRange(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • When whether_to_rows is set to true:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
    		 
    package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.lts.v2.region.LtsRegion;
import com.huaweicloud.sdk.lts.v2.*;
import com.huaweicloud.sdk.lts.v2.model.*;


public class ListStructuredLogsWithTimeRangeSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LtsClient client = LtsClient.newBuilder()
                .withCredential(auth)
                .withRegion(LtsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListStructuredLogsWithTimeRangeRequest request = new ListStructuredLogsWithTimeRangeRequest();
        request.withLogStreamId("{log_stream_id}");
        QueryLtsStructLogParamsNew body = new QueryLtsStructLogParamsNew();
        TimeRange timeRangebody = new TimeRange();
        timeRangebody.withSqlTimeZone("UTC")
            .withStartTime(1613806109000L)
            .withEndTime(1613806110000L)
            .withStartTimeGt(false)
            .withEndTimeLt(false);
        body.withWhetherToRows(true);
        body.withTimeRange(timeRangebody);
        body.withFormat("k-v");
        body.withQuery("select count(test3), sum(test4) group by(test1)");
        request.withBody(body);
        try {
            ListStructuredLogsWithTimeRangeResponse response = client.listStructuredLogsWithTimeRange(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

  • When query is set to select *:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListStructuredLogsWithTimeRangeRequest()
        request.log_stream_id = "{log_stream_id}"
        timeRangebody = TimeRange(
            sql_time_zone="UTC",
            start_time=1613806109000,
            end_time=1613806110000,
            start_time_gt=False,
            end_time_lt=False
        )
        request.body = QueryLtsStructLogParamsNew(
            time_range=timeRangebody,
            format="k-v",
            query="select *"
        )
        response = client.list_structured_logs_with_time_range(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • When query is set to select count(test3) as mycount, sum(test4) as mysum:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListStructuredLogsWithTimeRangeRequest()
        request.log_stream_id = "{log_stream_id}"
        timeRangebody = TimeRange(
            sql_time_zone="UTC",
            start_time=1613806109000,
            end_time=1613806110000,
            start_time_gt=False,
            end_time_lt=False
        )
        request.body = QueryLtsStructLogParamsNew(
            time_range=timeRangebody,
            format="k-v",
            query="select count(test3) as mycount, sum(test4) as mysum"
        )
        response = client.list_structured_logs_with_time_range(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • When query is set to select count(test3), sum(test4) group by(test1):

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListStructuredLogsWithTimeRangeRequest()
        request.log_stream_id = "{log_stream_id}"
        timeRangebody = TimeRange(
            sql_time_zone="UTC",
            start_time=1613806109000,
            end_time=1613806110000,
            start_time_gt=False,
            end_time_lt=False
        )
        request.body = QueryLtsStructLogParamsNew(
            time_range=timeRangebody,
            format="k-v",
            query="select count(test3), sum(test4) group by(test1)"
        )
        response = client.list_structured_logs_with_time_range(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • When whether_to_rows is set to true:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
    		 
    # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklts.v2.region.lts_region import LtsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklts.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LtsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LtsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListStructuredLogsWithTimeRangeRequest()
        request.log_stream_id = "{log_stream_id}"
        timeRangebody = TimeRange(
            sql_time_zone="UTC",
            start_time=1613806109000,
            end_time=1613806110000,
            start_time_gt=False,
            end_time_lt=False
        )
        request.body = QueryLtsStructLogParamsNew(
            whether_to_rows=True,
            time_range=timeRangebody,
            format="k-v",
            query="select count(test3), sum(test4) group by(test1)"
        )
        response = client.list_structured_logs_with_time_range(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

  • When query is set to select *:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListStructuredLogsWithTimeRangeRequest{}
	request.LogStreamId = "{log_stream_id}"
	sqlTimeZoneTimeRange:= "UTC"
	startTimeGtTimeRange:= false
	endTimeLtTimeRange:= false
	timeRangebody := &model.TimeRange{
		SqlTimeZone: &sqlTimeZoneTimeRange,
		StartTime: int64(1613806109000),
		EndTime: int64(1613806110000),
		StartTimeGt: &startTimeGtTimeRange,
		EndTimeLt: &endTimeLtTimeRange,
	}
	request.Body = &model.QueryLtsStructLogParamsNew{
		TimeRange: timeRangebody,
		Format: "k-v",
		Query: "select *",
	}
	response, err := client.ListStructuredLogsWithTimeRange(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • When query is set to select count(test3) as mycount, sum(test4) as mysum:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListStructuredLogsWithTimeRangeRequest{}
	request.LogStreamId = "{log_stream_id}"
	sqlTimeZoneTimeRange:= "UTC"
	startTimeGtTimeRange:= false
	endTimeLtTimeRange:= false
	timeRangebody := &model.TimeRange{
		SqlTimeZone: &sqlTimeZoneTimeRange,
		StartTime: int64(1613806109000),
		EndTime: int64(1613806110000),
		StartTimeGt: &startTimeGtTimeRange,
		EndTimeLt: &endTimeLtTimeRange,
	}
	request.Body = &model.QueryLtsStructLogParamsNew{
		TimeRange: timeRangebody,
		Format: "k-v",
		Query: "select count(test3) as mycount, sum(test4) as mysum",
	}
	response, err := client.ListStructuredLogsWithTimeRange(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • When query is set to select count(test3), sum(test4) group by(test1):

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListStructuredLogsWithTimeRangeRequest{}
	request.LogStreamId = "{log_stream_id}"
	sqlTimeZoneTimeRange:= "UTC"
	startTimeGtTimeRange:= false
	endTimeLtTimeRange:= false
	timeRangebody := &model.TimeRange{
		SqlTimeZone: &sqlTimeZoneTimeRange,
		StartTime: int64(1613806109000),
		EndTime: int64(1613806110000),
		StartTimeGt: &startTimeGtTimeRange,
		EndTimeLt: &endTimeLtTimeRange,
	}
	request.Body = &model.QueryLtsStructLogParamsNew{
		TimeRange: timeRangebody,
		Format: "k-v",
		Query: "select count(test3), sum(test4) group by(test1)",
	}
	response, err := client.ListStructuredLogsWithTimeRange(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • When whether_to_rows is set to true:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
    		 
    package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := lts.NewLtsClient(
        lts.LtsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListStructuredLogsWithTimeRangeRequest{}
	request.LogStreamId = "{log_stream_id}"
	sqlTimeZoneTimeRange:= "UTC"
	startTimeGtTimeRange:= false
	endTimeLtTimeRange:= false
	timeRangebody := &model.TimeRange{
		SqlTimeZone: &sqlTimeZoneTimeRange,
		StartTime: int64(1613806109000),
		EndTime: int64(1613806110000),
		StartTimeGt: &startTimeGtTimeRange,
		EndTimeLt: &endTimeLtTimeRange,
	}
	whetherToRowsQueryLtsStructLogParamsNew:= true
	request.Body = &model.QueryLtsStructLogParamsNew{
		WhetherToRows: &whetherToRowsQueryLtsStructLogParamsNew,
		TimeRange: timeRangebody,
		Format: "k-v",
		Query: "select count(test3), sum(test4) group by(test1)",
	}
	response, err := client.ListStructuredLogsWithTimeRange(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The request is successful.

400

Invalid request. Modify the request based on the description in error_msg before a retry.

500

The server has received the request but encountered an internal error.

Error Codes

See Error Codes.

Parent Topic: Log Management