Queries the contextual logs of a specified log.
Operation description
- 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.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| log:GetLogStoreContextLogs | Read |
|
| none |
Request syntax
GET /logstores/{logstore}
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| project | string | Yes | The name of the project. | ali-test-project |
| logstore | string | Yes | The name of the Logstore. | test-logstore |
| type | string | Yes | The type of the data in the Logstore. Set the value to context_log. | context_log |
| pack_id | string | Yes | The unique identifier of the log group to which the start log belongs. | 85C897C740352DC6-808 |
| pack_meta | string | Yes | The unique context identifier of the start log in the log group. | 2|MTY1NTcwNTUzODY5MTY0MDk1Mg==|3|0 |
| back_lines | long | Yes | 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_lines | long | Yes | 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
The logs parameter contains log content and the following fields that are formatted in key-value pairs.
| Field | Type | Example | Description |
|---|---|---|---|
__index_number__ | String | -100 | The 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__ | String | 895CEA449A52FE-8c8 | The 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 | 0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1 | The unique context identifier of the log in the log group. The identifier can be used as the value of the pack_meta parameter in the request. |
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.