Cloud Logging Service, gRPC: LogGroupService

A set of methods for managing log groups.

Call	Description
Get	Returns the specified log group.
Stats	Returns stats for the specified log group.
List	Retrieves the list of log groups in the specified folder.
Create	Creates a log group in the specified folder.
Update	Updates the specified log group.
Delete	Deletes the specified log group.
ListResources	Retrieves the resources (type and IDs) in the specified log group.
ListOperations	Lists operations for the specified log group.
ListAccessBindings	Lists existing access bindings for the specified log group.
SetAccessBindings	Sets access bindings for the specified log group.
UpdateAccessBindings	Updates access bindings for the specified log group.

Calls LogGroupServiceCalls LogGroupService

GetGet

Returns the specified log group.
To get the list of all available log groups, make a List request.

rpc Get (GetLogGroupRequest) returns (LogGroup)

GetLogGroupRequestGetLogGroupRequest

Field	Description
log_group_id	string Required. ID of the log group to return. To get a log group ID make a LogGroupService.List request. The maximum string length in characters is 64.

LogGroupLogGroup

Field	Description
id	string Log group ID.
folder_id	string Log group folder ID.
cloud_id	string Log group cloud ID.
created_at	google.protobuf.Timestamp Log group creation time.
name	string Log group name.
description	string Log group description.
labels	map<string,string> Log group labels.
status	enum Status Status of the log group. STATUS_UNSPECIFIED: Unknown status. Should never occur. CREATING: Log group is creating. ACTIVE: Log group is ready to accept messages, DELETING: Log group is being deleted. No messages will be accepted. ERROR: Log group is in failed state.
retention_period	google.protobuf.Duration Log group entry retention period. Entries will be present in group during this period.
data_stream	string Data stream name

StatsStats

Returns stats for the specified log group.

rpc Stats (GetLogGroupStatsRequest) returns (GetLogGroupStatsResponse)

GetLogGroupStatsRequestGetLogGroupStatsRequest

Field	Description
log_group_id	string Required. ID of the log group to return stats for. To get a log group ID make a LogGroupService.List request. The maximum string length in characters is 64.

GetLogGroupStatsResponseGetLogGroupStatsResponse

Field	Description
log_group_id	string Log group ID the stats are returned for.
bytes	int64 Size of data in log group in bytes.
records	int64 Amount of records in log group.

ListList

Retrieves the list of log groups in the specified folder.

rpc List (ListLogGroupsRequest) returns (ListLogGroupsResponse)

ListLogGroupsRequestListLogGroupsRequest

Field	Description
folder_id	string Required. Folder ID of the log groups 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 ListLogGroupsResponse.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 ListLogGroupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string A filter expression that filters log groups listed in the response. The expression must specify: The field name. Currently filtering can only be applied to the LogGroup.name field. An = operator. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9]. Example of a filter: name=my-log-group. The maximum string length in characters is 1000.

ListLogGroupsResponseListLogGroupsResponse

Field	Description
groups[]	LogGroup List of log groups 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 ListLogGroupsRequest.page_size, use next_page_token as the value for the ListLogGroupsRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results.

LogGroupLogGroup

Field	Description
id	string Log group ID.
folder_id	string Log group folder ID.
cloud_id	string Log group cloud ID.
created_at	google.protobuf.Timestamp Log group creation time.
name	string Log group name.
description	string Log group description.
labels	map<string,string> Log group labels.
status	enum Status Status of the log group. STATUS_UNSPECIFIED: Unknown status. Should never occur. CREATING: Log group is creating. ACTIVE: Log group is ready to accept messages, DELETING: Log group is being deleted. No messages will be accepted. ERROR: Log group is in failed state.
retention_period	google.protobuf.Duration Log group entry retention period. Entries will be present in group during this period.
data_stream	string Data stream name

CreateCreate

Creates a log group in the specified folder.

rpc Create (CreateLogGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateLogGroupMetadata

    Operation.response:LogGroup

CreateLogGroupRequestCreateLogGroupRequest

Field	Description
folder_id	string Required. ID of the folder to create a log group 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 log group. 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 log group. The maximum string length in characters is 256.
labels	map<string,string> Log group 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]*.
retention_period	google.protobuf.Duration Log group entry retention period. Entries will be present in group during this period. If specified, must be non-negative. Empty or zero value is treated as no limit.
data_stream	string If specified, all log records will be written to this data stream The maximum string length in characters is 512.

OperationOperation

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<CreateLogGroupMetadata> 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<LogGroup> if operation finished successfully.

CreateLogGroupMetadataCreateLogGroupMetadata

Field	Description
log_group_id	string ID of the log group being created.

LogGroupLogGroup

Field	Description
id	string Log group ID.
folder_id	string Log group folder ID.
cloud_id	string Log group cloud ID.
created_at	google.protobuf.Timestamp Log group creation time.
name	string Log group name.
description	string Log group description.
labels	map<string,string> Log group labels.
status	enum Status Status of the log group. STATUS_UNSPECIFIED: Unknown status. Should never occur. CREATING: Log group is creating. ACTIVE: Log group is ready to accept messages, DELETING: Log group is being deleted. No messages will be accepted. ERROR: Log group is in failed state.
retention_period	google.protobuf.Duration Log group entry retention period. Entries will be present in group during this period.
data_stream	string Data stream name

UpdateUpdate

Updates the specified log group.

rpc Update (UpdateLogGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateLogGroupMetadata

    Operation.response:LogGroup

UpdateLogGroupRequestUpdateLogGroupRequest

Field	Description
log_group_id	string Required. ID of the log group to update. To get a log group ID make a LogGroupService.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 log group. 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 log group. The maximum string length in characters is 256.
labels	map<string,string> New log group 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]*.
retention_period	google.protobuf.Duration New log group entry retention period. Entries will be present in group during this period. If specified, must be non-negative. Empty or zero value is treated as no limit.
data_stream	string If specified, log records will be written to this data stream The maximum string length in characters is 512.

