tencent cloud

All product documents
APIs
DocumentationAPIsCloud Log ServiceLog APIsDescribeLogContext
DescribeLogContext
Last updated: 2024-04-15 19:58:33
DescribeLogContext
Last updated: 2024-04-15 19:58:33

1. API Description

Domain name for API request: cls.tencentcloudapi.com.

This API is used to search for content near the log context. For more details, see Context Search.The maximum value of API's return data packet is 49MB. It is recommended to enable gzip compression (HTTP Request Header Accept-Encoding: gzip).

A maximum of 20 requests can be initiated per second for this API.

This action accepts http content encodings: gzip

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeLogContext.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region No String Common Params. This parameter is not required for this API.
TopicId Yes String Log topic ID to be queried
BTime Yes String Log time in the format of YYYY-mm-dd HH:MM:SS.FFF
PkgId Yes String Log package sequence number. PkgId in the Results structure of the returned information of SearchLog API.
PkgLogId Yes Integer Sequence number of a log within the log package.
The PkgLogId in the Results structure of the SearchLog API returned information.
PrevLogs No Integer The previous ${PrevLogs} logs. Default value: 10.
NextLogs No Integer The next ${NextLogs} logs. Default value: 10.

3. Output Parameters

Parameter Name Type Description
LogContextInfos Array of LogContextInfo Log context information set
PrevOver Boolean Whether the previous logs have been fully returned (PrevOver is false indicates that some previous logs are yet to be returned).
NextOver Boolean Whether the subsequent logs have been fully returned (NextOver is false indicates that some subsequent logs are yet to be returned).
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the Context of a Log

This example shows you how to query the context of a log.

Input Example

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogContext
<Common request parameters>

{
    "TopicId": "682d0718-07bb-4ec0-9fda-f1e9a2767e0b",
    "BTime": "2021-04-25 14:25:00.000",
    "PkgId": "528C1318606EFEB8-1A7",
    "PkgLogId": 65536,
    "PrevLogs": 10,
    "NextLogs": 10
}

Output Example

{
    "Response": {
        "NextOver": false,
        "PrevOver": false,
        "LogContextInfos": [
            {
                "Content": "xxxxxxx",
                "HostName": "abc",
                "Filename": "/usr/local/services/cls_cgi_api3-1.0/log/cls_cgi.log.20210425",
                "PkgId": "528C1318606EFEB8-1A0",
                "PkgLogId": 196609,
                "Source": "100.105.60.255",
                "BTime": 323232323
            },
            {
                "Content": "x1x2x3",
                "HostName": "abcd",
                "Filename": "/usr/local/services/cls_cgi_api3-1.0/log/cls_cgi.log.20210425",
                "PkgId": "528C1318606EFEB8-1A1",
                "PkgLogId": 196609,
                "Source": "100.105.60.255",
                "BTime": 323232323
            }
        ],
        "RequestId": "b276cb6e-4687-11eb-b378-0242ac130002"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.InvalidContext The search cursor is invalid or does not exist.
FailedOperation.QueryError The query statement failed to run.
FailedOperation.SearchTimeout The query timed out.
FailedOperation.SyntaxError An error occurred while parsing the query statement.
FailedOperation.TopicIsolated The log topic has been isolated.
InternalError Internal error.
InternalError.SearchFailed Retrieval failed
InvalidParameter Incorrect parameter.
LimitExceeded.LogSearch The number of concurrent queries exceeds the limit, which is 15 per topic.
LimitExceeded.SearchResultTooLarge The number of logs returned by the search API exceeds the upper limit (20 MB).
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.AccountDestroy The account has been terminated.
OperationDenied.AccountIsolate The account has overdue payments.
OperationDenied.AccountNotExists The account does not exist.
ResourceNotFound.TopicNotExist The log topic does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon