Cloud Logging Service, REST: Sink.List
Retrieves the list of sinks in the specified folder.
HTTP request
GET https://logging.api.cloud.yandex.net/logging/v1/sinks
Query parameters
Field |
Description |
folderId |
string Required field. Folder ID of the sinks 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 Default value: 100. |
pageToken |
string Page token. To get the next page of results, set |
filter |
string A filter expression that filters sinks listed in the response. The expression must specify:
|
Response
HTTP Code: 200 - OK
{
"sinks": [
{
"id": "string",
"folderId": "string",
"cloudId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"serviceAccountId": "string",
// Includes only one of the fields `yds`, `s3`
"yds": {
"streamName": "string"
},
"s3": {
"bucket": "string",
"prefix": "string"
}
// end of the list of possible fields
}
],
"nextPageToken": "string"
}
Field |
Description |
sinks[] |
List of sinks in the specified folder. |
nextPageToken |
string Token for getting the next page of the list. If the number of results is greater than Each subsequent page will have its own |
Sink
Field |
Description |
id |
string Sink ID. |
folderId |
string Sink folder ID. |
cloudId |
string Sink cloud ID. |
createdAt |
string (date-time) Sink creation time. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Sink name. |
description |
string Sink description. |
labels |
string Sink labels. |
serviceAccountId |
string Logs will be written to the sink on behalf of this service account |
yds |
Yandex data stream Includes only one of the fields Logs destination |
s3 |
Object storage Includes only one of the fields Logs destination |
Yds
Field |
Description |
streamName |
string Fully qualified name of data stream |
S3
Field |
Description |
bucket |
string Object storage bucket |
prefix |
string Prefix to use for saved log object names |