查询日志流信息
功能介绍
查询日志流信息。通过该接口可查询云日志服务的日志流详细信息,帮助您了解日志流的运行和管理情况,提供全面且准确的数据支持。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/log-streams
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参见:获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
log_group_name |
否 |
String |
参数解释: 日志组名称。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
log_stream_name |
否 |
String |
参数解释: 日志流名称。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 从IAM服务获取的用户Token,获取方式请参见:获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Content-Type |
是 |
String |
参数解释: 用于定义消息体的格式,该字段填为:application/json;charset=utf8。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
log_streams |
Array of LogStreamNoIsFavorite 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 |
参数解释: 过滤器个数(当前已经下线)。 取值范围: 不涉及。 |
hot_cold_separation |
Boolean |
参数解释: 是否开启冷存储。 取值范围:
|
whether_log_storage |
Boolean |
参数解释: 是否开启日志存储。 取值范围:
|
auth_web_tracking |
Boolean |
参数解释: 是否开启匿名写入。 取值范围:
|
ttl_in_days |
Integer |
参数解释: 日志组的存储时间,即日志上报到LTS后日志存储的时间。 取值范围: 不涉及。 |
hot_storage_days |
Integer |
参数解释: 标准存储时间。 取值范围: 不涉及。 |
is_favorite |
Boolean |
参数解释: 是否收藏日志流。 取值范围:
|
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码,请参见:错误码。 取值范围: 不涉及。 |
error_msg |
String |
参数解释: 调用失败响应信息描述。 取值范围: 不涉及。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码,请参见:错误码。 取值范围: 不涉及。 |
error_msg |
String |
参数解释: 调用失败响应信息描述。 取值范围: 不涉及。 |
请求示例
若不传参数则查询所有日志流信息。若根据log_group_name,log_stream_name这2种不同的参数,则查询对应的日志流信息。
GET https://{endpoint}/v2/{project_id}/log-streams /v2/{project_id}/log-streams /v2/{project_id}/log-streams?log_group_name={log_group_name} /v2/{project_id}/log-streams?log_stream_name={log_stream_name} /v2/{project_id}/log-streams?log_stream_name={log_stream_name} &log_group_name={log_group_name}
响应示例
状态码:200
查询日志流信息请求响应成功。
{ "log_streams" : [ { "log_stream_name_alias" : "lts-topic-xxxx", "creation_time" : 1698915657847, "auth_web_tracking" : false, "log_stream_name" : "lts-topic-xxxx", "is_favorite" : false, "hot_storage_days" : -1, "tag" : { "_sys_enterprise_project_id" : "xxxxxx" }, "hot_cold_separation" : false, "filter_count" : 0, "log_stream_id" : "xxxxxxx", "ttl_in_days" : 7, "whether_log_storage" : true }, { "log_stream_name_alias" : "lts-topic-xxxx", "creation_time" : 1698915650021, "auth_web_tracking" : false, "log_stream_name" : "lts-topic-xxxx", "is_favorite" : false, "hot_storage_days" : -1, "tag" : { "_sys_enterprise_project_id" : "xxxxxxx" }, "hot_cold_separation" : false, "filter_count" : 0, "log_stream_id" : "xxxxxxxxxxxxxxxxxxx", "ttl_in_days" : 7, "whether_log_storage" : true } ] }
状态码:400
非法请求,建议根据error_msg直接修改该请求。
{ "error_code" : "LTS.0205", "error_msg" : "The log stream name has been existed" }
状态码:500
表明服务端能被请求访问到,但是服务内部出错。
{ "error_code" : "LTS.0010", "error_msg" : "The system encountered an internal error" }
状态码
状态码 |
描述 |
---|---|
200 |
查询日志流信息请求响应成功。 |
400 |
非法请求,建议根据error_msg直接修改该请求。 |
500 |
表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。