Cloud Logging Service, REST: Sink.Create
Creates a sink in the specified folder.
HTTP request
POST https://logging.api.cloud.yandex.net/logging/v1/sinks
Body parameters
{
"folderId": "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
}
Field |
Description |
folderId |
string Required field. ID of the folder to create a sink in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. |
name |
string Name of the sink. |
description |
string Description of the sink. |
labels |
string Sink labels as |
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 |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"sinkId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"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
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateSinkMetadata
Field |
Description |
sinkId |
string ID of the sink being created. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
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 |