Cloud Logging Service, gRPC: SinkService
A set of methods for managing log sinks.
Call | Description |
---|---|
Get | Returns the specified sink. |
List | Retrieves the list of sinks in the specified folder. |
Create | Creates a sink in the specified folder. |
Update | Updates the specified sink. |
Delete | Deletes the specified sink. |
ListOperations | Lists operations for the specified sink. |
ListAccessBindings | Lists existing access bindings for the specified sink. |
SetAccessBindings | Sets access bindings for the specified sink. |
UpdateAccessBindings | Updates access bindings for the specified sink. |
Calls SinkService
Get
Returns the specified sink.
To get the list of all available sinks, make a List request.
rpc Get (GetSinkRequest) returns (Sink)
GetSinkRequest
Field | Description |
---|---|
sink_id | string Required. ID of the sink to return. To get a sink ID make a SinkService.List request. The maximum string length in characters is 64. |
Sink
Field | Description |
---|---|
id | string Sink ID. |
folder_id | string Sink folder ID. |
cloud_id | string Sink cloud ID. |
created_at | google.protobuf.Timestamp Sink creation time. |
name | string Sink name. |
description | string Sink description. |
labels | map<string,string> Sink labels. |
service_account_id | string Logs will be written to the sink on behalf of this service account |
sink | oneof: yds or s3 Logs destination |
yds | Yds Yandex data stream |
s3 | S3 Object storage |
Yds
Field | Description |
---|---|
stream_name | 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 [a-zA-Z0-9][-a-zA-Z0-9.]{2,62} . |
prefix | string Prefix to use for saved log object names The maximum string length in characters is 1024. |
List
Retrieves the list of sinks in the specified folder.
rpc List (ListSinksRequest) returns (ListSinksResponse)
ListSinksRequest
Field | Description |
---|---|
folder_id | string Required. Folder ID of the sinks to return. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 64. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a [ListSinkssResponse.next_page_token] that can be used to get the next page of results in subsequent list requests. Default value: 100. |
page_token | string Page token. To get the next page of results, set page_token to the ListSinksResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters sinks listed in the response. The expression must specify:
name="my-sink" . The maximum string length in characters is 1000. |
ListSinksResponse
Field | Description |
---|---|
sinks[] | Sink List of sinks in the specified folder. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified ListSinksRequest.page_size, use next_page_token as the value for the ListSinksRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. |
Sink
Field | Description |
---|---|
id | string Sink ID. |
folder_id | string Sink folder ID. |
cloud_id | string Sink cloud ID. |
created_at | google.protobuf.Timestamp Sink creation time. |
name | string Sink name. |
description | string Sink description. |
labels | map<string,string> Sink labels. |
service_account_id | string Logs will be written to the sink on behalf of this service account |
sink | oneof: yds or s3 Logs destination |
yds | Yds Yandex data stream |
s3 | S3 Object storage |
Yds
Field | Description |
---|---|
stream_name | 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 [a-zA-Z0-9][-a-zA-Z0-9.]{2,62} . |
prefix | string Prefix to use for saved log object names The maximum string length in characters is 1024. |
Create
Creates a sink in the specified folder.
rpc Create (CreateSinkRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateSinkMetadata
Operation.response:Sink
CreateSinkRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create a sink in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 64. |
name | string Name of the sink. The name must be unique within the folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Description of the sink. The maximum string length in characters is 256. |
labels | map<string,string> Sink labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
service_account_id | string Logs will be written to the sink on behalf of this service account The maximum string length in characters is 64. |
sink | oneof: yds or s3 Logs destination |
yds | Sink.Yds Yandex data stream |
s3 | Sink.S3 Object storage |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateSinkMetadata
Field | Description |
---|---|
sink_id | string ID of the sink being created. |
Sink
Field | Description |
---|---|
id | string Sink ID. |
folder_id | string Sink folder ID. |
cloud_id | string Sink cloud ID. |
created_at | google.protobuf.Timestamp Sink creation time. |
name | string Sink name. |
description | string Sink description. |
labels | map<string,string> Sink labels. |
service_account_id | string Logs will be written to the sink on behalf of this service account |
sink | oneof: yds or s3 Logs destination |
yds | Yds Yandex data stream |
s3 | S3 Object storage |
Yds
Field | Description |
---|---|
stream_name | 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 [a-zA-Z0-9][-a-zA-Z0-9.]{2,62} . |
prefix | string Prefix to use for saved log object names The maximum string length in characters is 1024. |
Update
Updates the specified sink.
rpc Update (UpdateSinkRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateSinkMetadata
Operation.response:Sink
UpdateSinkRequest
Field | Description |
---|---|
sink_id | string Required. ID of the sink to update. To get a sink ID make a SinkService.List request. The maximum string length in characters is 64. |
update_mask | google.protobuf.FieldMask Field mask that specifies which attributes of the function should be updated. |
name | string New name of the sink. The name must be unique within the folder. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string New Description of the sink. The maximum string length in characters is 256. |
labels | map<string,string> New sink labels as key:value pairs. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]* . The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]* . |
service_account_id | string new service account to use for logs writing to the sink. The maximum string length in characters is 64. |
sink | oneof: yds or s3 New logs destination |
yds | Sink.Yds Yandex data stream |
s3 | Sink.S3 Object storage |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateSinkMetadata
Field | Description |
---|---|
sink_id | string ID of the sink being updated. |
Sink
Field | Description |
---|---|
id | string Sink ID. |
folder_id | string Sink folder ID. |
cloud_id | string Sink cloud ID. |
created_at | google.protobuf.Timestamp Sink creation time. |
name | string Sink name. |
description | string Sink description. |
labels | map<string,string> Sink labels. |
service_account_id | string Logs will be written to the sink on behalf of this service account |
sink | oneof: yds or s3 Logs destination |
yds | Yds Yandex data stream |
s3 | S3 Object storage |
Yds
Field | Description |
---|---|
stream_name | 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 [a-zA-Z0-9][-a-zA-Z0-9.]{2,62} . |
prefix | string Prefix to use for saved log object names The maximum string length in characters is 1024. |
Delete
Deletes the specified sink.
rpc Delete (DeleteSinkRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteSinkMetadata
Operation.response:google.protobuf.Empty
DeleteSinkRequest
Field | Description |
---|---|
sink_id | string Required. ID of the sink to delete. To get a sink ID make a SinkService.List request. The maximum string length in characters is 64. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteSinkMetadata
Field | Description |
---|---|
sink_id | string ID of the sink being deleted. |
ListOperations
Lists operations for the specified sink.
rpc ListOperations (ListSinkOperationsRequest) returns (ListSinkOperationsResponse)
ListSinkOperationsRequest
Field | Description |
---|---|
sink_id | string Required. ID of the sink to list operations for. To get a sink ID make a SinkService.List request. The maximum string length in characters is 64. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListSinkOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. To get the next page of results, set page_token to the ListSinkOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
done=false , created_by='John.Doe' . The maximum string length in characters is 1000. |
ListSinkOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of operations for the specified sink. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified [ListOSinkperationsRequest.page_size], use next_page_token as the value for the ListSinkOperationsRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty |
ListAccessBindings
Lists existing access bindings for the specified sink.
rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)
ListAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource to list access bindings for. To get the resource ID, use a corresponding List request. For example, use the yandex.cloud.resourcemanager.v1.CloudService.List request to get the Cloud resource ID. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size , the service returns a ListAccessBindingsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. |
page_token | string Page token. Set page_token to the ListAccessBindingsResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 100. |
ListAccessBindingsResponse
Field | Description |
---|---|
access_bindings[] | AccessBinding List of access bindings for the specified resource. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListAccessBindingsRequest.page_size, use the next_page_token as the value for the ListAccessBindingsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required. ID of the subject. It can contain one of the following values:
type is system .
type is userAccount , federatedUser or serviceAccount . The maximum string length in characters is 50. |
type | string Required. Type of the subject. It can contain one of the following values:
For more information, see Subject to which the role is assigned. The maximum string length in characters is 100. |
SetAccessBindings
Sets access bindings for the specified sink.
rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:SetAccessBindingsMetadata
Operation.response:google.protobuf.Empty
SetAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource for which access bindings are being set. To get the resource ID, use a corresponding List request. The maximum string length in characters is 50. |
access_bindings[] | AccessBinding Required. Access bindings to be set. For more information, see Access Bindings. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required. ID of the subject. It can contain one of the following values:
type is system .
type is userAccount , federatedUser or serviceAccount . The maximum string length in characters is 50. |
type | string Required. Type of the subject. It can contain one of the following values:
For more information, see Subject to which the role is assigned. The maximum string length in characters is 100. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
SetAccessBindingsMetadata
Field | Description |
---|---|
resource_id | string ID of the resource for which access bindings are being set. |
UpdateAccessBindings
Updates access bindings for the specified sink.
rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateAccessBindingsMetadata
Operation.response:google.protobuf.Empty
UpdateAccessBindingsRequest
Field | Description |
---|---|
resource_id | string Required. ID of the resource for which access bindings are being updated. The maximum string length in characters is 50. |
access_binding_deltas[] | AccessBindingDelta Required. Updates to access bindings. The number of elements must be greater than 0. |
AccessBindingDelta
Field | Description |
---|---|
action | enum AccessBindingAction Required. The action that is being performed on an access binding.
|
access_binding | AccessBinding Required. Access binding. For more information, see Access Bindings. |
AccessBinding
Field | Description |
---|---|
role_id | string Required. ID of the yandex.cloud.iam.v1.Role that is assigned to the subject . The maximum string length in characters is 50. |
subject | Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier. |
Subject
Field | Description |
---|---|
id | string Required. ID of the subject. It can contain one of the following values:
type is system .
type is userAccount , federatedUser or serviceAccount . The maximum string length in characters is 50. |
type | string Required. Type of the subject. It can contain one of the following values:
For more information, see Subject to which the role is assigned. The maximum string length in characters is 100. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateAccessBindingsMetadata
Field | Description |
---|---|
resource_id | string ID of the resource for which access bindings are being updated. |