Cloud Logging Service, REST: Sink.Get
Returns the specified sink.
To get the list of all available sinks, make a List request.
HTTP request
GET https://logging.api.yandexcloud.kz/logging/v1/sinks/{sinkId}
Path parameters
|
Field |
Description |
|
sinkId |
string Required field. ID of the sink to return. The maximum string length in characters is 64. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"cloudId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"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
}
|
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 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
name |
string Sink name. |
|
description |
string Sink description. |
|
labels |
object (map<string, 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 |
|
s3 |
Object storage Includes only one of the fields |
Yds
Logs destination
|
Field |
Description |
|
streamName |
string Fully qualified name of data stream The maximum string length in characters is 512. |
S3
|
Field |
Description |
|
bucket |
string Object storage bucket Value must match the regular expression |
|
prefix |
string Prefix to use for saved log object names The maximum string length in characters is 1024. |