Contact UsGet started

Cloud Logging Service, gRPC: LogGroupService.List

Written by
Updated at December 17, 2024

Retrieves the list of log groups in the specified folder.

gRPC request

rpc List (ListLogGroupsRequest) returns (ListLogGroupsResponse)

ListLogGroupsRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

folder_id

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.

page_size

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.next_page_token
that can be used to get the next page of results in subsequent list requests.

Default value: 100.

page_token

string

Page token. To get the next page of results, set page_token to the
ListLogGroupsResponse.next_page_token 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.

ListLogGroupsResponse

{
  "groups": [
    {
      "id": "string",
      "folder_id": "string",
      "cloud_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "labels": "map<string, string>",
      "status": "Status",
      "retention_period": "google.protobuf.Duration",
      "data_stream": "string"
    }
  ],
  "next_page_token": "string"
}

Field

Description

groups[]

LogGroup

List of log groups in the specified folder.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListLogGroupsRequest.page_size, use next_page_token as the value
for the ListLogGroupsRequest.page_token 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.

folder_id

string

Log group folder ID.

cloud_id

string

Log group cloud ID.

created_at

google.protobuf.Timestamp

Log group creation time.

name

string

Log group name.

description

string

Log group description.

labels

object (map<string, 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.

retention_period

google.protobuf.Duration

Log group entry retention period.

Entries will be present in group during this period.

data_stream

string

Data stream name
Previous
Stats
Next
Create