# 查询上下文日志 - ListLogContext #### 功能介绍 该接口用于查询指定日志前（上文）后（下文）的若干条日志。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-lts/lts_api_0003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lts/lts_api_0046.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | lts:logStream:searchLogContext | Read | logStream \* | g:ResourceTag/\ | lts:logs:list | - | #### URI POST /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/context 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，可以从调用API处获取，也可以从控制台获取。获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-lts/lts_api_0006.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | log_group_id | 是 | String | **参数解释：** 日志组ID，获取方式请参见：[获取日志组ID和日志流ID](https://support.huaweicloud.com/api-lts/lts_api_0014.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | log_stream_id | 是 | String | **参数解释：** 日志流ID，获取方式请参见：[获取日志组ID和日志流ID](https://support.huaweicloud.com/api-lts/lts_api_0014.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token，获取方式请参见：[获取用户Token](https://support.huaweicloud.com/api-lts/lts_api_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | Content-Type | 是 | String | **参数解释：** 用于定义消息体的格式，该字段填为：application/json;charset=utf8。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | line_num | 否 | String | **参数解释：** 日志单行序列号，起始日志的唯一身份标识。该参数从上次查询的返回结果中获取。 **约束限制：** - 若已开启云端结构化自定义时间功能，需要使用该字段和__time__字段共同查询上下文，确保查询上下文准确性。 **取值范围：** 纳秒级时间戳，表示从1970-1-1 00:00:00 UTC开始计算的纳秒数。 **默认取值：** 不涉及。 | | __time__ | 否 | String | **参数解释：** 云端结构化自定义时间功能的时间字段，该参数从上次查询的返回结果中获取。 **约束限制：** 若已开启云端结构化自定义时间功能，需要使用该字段和line_num字段共同查询上下文，确保查询上下文准确性。 **取值范围：** 毫秒级时间戳，表示从1970-1-1 00:00:00 UTC开始计算的毫秒数。 **默认取值：** 不涉及。 | | scroll_id | 否 | String | **参数解释：** 查询上下文时，若上次查询的返回结果中包含字段scrollId，需要增加该字段参与查询上下文。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | backwards_size | 否 | Integer | **参数解释：** 指定起始日志往前（上文）的日志条数。 **约束限制：** 不涉及。 **取值范围：** - 最小值：0 - 最大值：500 **默认取值：** 100 | | forwards_size | 否 | Integer | **参数解释：** 指定起始日志往后（下文）的日志条数。 **约束限制：** 不涉及。 **取值范围：** - 最小值：0 - 最大值：500 **默认取值：** 100 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | logs | Array of [LogContents] objects | **参数解释：** 日志信息。 | | total_count | Integer | **参数解释：** 返回的总日志条数，包含请求参数中所指定的起始日志。 **取值范围：** 不涉及。 | | backwards_count | Integer | **参数解释：** 向前查询到的日志条数。 **取值范围：** 不涉及。 | | forwards_count | Integer | **参数解释：** 向后查询到的日志条数。 **取值范围：** 不涉及。 | | isQueryComplete | Boolean | **参数解释：** 是否查询完成。 **取值范围：** - true：查询完成。 - false：未查询完成。 | 表5LogContents | 参数 | 参数类型 | 描述 | |:---|:---|:---| | content | String | **参数解释：** 日志原数据。 **取值范围：** 不涉及。 | | line_num | String | **参数解释：** 日志单行序列号。 **取值范围：** 不涉及。 | | labels | Map\ | **参数解释：** 该条日志包含的labels，查询到的日志不同所包含的字段不同。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | #### 请求示例 - 查询上下文日志 ``` POST https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/context { "line_num" : "1725154216000000000", "backwards_size" : 100, "forwards_size" : 100 } ``` - 查询上下文日志，且已开启云端结构化的自定义时间功能。 ``` POST https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/context { "line_num" : "1725154216000000000", "__time__" : "1725154216000", "backwards_size" : 100, "forwards_size" : 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" } ], "isQueryComplete" : true } ``` **状态码：400** 非法请求。 ``` { "error_code" : "LTS.0009", "error_msg" : "Failed to validate the request body" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] - 查询上下文日志 ``` 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("")) .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()); } } } ``` - 查询上下文日志，且已开启云端结构化的自定义时间功能。 ``` 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("")) .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()); } } } ``` - [Python] - 查询上下文日志 ``` # 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("")) \ .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) ``` - 查询上下文日志，且已开启云端结构化的自定义时间功能。 ``` # 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("")) \ .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) ``` - [Go] - 查询上下文日志 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := lts.LtsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := lts.NewLtsClient(hcClient) 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) } } ``` - 查询上下文日志，且已开启云端结构化的自定义时间功能。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := lts.LtsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := lts.NewLtsClient(hcClient) 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](https://console.huaweicloud.com/apiexplorer/#/openapi/LTS/sdk?api=ListLogContext)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询上下文日志数据请求响应成功 | | 400 | 非法请求。 | | 500 | 表明服务端能被请求访问到，但是服务内部出错。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。