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
Parameter | Description |
---|---|
folderId | Required. Folder ID of the sinks 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 sinks listed in the response. The expression must specify:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"sinks": [
{
"id": "string",
"folderId": "string",
"cloudId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"serviceAccountId": "string",
// `sinks[]` includes only one of the fields `yds`, `s3`
"yds": {
"streamName": "string"
},
"s3": {
"bucket": "string",
"prefix": "string"
},
// end of the list of possible fields`sinks[]`
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
sinks[] | object List of sinks in the specified folder. |
sinks[]. id |
string Sink ID. |
sinks[]. folderId |
string Sink folder ID. |
sinks[]. cloudId |
string Sink cloud ID. |
sinks[]. createdAt |
string (date-time) Sink 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). |
sinks[]. name |
string Sink name. |
sinks[]. description |
string Sink description. |
sinks[]. labels |
object Sink labels. |
sinks[]. serviceAccountId |
string Logs will be written to the sink on behalf of this service account |
sinks[]. yds |
object Yandex data stream sinks[] includes only one of the fields yds , s3 |
sinks[]. yds. streamName |
string Fully qualified name of data stream The maximum string length in characters is 512. |
sinks[]. s3 |
object Object storage sinks[] includes only one of the fields yds , s3 |
sinks[]. s3. bucket |
string Object storage bucket Value must match the regular expression |
sinks[]. s3. prefix |
string Prefix to use for saved log object names The maximum string length in characters is 1024. |
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 |