查询日志流信息
功能介绍
该接口用于查询LTS日志流信息。
URI
GET /v2/{project_id}/log-streams
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方式请参见:获取账号ID、日志组ID、日志流ID。 缺省值:None 最小长度:32 最大长度:32 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| log_group_name | 否 | String | 日志组名称 最小长度:1 最大长度:64 |
| log_stream_name | 否 | String | 日志流名称 最小长度:1 最大长度:64 |
| offset | 否 | Integer | 查询游标,初始传入0,后续从上一次的返回值中获取 最小值:0 最大值:1024 |
| limit | 否 | Integer | 每页数据量,最大值为100 最小值:0 最大值:100 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 缺省值:None 最小长度:1000 最大长度:2000 |
| Content-Type | 是 | String | 该字段填为:application/json;charset=UTF-8。 缺省值:None 最小长度:30 最大长度:30 |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| log_streams | Array of LogStream objects | 日志组数组。 数组长度:0 - 100 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| creation_time | Long | 创建时间 |
| log_stream_name | String | 日志流名称 最小长度:1 最大长度:64 |
| log_stream_id | String | 日志流ID 最小长度:36 最大长度:36 |
| filter_count | Integer | 过滤器个数 最小值:0 最大值:5 |
| tag | Map<String,String> | 日志流所属标签 |
| is_favorite | Boolean | 是否收藏 |
状态码: 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 最小长度:8 最大长度:8 |
| error_msg | String | 调用失败响应信息描述。 最小长度:1 最大长度:1000 |
状态码: 500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 最小长度:8 最大长度:8 |
| error_msg | String | 调用失败响应信息描述。 最小长度:1 最大长度:1000 |
请求示例
若不传参数则查询所有日流信息。若根据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" : 1684725311230,
"log_stream_name" : "lts-xxxx-lmytest-0522-12",
"is_favorite" : true,
"tag" : {
"_sys_enterprise_project_id" : "0",
"tag" : "66666@.com",
"tag5" : "test5"
},
"filter_count" : 0,
"log_stream_id" : "f5fdce2d-xxxx-4689-8b8a-90d269f7db76"
} ]
} 状态码: 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 | 表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。