文档首页/ 云日志服务 LTS/ API参考/ API说明/ 日志管理/ 查询上下文日志
更新时间：2024-12-20 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询上下文日志

功能介绍

该接口用于查询指定日志前（上文）后（下文）的若干条日志。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID

最小长度：32

最大长度：32

log_group_id

是

String

日志组ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID

最小长度：36

最大长度：36

log_stream_id

是

String

日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID

最小长度：36

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token，获取方式请参见：获取用户Token

最小长度：1000

最大长度：2000

Content-Type

是

String

该字段填为：application/json;charset=UTF-8。

最小长度：30

最大长度：30
表3 请求Body参数

参数

是否必选

参数类型

描述

line_num

否

String

日志单行序列号，字段值需要从日志结果中获取，纳秒级时间戳。

__time__

否

String

自定义时间特性时间字段，字段值需要从日志结果中获取，毫秒级时间戳。若已开启云端结构化自定义时间功能，需要使用该字段和line_num字段共同进行上下文查询。

backwardsSize

否

Integer

指定起始日志往前（上文）的日志条数，取值范围 [0, 500] ，默认值100

最小值：0

最大值：500

forwardsSize

否

Integer

指定起始日志往后（下文）的日志条数，取值范围 [0, 500] ，默认值100

最小值：0

最大值：500

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

logs

Array of LogContents objects

上下文日志信息。

total_count

Integer

返回的总日志条数，包含请求参数中所指定的起始日志。

backwards_count

Integer

向前查询到的日志条数。

最小值：0

最大值：500

forwards_count

Integer

向后查询到的日志条数。

最小值：0

最大值：500

isQueryComplete

Boolean

是否查询完成。
表5 LogContents

参数

参数类型

描述

content

String

日志原数据。

最小长度：1

最大长度：10000

line_num

String

日志单行序列号。

最小长度：19

最大长度：19

labels

Map<String,String>

该条日志包含的 labels,查询到的日志不同所包含的字段不同。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：8

error_msg

String

调用失败响应信息描述。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：8

error_msg

String

调用失败响应信息描述。

请求示例

  • 查询上下文日志

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

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

  • 查询上下文日志，且已开启云端结构化的自定义时间功能。

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

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

响应示例

状态码： 200

查询上下文日志数据请求响应成功

{
  "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"
  } ]
}

状态码： 400

BadRequest 非法请求建议根据error_msg直接修改该请求。

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

SDK代码示例

SDK代码示例如下。

  • 查询上下文日志

     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
    		 
    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());
        }
    }
}

  • 查询上下文日志，且已开启云端结构化的自定义时间功能。

     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 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());
        }
    }
}

  • 查询上下文日志

     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
    		 
    # 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)

  • 查询上下文日志，且已开启云端结构化的自定义时间功能。

     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
    		 
    # 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)

  • 查询上下文日志

     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
    		 
    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)
    }
}

  • 查询上下文日志，且已开启云端结构化的自定义时间功能。

     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
    		 
    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)
    }
}

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询上下文日志数据请求响应成功

400

BadRequest 非法请求建议根据error_msg直接修改该请求。

500

InternalServerError。 表明服务端能被请求访问到，但是服务内部出错。

错误码

请参见错误码。

父主题： 日志管理