Help Center/ Log Tank Service/ API Reference/ APIs/ Log Management/ Querying Context Logs

Updated on 2024-12-20 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Context Logs

Function

This API is used to query logs before and after a specified log.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/context

**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. Minimum: 32 Maximum: 32
log_group_id	Yes	String	Log group ID. For details about how to obtain a log group ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID. Minimum: 36 Maximum: 36
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. Minimum: 36 Maximum: 36

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. Minimum: 1000 Maximum: 2000
Content-Type	Yes	String	Set this parameter to application/json;charset=UTF-8. Minimum: 30 Maximum: 30

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
line_num	No	String	Sequence number of a log line. The field's value is a timestamp in nanoseconds, which must be obtained from the log result.
__time__	No	String	Time field of the custom time function. The field's value is a timestamp in milliseconds, which must be obtained from the log result. If the custom time function has been enabled for cloud structuring, use this field with the line_num field for querying log context.
backwardsSize	No	Integer	Number of logs before the start log. The value ranges from 0 to 500, and the default value is 100. Minimum: 0 Maximum: 500
forwardsSize	No	Integer	Number of logs after the start log. The value ranges from 0 to 500, and the default value is 100. Minimum: 0 Maximum: 500

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
logs	Array of LogContents objects	Context log information.
total_count	Integer	Total number of returned logs, including the start log specified in the request parameters.
backwards_count	Integer	Number of logs queried forward. Minimum: 0 Maximum: 500
forwards_count	Integer	Number of logs queried backward. Minimum: 0 Maximum: 500
isQueryComplete	Boolean	Whether the query is complete.

**Table 5** LogContents
Parameter	Type	Description
content	String	Raw log data. Minimum: 1 Maximum: 10000
line_num	String	Sequence number of a log line. Minimum: 19 Maximum: 19
labels	Map<String,String>	Labels contained in a log event. The labels vary depending on log events.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 8 Maximum: 8
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum: 8 Maximum: 8
error_msg	String	Error message.

Example Requests

Query context logs.

POST https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/context

{
  "line_num" : "1725154216000000000",
  "backwardsSize" : 100,
  "forwardsSize" : 100
}

Query context logs and enable the custom time function for cloud structuring.

POST https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/context

{
  "line_num" : "1725154216000000000",
  "__time__" : "1725154216000",
  "backwardsSize" : 100,
  "forwardsSize" : 100
}

Example Responses

Status code: 200

Response to the request for querying context log data succeeded.

{
  "total_count" : 3,
  "backwards_count" : 1,
  "forwards_count" : 2,
  "logs" : [ {
    "content" : "2024-09-01/09:30:00 this log is Error NO 1",
    "labels" : {
      "appName" : "default_appname",
      "containerName" : "CONFIG_FILE",
      "clusterName" : "CONFIG_FILE",
      "podName" : "default_procname",
      "clusterId" : "CONFIG_FILE",
      "nameSpace" : "CONFIG_FILE",
      "category" : "LTS"
    },
    "line_num" : "1725154215000000000"
  }, {
    "content" : "2024-09-01/09:30:01 this log is Error NO 1",
    "labels" : {
      "appName" : "default_appname",
      "containerName" : "CONFIG_FILE",
      "clusterName" : "CONFIG_FILE",
      "podName" : "default_procname",
      "clusterId" : "CONFIG_FILE",
      "nameSpace" : "CONFIG_FILE",
      "category" : "LTS"
    },
    "line_num" : "1725154216000000000"
  }, {
    "content" : "2024-09-01/09:30:02 this log is Error NO 1",
    "labels" : {
      "appName" : "default_appname",
      "containerName" : "CONFIG_FILE",
      "clusterName" : "CONFIG_FILE",
      "podName" : "default_procname",
      "clusterId" : "CONFIG_FILE",
      "nameSpace" : "CONFIG_FILE",
      "category" : "LTS"
    },
    "line_num" : "1725154217000000000"
  } ]
}

