Torch Log Service
Torch Log Service
Torch Log Service
Document
Product News
Product Overview
Product Billing
User Guide
TLS Agent
AgentLoop
Resource management
Host group
Data collection
LogCollector collection
Introduction to LogCollector
Installation and upgrade
Collect host logs
Collect container logs
LogCollector plugins
Manage LogCollector
general reference
Data import
Cloud product log collection
TOS log collection
DBW log collection
VPN Log collection
VKE log collection
CLB log collection
CloudTrail log collection
CFW log collection
NTA log collection
ALB log collection
APMPlus log collection
veFaaS log collection
VPC log collection
veImageX log collection
TrafficRoute DNS log collection
DDoS log collection
WAF log collection
DCDN log collection
Multi-cloud security platform log collection
APIG log collection
Machine learning task log collection
CR log collection
Volcano Ark application lab log collection
FileNAS log collection
LLM Application Firewall Service log collection
vePFS log collection
Cloud security center log collection
EFS log collection
Data storage
Query and analysis
Configure log indexes
Query log
Analyze logs
Query and analyze logs using third-party tools
Associate external data source for log query
SQL function
SQL syntax
Visualization
Query and analysis charts
Summaries of query and analysis charts
Create dashboard
Use dashboard
Add dashboard filters and variables
Use other systems to analyze logs
Log application
Log applications for product observability
Log applications for large models observability
Coding Agent log app
ModelProvider log app
No-coding Agent log app
Log applications for basic service monitoring
Data processing
Data transformation
Syntax and functions
Global operation function
expression function
Data processing best practices
general reference
Data write processor
Data consumer processor
Data consumption and shipping
Ship logs to TOS
Ship logs to Kafka
Ship logs to Splunk
Alarm
Alarm policy
Alarm notification content
Alarm notification content template
alarm notification channel
Tracing service
Monitor Log Service
API reference
Project management API
Topic management API
Shard management API
Index management API
Log management API
Host group management API
Collection configuration management API
Data import API
Data processor API
Data transformation API
Data backflow API
SQL analysis API
Alarm management API
Consumer group management API
Kafka protocol consumption API
Tag management API
Trace storage API
Account management API
SDK reference
Go SDK
Java SDK
Python SDK
iOS SDK
C++ SDK
CLI reference
Best practices
Data collection
Query and analysis
permission management
Consumption and delivery
Visualization
Alarm
FAQs
Billing and cost FAQ
Data collection FAQ
Data storage FAQ
Index configuration FAQ
Query and analysis FAQ
Scheduled SQL tasks FAQ
Alarm FAQ
- Documentation
Torch Log ServiceAPI referenceLog management APIDescribeLogContext
Copy page
Download PDFLog management API
DescribeLogContext
Copy pageDownload PDFDescribeLogContext
Call the DescribeLogContext interface to view the context information of the specified log.
Usage notes
Torch Log Service supports viewing the context information of the specified log in the log source file when querying the log. After calling the interface SearchLogs, you can further view the context information of the specified log through this interface.
The related interfaces (SearchLogs, DescribeLogContext, and DescribeHistogram) share a quota for call frequency and concurrent limits, with specific restrictions as follows:
- For a single Volcano Engine account or IAM user, the request frequency limit for log query is 100 times/second, otherwise, the error ExceedQPSLimit will be received.
- For a single topic, the concurrent limit for log query is 15, otherwise, the error ExceedCountLimit will be received.
tip
- Only logs collected by LogCollector 1.0.6 or later support the context search. Log data uploaded by calling PutLogs through an SDK or using other methods does not support the context search.
- Before using the context search function, you need to configure the index for the topic. For details, please refer to Configure indexes.
Request syntax
- Request Method：POST
- Request URL：https://{tls-endpoint}/DescribeLogContext
Request parameters
The table below only lists the request parameters specific to this interface and some common parameters. For more information, please see Common parameters.
Body
Name | Type | Required | Example | Description |
Name | Type | Required | Example | Description |
TopicId | String | True | 4a****** | The ID of the topic. |
ContextFlow | String | True | e61050c-f7b3a4bf-2 | Specify the ID of the LogGroup where the log is located. You can get this ID from the Logs in the return information of the SearchLogs interface. |
PackageOffset | Long | True | 66 | Specify the log sequence number in the LogGroup. You can obtain this sequence number from the Logs in the return information of the SearchLogs interface. |
Source | String | True | 127...** | The IP Address of the source host for the logs. |
PrevLogs | Integer | False | 10 | Specify the number of preceding log entries, that is, how many log entries to view backward. The value range is 1 to 1000, and the default value is 10. |
NextLogs | Integer | False | 10 | Specify the number of following log entries, that is, how many log entries to view later. The value range is 1 to 1000, and the default value is 10. |
Responses
The table below only lists the return parameters specific to this interface. For more information, please refer to the Response message.
Name | Type | Example | Description |
Name | Type | Example | Description |
LogContextInfos | Array of JSON Map | / | Specify the context log information of the designated log. Arrange in the order of context. When no context log can be queried based on the specified start log, this parameter is empty. Among them, LogContextInfos displays the content of each log in the form of key-value pairs, and each log also contains the following two fields:
|
PrevOver | Boolean | true | Whether there is any other information besides the logs within LogContextInfos.
|
NextOver | Boolean | true | Whether there is any other next information besides the logs within LogContextInfos.
|
Sample Request
POST https://{tls-endpoint}/DescribeLogContext HTTP/1.1
Content-Type: application/json
{
"TopicId":"0fa67c30-d8e3-407f-a1d9-39d55cb7****",
"ContextFlow":"e61050c909dcccc3-f7b3a4bfaf6af941-8",
"PackageOffset":4,
"Source":"127.**.**.**",
"PrevLogs":10,
"NextLogs":10
}
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 0
{
"LogContextInfos": [
{
"__context_flow__": "e61050c909dcccc3-f7b3a4bfaf6af941-2",
"__package_offset__": "3",
"__path__": "/root/my_script/tls-conf-master/input_logs/log/hashkey.log",
"__source__": "127.**.**.**",
"__time__": 1655788239654,
"d": "1.23",
"index": "7",
"l": "987654321",
"l1": "12344566789",
"str": "hhhhhhhhh"
},
{
"__context_flow__": "e61050c909dcccc3-f7b3a4bfaf6af941-2",
"__package_offset__": "4",
"__path__": "/root/my_script/tls-conf-master/input_logs/log/hashkey.log",
"__source__": "127.**.**.**",
"__time__": 1655788239654,
"d": "1.23",
"index": "7",
"l": "987654321",
"l1": "12344566789",
"str": "hhhhhhhhh"
},
{
"__context_flow__": "e61050c909dcccc3-f7b3a4bfaf6af941-2",
"__package_offset__": "5",
"__path__": "/root/my_script/tls-conf-master/input_logs/log/hashkey.log",
"__source__": "127.**.**.**",
"__time__": 1655788239654,
"d": "1.23",
"index": "7",
"l": "987654321",
"l1": "12344566789",
"str": "hhhhhhhhh"
}
],
"PrevOver": true,
"NextOver": true
}
Error code
Last updated: 2025.10.29 14:35:21
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
