All Products
Search

This Product

    Simple Log Service：GetContextLogs

    Document Center

    Simple Log Service：GetContextLogs

    更新時間：Nov 28, 2024

    Queries the contextual logs of a specified log.

    Operation description

    Usage notes

    • You can specify a log as the start log. The time range of a contextual query is one day before and one day after the generation time of the start log.
    • Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
    • An AccessKey pair is created and obtained. For more information, see AccessKey pair.

    The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.

    • The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see Manage a project and Manage a Logstore.
    • Indexes are configured before you query logs. For more information, see Create indexes.
    • The values of the pack_id and pack_meta fields are obtained before you query logs. The fields are internal fields, and you can obtain the values by using the debugging feature of your browser in the Simple Log Service console.

    Authentication resources

    The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.

    ActionResource
    log:GetLogStoreContextLogsacs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request syntax

    GET /logstores/{logstore} HTTP/1.1

    Request parameters

    ParameterTypeRequiredDescriptionExample
    projectstringYes

    The name of the project.

    		ali-test-project
    logstorestringYes

    The name of the Logstore.

    		test-logstore
    pack_idstringYes

    The unique identifier of the log group to which the start log belongs.

    		85C897C740352DC6-808
    pack_metastringYes

    The unique context identifier of the start log in the log group.

    		2|MTY1NTcwNTUzODY5MTY0MDk1Mg==|3|0
    back_lineslongYes

    The number of logs that you want to obtain and are generated before the generation time of the start log. Valid values: (0,100].

    		10
    forward_lineslongYes

    The number of logs that you want to obtain and are generated after the generation time of the start log. Valid values: (0,100].

    		10

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    total_lineslong

    The total number of logs that are returned. The logs include the start log that is specified in the request.

    		201
    back_lineslong

    The number of logs that are generated before the generation time of the start log.

    		100
    forward_lineslong

    The number of logs that are generated after the generation time of the start log.

    		100
    progressstring

    Indicates whether the query and analysis results are complete. Valid values:

    • Complete: The query is successful, and the complete query and analysis results are returned.
    • Incomplete: The query is successful, but the query and analysis results are incomplete. To obtain the complete results, you must repeat the request.
    		Complete
    logsarray<object>

    The logs that are returned.

    object

    The logs that are returned. The logs are arranged in contextual order. If no contextual logs are found based on the specified start log, this parameter is empty.

    		{ "__index_number__": "-100", "__tag__:__pack_id__": "895CEA449A52FE-8c8", "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1" }

    The logs parameter contains log content and the following fields that are formatted in key-value pairs.

    FieldTypeExampleDescription
    __index_number__String-100The position of the log in the context. A negative value indicates that the log is generated before the generation time of the start log. The value 0 indicates that the log is the start log. A positive value indicates that the log is generated after the generation time of the start log. For example, the value -100 indicates that the log is the 100th log before the generation time of the start log.
    __tag__:__pack_id__String895CEA449A52FE-8c8The unique identifier of the log group to which the log belongs. The identifier can be used as the value of the pack_id parameter in the request.
    __pack_meta__String`0MTU1OTI4NTExMjg3NTQ2NDU1OA==

    Examples

    Sample success responses

    JSONformat

    {
  "total_lines": 201,
  "back_lines": 100,
  "forward_lines": 100,
  "progress": "Complete",
  "logs": [
    {
      "__index_number__": "-100",
      "__tag__:__pack_id__": "895CEA449A52FE-8c8",
      "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1"
    }
  ]
}

    Error codes

    For a list of error codes, visit the Service error codes.