更新时间:2022-06-17 GMT+08:00

查询帐号下所有日志组

功能介绍

该接口用于查询帐号下所有日志组。

URI

GET /v2/{project_id}/groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见:获取帐号ID、项目ID、日志组ID、日志流ID。缺省值:None

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM获取的用户Token。

缺省值:None

最小长度:1000

最大长度:2000

Content-Type

String

该字段填为:application/json;charset=utf8。

缺省值:None

最小长度:29

最大长度:29

响应参数

状态码为 200 时:

表3 响应Body参数

参数

参数类型

描述

log_groups

Array of LogGroup objects

日志组信息。

表4 LogGroup

参数

参数类型

描述

creation_time

long

日志组创建时间。

log_group_name

String

日志组名称。

最小长度:1

最大长度:64

log_group_id

String

日志组ID。

最小长度:36

最大长度:36

ttl_in_days

Integer

日志存储时间(天)。

最小值:1

最大值:7

tag

Map<String,String>

日志组标签。

状态码为 401 时:

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

枚举值:

  • LTS.0403

error_msg

String

调用失败响应信息描述。

枚举值:

  • Invalid projectId

状态码为 403 时:

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

枚举值:

  • LTS.0403

error_msg

String

调用失败响应信息描述。

枚举值:

  • Invalid projectId

状态码为 500 时:

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

枚举值:

  • LTS.0403

error_msg

String

调用失败响应信息描述。

枚举值:

  • Invalid projectId

请求示例

GET https://{endpoint}/v2/{project_id}/groups

/v2/{project_id}/groups

响应示例

状态码为 200 时:

{"log_groups":[{"creation_time":1630547141853,"log_group_name":"lts-group-01nh","log_group_id":"b6b9332b-091f-4b22-b810-264318d2d664","ttl_in_days":7}]}

状态码为 401 时:

AuthFailed。鉴权失败, 请确认token后再次请求 。

{
  "error_code" : "LTS.0003",
  "error_msg" : "Invalid token"
}

状态码为 403 时:

Forbidden。 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

{
  "error_code" : "LTS.0001",
  "error_msg" : "Invalid projectId"
}

状态码为 500 时:

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

{
  "error_code" : "LTS.0010",
  "error_msg" : "The system encountered an internal error"
}

状态码

状态码

描述

200

请求响应成功。

401

AuthFailed。鉴权失败,请确认token后再次请求 。

403

Forbidden。 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

500

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

503

ServiceUnavailable。 被请求的服务无效,服务不可用。

错误码

请参见错误码