调用GetContextLogs接口查询指定日志前(上文)后(下文)的若干条日志。
接口说明
接口说明
上下文查询的时间范围为起始日志的前后一天。
Host 由 Project 名称和日志服务 Endpoint 构成,您需要在 Host 中指定 Project。
已创建并获取 AccessKey。更多信息,请参见访问密钥。
阿里云账号 AccessKey 拥有所有 API 的访问权限,风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维。RAM 用户需具备操作日志服务资源的权限。具体操作,请参见创建 RAM 用户及授权。
已明确您查询日志所属的 Project 名称、所属地域、Logstore 名称等。如何查询,请参见管理 Project和管理 Logstore。
查询日志前,已配置索引。具体操作,请参见创建索引。
pack_id 和 pack_meta 字段属于内部字段,在执行查询前,您需要在日志服务控制台通过浏览器的调试功能获取字段值。
鉴权资源
下表列出了 API 对应的授权信息。您可以在 RAM 权限策略语句的 Action 元素中添加该信息,用于为 RAM 用户或 RAM 角色授予调用此 API 的权限。
| 动作(Action) | 授权策略中的资源描述方式(Resource) |
log:GetLogStoreContextLogs | acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName} |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /logstores/{logstore}?type=context_log HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| logstore |
string |
是 |
Logstore 名称。 |
test-logstore |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| project |
string |
是 |
Project 名称。 |
ali-test-project |
| pack_id |
string |
是 |
起始日志所属的 LogGroup 的唯一身份标识。 |
85C897C740352DC6-808 |
| pack_meta |
string |
是 |
起始日志在对应 LogGroup 内的唯一上下文结构标识。 |
2|MTY1NTcwNTUzODY5MTY0MDk1Mg==|3|0 |
| back_lines |
integer |
是 |
指定起始日志往前(上文)的日志条数,取值范围为 |
10 |
| forward_lines |
integer |
是 |
指定起始日志往后(下文)的日志条数,取值范围为 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| total_lines |
integer |
返回的总日志条数,包含请求参数中所指定的起始日志。 |
201 |
| back_lines |
integer |
向前查询到的日志条数。 |
100 |
| forward_lines |
integer |
向后查询到的日志条数。 |
100 |
| progress |
string |
查询的结果是否完整。
|
Complete |
| logs |
array<object> |
获取到的日志。 |
|
|
object |
获取到的日志,按上下文顺序排列。当根据指定起始日志查询不到上下文日志时,此参数为空。 |
{ "__index_number__": "-100", "__tag__:__pack_id__": "895CEA449A52FE-8c8", "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1"} |
logs 中的每一项都是该日志的内容(键值对),除用户日志内容外,还包含三个字段,具体如下:
| 参数名称 | 数据类型 | 示例值 | 描述 |
__index_number__ | String | -100 | 该日志在本次查询结果中相对上下文的位置,负数表示上文,0 表示起始日志,正数表示下文。例如:-100 表示起始日志往前的第 100 条日志。 |
__tag__:__pack_id__ | String | 895CEA449A52FE-8c8 | 该日志所属的 LogGroup 的唯一身份标识,可作为请求参数中的 pack_id 进行查询。 |
__pack_meta__ | String | 0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1 | 该日志在所属 LogGroup 内的唯一上下文结构标识,可作为请求参数中的 pack_meta 进行查询。 |
示例
正常返回示例
JSON格式
{
"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"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。