OperationOperation

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<UpdateLogGroupMetadata> 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<LogGroup> if operation finished successfully.

UpdateLogGroupMetadataUpdateLogGroupMetadata

Field	Description
log_group_id	string ID of the log group being updated.

LogGroupLogGroup

Field	Description
id	string Log group ID.
folder_id	string Log group folder ID.
cloud_id	string Log group cloud ID.
created_at	google.protobuf.Timestamp Log group creation time.
name	string Log group name.
description	string Log group description.
labels	map<string,string> Log group labels.
status	enum Status Status of the log group. STATUS_UNSPECIFIED: Unknown status. Should never occur. CREATING: Log group is creating. ACTIVE: Log group is ready to accept messages, DELETING: Log group is being deleted. No messages will be accepted. ERROR: Log group is in failed state.
retention_period	google.protobuf.Duration Log group entry retention period. Entries will be present in group during this period.
data_stream	string Data stream name

DeleteDelete

Deletes the specified log group.

rpc Delete (DeleteLogGroupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteLogGroupMetadata

    Operation.response:google.protobuf.Empty

DeleteLogGroupRequestDeleteLogGroupRequest

Field	Description
log_group_id	string Required. ID of the log group to delete. To get a log group ID make a LogGroupService.List request. The maximum string length in characters is 64.

OperationOperation

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<DeleteLogGroupMetadata> 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<google.protobuf.Empty> if operation finished successfully.

DeleteLogGroupMetadataDeleteLogGroupMetadata

Field	Description
log_group_id	string ID of the log group being deleted.

ListResourcesListResources

Retrieves the resources (type and IDs) in the specified log group.

rpc ListResources (ListResourcesRequest) returns (ListResourcesResponse)

ListResourcesRequestListResourcesRequest

Field	Description
log_group_id	string Required. ID of the log group to list resources for. To get a log group ID make a LogGroupService.List request. The maximum string length in characters is 64.
type	string Resource type to return resources for. If not specified, ListResourcesResponse will contain information about all resource types. The maximum string length in characters is 256.

ListResourcesResponseListResourcesResponse

Field	Description
resources[]	LogGroupResource List of resources present in log group.

LogGroupResourceLogGroupResource

Field	Description
type	string Resource type. Collected from log entries inside log group.
ids[]	string List of resource IDs with the same resource type.

ListOperationsListOperations

Lists operations for the specified log group.

rpc ListOperations (ListOperationsRequest) returns (ListOperationsResponse)

ListOperationsRequestListOperationsRequest

Field	Description
log_group_id	string Required. ID of the log group to list operations for. To get a log group ID make a LogGroupService.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 ListOperationsResponse.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 ListOperationsResponse.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: The field name. Currently filtering can be applied to the operation.Operation.description, operation.Operation.created_at, operation.Operation.modified_at, operation.Operation.created_by, operation.Operation.done fields. An = operator. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9]. Examples of a filter: done=false, created_by='John.Doe'. The maximum string length in characters is 1000.

ListOperationsResponseListOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified log group.
next_page_token	string Token for getting the next page of the list. If the number of results is greater than the specified ListOperationsRequest.page_size, use next_page_token as the value for the ListOperationsRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results.

OperationOperation

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. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

ListAccessBindingsListAccessBindings

Lists existing access bindings for the specified log group.

rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

ListAccessBindingsRequestListAccessBindingsRequest

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.

ListAccessBindingsResponseListAccessBindingsResponse

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.

AccessBindingAccessBinding

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.

SubjectSubject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: An identifier that represents a user account. It can be used only if the 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: userAccount: An account on Yandex or Yandex.Connect, added to Yandex.Cloud. serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource. federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory. system: System group. This type represents several accounts with a common system identifier. For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

SetAccessBindingsSetAccessBindings

Sets access bindings for the specified log group.

rpc SetAccessBindings (SetAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:SetAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

SetAccessBindingsRequestSetAccessBindingsRequest

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.

AccessBindingAccessBinding

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.

SubjectSubject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: An identifier that represents a user account. It can be used only if the 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: userAccount: An account on Yandex or Yandex.Connect, added to Yandex.Cloud. serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource. federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory. system: System group. This type represents several accounts with a common system identifier. For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

OperationOperation

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<SetAccessBindingsMetadata> 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<google.protobuf.Empty> if operation finished successfully.

SetAccessBindingsMetadataSetAccessBindingsMetadata

Field	Description
resource_id	string ID of the resource for which access bindings are being set.

UpdateAccessBindingsUpdateAccessBindings

Updates access bindings for the specified log group.

rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

UpdateAccessBindingsRequestUpdateAccessBindingsRequest

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.

AccessBindingDeltaAccessBindingDelta

Field	Description
action	enum AccessBindingAction Required. The action that is being performed on an access binding. ADD: Addition of an access binding. REMOVE: Removal of an access binding.
access_binding	AccessBinding Required. Access binding. For more information, see Access Bindings.

AccessBindingAccessBinding

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.

SubjectSubject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: An identifier that represents a user account. It can be used only if the 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: userAccount: An account on Yandex or Yandex.Connect, added to Yandex.Cloud. serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource. federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory. system: System group. This type represents several accounts with a common system identifier. For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

OperationOperation

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<UpdateAccessBindingsMetadata> 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<google.protobuf.Empty> if operation finished successfully.

UpdateAccessBindingsMetadataUpdateAccessBindingsMetadata

Field	Description
resource_id	string ID of the resource for which access bindings are being updated.