Cloud Logging Service, REST: LogGroup.list
Retrieves the list of log groups in the specified folder.
HTTP request
GET https://logging.api.cloud.yandex.net/logging/v1/logGroups
Query parameters
Parameter | Description |
---|---|
folderId | Required. Folder ID of the log groups to return. To get a folder ID make a list request. The maximum string length in characters is 64. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than Default value: 100. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
filter | A filter expression that filters log groups listed in the response. The expression must specify:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"groups": [
{
"id": "string",
"folderId": "string",
"cloudId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"retentionPeriod": "string",
"dataStream": "string"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
groups[] | object List of log groups in the specified folder. |
groups[]. id |
string Log group ID. |
groups[]. folderId |
string Log group folder ID. |
groups[]. cloudId |
string Log group cloud ID. |
groups[]. createdAt |
string (date-time) Log group creation time. String in RFC3339 text format. The range of possible values is from 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). |
groups[]. name |
string Log group name. |
groups[]. description |
string Log group description. |
groups[]. labels |
object Log group labels. |
groups[]. status |
string Status of the log group. Possible log group statuses.
Should never occur. - CREATING: Log group is creating.
|
groups[]. retentionPeriod |
string Log group entry retention period. Entries will be present in group during this period. |
groups[]. dataStream |
string Data stream name |
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |