查询指定日志组下的所有日志流
功能介绍
查询指定日志组下的所有日志流信息。通过该接口可以获取指定日志组下的所有日志流详情,详细展示每条日志的具体情况,为您提供日志流信息查询方式,满足日志管理的多样化需求。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/groups/{log_group_id}/streams
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参见:获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
log_group_id |
是 |
String |
参数解释: 日志组ID,获取方式请参见:获取日志组ID和日志流ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 从IAM服务获取的用户Token,获取方式请参见:获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
Content-Type |
是 |
String |
参数解释: 用于定义消息体的格式,该字段填为:application/json;charset=utf8。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
log_streams |
Array of LogStreamResBody objects |
参数解释: 日志流相关配置信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
creation_time |
Long |
参数解释: 日志流创建时间。UNIX 时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的毫秒数。 取值范围: 最小值:1577808000000 最大值:4102416000000 |
|
log_stream_id |
String |
参数解释: 日志流ID。 取值范围: 不涉及。 |
|
log_stream_name |
String |
参数解释: 日志流名称。 取值范围: 不涉及。 |
|
log_stream_name_alias |
String |
参数解释: 日志流名称别名。 取值范围: 不涉及。 |
|
tag |
Map<String,String> |
参数解释: 日志流的标签信息。日志流的标签信息,以键值对(key-value)的形式表示,key和value为一一对应关系。
|
|
filter_count |
Integer |
参数解释: 过滤器个数(当前已经下线)。 取值范围: 不涉及。 |
|
is_favorite |
Boolean |
参数解释: 是否收藏日志流。 取值范围:
|
|
whether_log_storage |
Boolean |
参数解释: 是否开启日志存储。 取值范围:
|
|
hot_cold_separation |
Boolean |
参数解释: 是否开启冷存储。 取值范围:
|
|
auth_web_tracking |
Boolean |
参数解释: 是否开启匿名写入。 取值范围:
|
|
ttl_in_days |
Integer |
参数解释: 日志组的存储时间,即日志上报到LTS后日志存储的时间。 取值范围: 不涉及。当为-1时,表示日志流保存时间默认继承所属日志组保存时间。 |
|
hot_storage_days |
Integer |
参数解释: 标准存储时间。 取值范围: 不涉及。当为-1时,表示此日志流未开启冷热存储。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码,请参见:错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 调用失败响应信息描述。 取值范围: 不涉及。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码,请参见:错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 调用失败响应信息描述。 取值范围: 不涉及。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码,请参见:错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 调用失败响应信息描述。 取值范围: 不涉及。 |
请求示例
查询指定日志组下的所有日志流。
GET https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams
/v2/{project_id}/groups/{log_group_id}/streams
响应示例
状态码:200
请求响应成功。
{
"log_streams" : [ {
"log_stream_name_alias" : "3",
"creation_time" : 1723102152593,
"auth_web_tracking" : false,
"log_stream_name" : "3",
"is_favorite" : false,
"hot_storage_days" : -1,
"tag" : {
"_sys_enterprise_project_id" : "0"
},
"hot_cold_separation" : false,
"filter_count" : 0,
"log_stream_id" : "667293b4-7f6d-4efb-9b30-xxxxxxx",
"ttl_in_days" : -1,
"whether_log_storage" : true
}, {
"log_stream_name_alias" : "5",
"creation_time" : 1723102172632,
"auth_web_tracking" : false,
"log_stream_name" : "5",
"is_favorite" : false,
"hot_storage_days" : -1,
"tag" : {
"_sys_enterprise_project_id" : "0"
},
"hot_cold_separation" : false,
"filter_count" : 0,
"log_stream_id" : "fb08a859-69ed-4bbe-9ba0-xxxxxxxx",
"ttl_in_days" : -1,
"whether_log_storage" : true
} ]
}
状态码:401
鉴权失败,请确认token后再次请求 。
{
"error_code" : "LTS.0003",
"error_msg" : "Invalid token"
}
状态码:403
请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
{
"error_code" : "LTS.0001",
"error_msg" : "Invalid projectId"
}
状态码:500
表明服务端能被请求访问到,但是服务内部出错。
{
"error_code" : "LTS.0010",
"error_msg" : "The system encountered an internal error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求响应成功。 |
|
401 |
鉴权失败,请确认token后再次请求 。 |
|
403 |
请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
|
500 |
表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。