Contact UsGet started

Cloud Logging Service, REST: LogGroup.List

Written by
Updated at October 17, 2024

Retrieves the list of log groups in the specified folder.

HTTP request

GET https://logging.api.cloud.yandex.net/logging/v1/logGroups

Query parameters

Field

Description

folderId

string

Required field. Folder ID of the log groups to return.

To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListLogGroupsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

Default value: 100.

pageToken

string

Page token. To get the next page of results, set page_token to the
ListLogGroupsResponse.nextPageToken returned by a previous list request.

filter

string

A filter expression that filters log groups listed in the response.

The expression must specify:

  1. The field name. Currently filtering can only be applied to the LogGroup.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].
    Example of a filter: name=my-log-group.

Response

HTTP Code: 200 - OK

{
  "groups": [
    {
      "id": "string",
      "folderId": "string",
      "cloudId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "string",
      "status": "string",
      "retentionPeriod": "string",
      "dataStream": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

groups[]

LogGroup

List of log groups in the specified folder.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListLogGroupsRequest.pageSize, use next_page_token as the value
for the ListLogGroupsRequest.pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

LogGroup

Field

Description

id

string

Log group ID.

folderId

string

Log group folder ID.

cloudId

string

Log group cloud ID.

createdAt

string (date-time)

Log group creation time.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Log group name.

description

string

Log group description.

labels

string

Log group labels.

status

enum (Status)

Status of the log group.

  • STATUS_UNSPECIFIED: Unknown status.

    Should never occur.

  • CREATING: Log group is creating.

  • ACTIVE: Log group is ready to accept messages,

  • DELETING: Log group is being deleted.

    No messages will be accepted.

  • ERROR: Log group is in failed state.

retentionPeriod

string (duration)

Log group entry retention period.

Entries will be present in group during this period.

dataStream

string

Data stream name
Previous
Stats
Next
Create