Help Center/ Log Tank Service/ API Reference/ APIs/ Log Management/ Querying Structured Logs (New Version)
Updated on 2024-10-28 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Structured Logs (New Version)

Function

This API is used to query structured logs in a specified log stream (new version).

For details about the regions that support the new query function, 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. To analyze data older than 30 days using SQL statements, submit a service ticket.

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

Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.

log_stream_id

Yes

String

Log stream ID. For details about how to obtain a log stream ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

Content-Type

Yes

String

Set this parameter to application/json;charset=UTF-8.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

query

Yes

String

SQL statement.

format

Yes

String

Query result format. Only k-v is supported.

time_range

Yes

TimeRange object

Query time range.

whether_to_rows

No

Boolean

Whether the returned data format is row data. The default value is false.
Table 4 TimeRange

Parameter

Mandatory

Type

Description

sql_time_zone

No

String

Time zone. The default value is UTC.

start_time

Yes

Long

UTC start time of the search window (in milliseconds).

end_time

Yes

Long

UTC end time of the search window (in milliseconds).

start_time_gt

No

Boolean

Whether the start time is included in the search window. The default value is false.

end_time_lt

No

Boolean

Whether the end time is included in the search window. The default value is false.

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

message

message object

API calling message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

message

Message401 object

Response message.
Table 7 Message401

Parameter

Type

Description

code

String

Error code.

details

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

  • Querying structured logs

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

  • When query is set to select *:

    {
  "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:

    {
  "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):

    {
  "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:

    {
  "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.

  • When query is set to select *:

    {
  "result" : [ "system context", "global context", "global context", "system context", "system context" ]
}

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

    {
  "mycount" : [ 50 ],
  "mysum" : [ 7006779039596516000 ]
}

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

    {
  "mycount" : [ 32, 22 ],
  "mysum" : [ -3632218674319473000, -1344225381314777000 ]
}

  • When whether_to_rows is set to true:

    {
  "result" : [ {
    "mycount" : "32",
    "mysum" : "-3632218674319473398"
  }, {
    "mycount" : "22",
    "mysum" : "-1344225381314777019"
  } ]
}

Status code: 400

Bad Request: The request is invalid. Modify the request based on the description in error_msg before a retry.

{
  "message" : {
    "code" : "LTS.0601",
    "details" : "params validator error"
  }
}

Status code: 401

AuthFailed. Authentication failed. Check the token and try again.

{
  "message" : {
    "code" : "LTS.0001",
    "details" : "project verify error"
  }
}

Status code: 403

Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

{
  "error_code" : "LTS.0001",
  "error_msg" : "Invalid projectId"
}

Status code: 500

InternalServerError.

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

Bad Request: The request is invalid. Modify the request based on the description in error_msg before a retry.

401

AuthFailed. Authentication failed. Check the token and try again.

403

Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

500

InternalServerError.

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

Error Codes

See Error Codes.

Parent Topic: Log Management