更新时间:2024-01-09 GMT+08:00
分享

查询日志流信息

功能介绍

该接口用于查询LTS日志流信息。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/log-streams

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID

最小长度:32

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

log_group_name

String

日志组名称

最小长度:1

最大长度:64

log_stream_name

String

日志流名称

最小长度:1

最大长度:64

offset

Integer

查询游标,初始传入0,后续从上一次的返回值中获取

最小值:0

最大值:1024

limit

Integer

每页数据量,最大值为100

最小值:0

最大值:100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token,获取方式请参见:获取用户Token

最小长度:1000

最大长度:2000

Content-Type

String

该字段填为:application/json;charset=UTF-8。

最小长度:30

最大长度:30

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

log_streams

Array of LogStreamNoIsFavorite objects

日志组数组。

表5 LogStreamNoIsFavorite

参数

参数类型

描述

creation_time

Long

日志流创建时间

最小值:1577808000000

最大值:4102416000000

log_stream_id

String

日志流ID

最小长度:36

最大长度:36

log_stream_name

String

日志流名称

最小长度:1

最大长度:64

tag

Map<String,String>

日志流所属标签

filter_count

Integer

过滤器个数

最小值:0

最大值:5

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:8

error_msg

String

调用失败响应信息描述。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:8

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=lts-group-txxxx
/v2/{project_id}/log-streams?log_stream_name=lts-xunjian-topic-xxxx 
/v2/{project_id}/log-streams?log_stream_name=lts-xunjian-topic-xxxx&log_group_name=lts-group-xxx

响应示例

状态码: 200

查询日志流信息请求响应成功。

{
  "log_streams" : [ {
    "creation_time" : 1633600371062,
    "log_stream_name" : "lts-topic-test2",
    "tag" : {
      "_sys_enterprise_project_id" : "0",
      "W" : "J"
    },
    "filter_count" : 0,
    "log_stream_id" : "c4de0538-53e6-41fd-b951-a8669fce58d7"
  } ]
}

状态码: 400

BadRequest 非法请求 建议根据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

BadRequest 非法请求 建议根据error_msg直接修改该请求。

500

表明服务端能被请求访问到,但是服务内部出错。

错误码

请参见错误码

分享:

    相关文档

    相关产品