Querying All Log Groups of an Account

Function

This API is used to query all log groups of an account.

URI

GET /v2/{project_id}/groups

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token.
Content-Type	Yes	String	Set this parameter to application/json;charset=UTF-8.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
log_groups	Array of LogGroup objects	Log group information.

**Table 4** LogGroup
Parameter	Type	Description
creation_time	Long	Time when a log group was created.
log_group_name	String	Log group name.
log_group_id	String	Log group ID.
ttl_in_days	Integer	Log retention period (days).
tag	Map<String,String>	Log group tags.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Query all log groups of an account.

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

/v2/{project_id}/groups

Example Responses

Status code: 200

The request is successful.

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

Status code: 401

Authentication failed. Check the token and try again.

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

Status code: 403

The request is rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.

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

Status code: 500

The server has received the request but encountered an internal error.

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

Status Codes

Status Code	Description
200	The request is successful.
401	Authentication failed. Check the token and try again.
403	The request is rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
500	The server has received the request but encountered an internal error.
503	The requested service is unavailable.