Status code: 400

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

{
  "error_code" : "LTS.0009",
  "error_msg" : "Failed to validate the request body"
}

SDK Sample Code

The SDK sample code is as follows.

Query context logs.

        
         
           
           
             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 ListLogContextSolution {

    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();
        ListLogContextRequest request = new ListLogContextRequest();
        request.withLogGroupId("{log_group_id}");
        request.withLogStreamId("{log_stream_id}");
        ListLogContextRequestBody body = new ListLogContextRequestBody();
        body.withForwardsSize(100);
        body.withBackwardsSize(100);
        body.withLineNum("1725154216000000000");
        request.withBody(body);
        try {
            ListLogContextResponse response = client.listLogContext(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());
        }
    }
}

            

          

        
       

Query context logs and enable the custom time function for cloud structuring.

        
         
           
           
             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 ListLogContextSolution {

    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();
        ListLogContextRequest request = new ListLogContextRequest();
        request.withLogGroupId("{log_group_id}");
        request.withLogStreamId("{log_stream_id}");
        ListLogContextRequestBody body = new ListLogContextRequestBody();
        body.withForwardsSize(100);
        body.withBackwardsSize(100);
        body.withTime("1725154216000");
        body.withLineNum("1725154216000000000");
        request.withBody(body);
        try {
            ListLogContextResponse response = client.listLogContext(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());
        }
    }
}

            

          

        
       

Query context logs.

        
         
           
           
             # 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 = ListLogContextRequest()
        request.log_group_id = "{log_group_id}"
        request.log_stream_id = "{log_stream_id}"
        request.body = ListLogContextRequestBody(
            forwards_size=100,
            backwards_size=100,
            line_num="1725154216000000000"
        )
        response = client.list_log_context(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

Query context logs and enable the custom time function for cloud structuring.

        
         
           
           
             # 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 = ListLogContextRequest()
        request.log_group_id = "{log_group_id}"
        request.log_stream_id = "{log_stream_id}"
        request.body = ListLogContextRequestBody(
            forwards_size=100,
            backwards_size=100,
            time__="1725154216000",
            line_num="1725154216000000000"
        )
        response = client.list_log_context(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

Query context logs.

        
         
           
           
             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.ListLogContextRequest{}
	request.LogGroupId = "{log_group_id}"
	request.LogStreamId = "{log_stream_id}"
	forwardsSizeListLogContextRequestBody:= int32(100)
	backwardsSizeListLogContextRequestBody:= int32(100)
	lineNumListLogContextRequestBody:= "1725154216000000000"
	request.Body = &model.ListLogContextRequestBody{
		ForwardsSize: &forwardsSizeListLogContextRequestBody,
		BackwardsSize: &backwardsSizeListLogContextRequestBody,
		LineNum: &lineNumListLogContextRequestBody,
	}
	response, err := client.ListLogContext(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

Query context logs and enable the custom time function for cloud structuring.

        
         
           
           
             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.ListLogContextRequest{}
	request.LogGroupId = "{log_group_id}"
	request.LogStreamId = "{log_stream_id}"
	forwardsSizeListLogContextRequestBody:= int32(100)
	backwardsSizeListLogContextRequestBody:= int32(100)
	timeListLogContextRequestBody:= "1725154216000"
	lineNumListLogContextRequestBody:= "1725154216000000000"
	request.Body = &model.ListLogContextRequestBody{
		ForwardsSize: &forwardsSizeListLogContextRequestBody,
		BackwardsSize: &backwardsSizeListLogContextRequestBody,
		Time: &timeListLogContextRequestBody,
		LineNum: &lineNumListLogContextRequestBody,
	}
	response, err := client.ListLogContext(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	Response to the request for querying context log data succeeded.
400	Invalid request. Modify the request based on the description in error_msg before a retry.
500	InternalServerError. The server has received the request but encountered an internal error.