Cloud Logging Service, gRPC: ExportService
A set of methods for managing log exports.
Call | Description |
---|---|
Run | Run new logs export from log group to sink |
Get | Returns the specified export. |
List | Retrieves the list of exports in the specified folder. |
Create | Creates a export in the specified folder. |
Update | Updates the specified export. |
Delete | Deletes the specified export. |
ListOperations | Lists operations for the specified export. |
ListAccessBindings | Lists existing access bindings for the specified export. |
SetAccessBindings | Sets access bindings for the specified export. |
UpdateAccessBindings | Updates access bindings for the specified export. |
Calls ExportService
Run
Run new logs export from log group to sink
rpc Run (RunExportRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RunExportMetadata
Operation.response:RunExportDetails
RunExportRequest
Field | Description |
---|---|
group_id | string Required. The maximum string length in characters is 64. |
sink_id | string Required. The maximum string length in characters is 64. |
params | ExportParams Required. |
result_filename | string Required. |
since | google.protobuf.Timestamp Required. |
until | google.protobuf.Timestamp Required. |
ExportParams
Field | Description |
---|---|
resource_types[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
resource_ids[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
stream_names[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
levels[] | LogLevel.Level The maximum number of elements is 10. |
filter | string The maximum string length in characters is 1000. |
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. |
RunExportMetadata
Field | Description |
---|---|
group_id | string |
sink_id | string |
result_filename | string |
RunExportDetails
Field | Description |
---|---|
group_id | string |
sink_id | string |
params | ExportParams |
result_filename | string |
since | google.protobuf.Timestamp |
until | google.protobuf.Timestamp |
Get
Returns the specified export.
To get the list of all available exports, make a List request.
rpc Get (GetExportRequest) returns (Export)
GetExportRequest
Field | Description |
---|---|
export_id | string Required. ID of the export to return. To get a export ID make a ExportService.List request. The maximum string length in characters is 64. |
Export
Field | Description |
---|---|
id | string Export ID. |
folder_id | string Export folder ID. |
cloud_id | string Export cloud ID. |
created_at | google.protobuf.Timestamp Export creation time. |
name | string Export name. |
description | string Export description. |
labels | map<string,string> Export lables. |
group_id | string Group logs are exported from. |
sink_id | string Sink logs are exported to. |
params | ExportParams Parameters of logs filtration. |
ExportParams
Field | Description |
---|---|
resource_types[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
resource_ids[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
stream_names[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
levels[] | LogLevel.Level The maximum number of elements is 10. |
filter | string The maximum string length in characters is 1000. |
List
Retrieves the list of exports in the specified folder.
rpc List (ListExportsRequest) returns (ListExportsResponse)
ListExportsRequest
Field | Description |
---|---|
folder_id | string Required. Folder ID of the exports 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 [ListExportssResponse.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 ListExportsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters exports listed in the response. The expression must specify:
name="my-export" . The maximum string length in characters is 1000. |
ListExportsResponse
Field | Description |
---|---|
exports[] | Export List of exports 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 ListExportsRequest.page_size, use next_page_token as the value for the ListExportsRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. |
Export
Field | Description |
---|---|
id | string Export ID. |
folder_id | string Export folder ID. |
cloud_id | string Export cloud ID. |
created_at | google.protobuf.Timestamp Export creation time. |
name | string Export name. |
description | string Export description. |
labels | map<string,string> Export lables. |
group_id | string Group logs are exported from. |
sink_id | string Sink logs are exported to. |
params | ExportParams Parameters of logs filtration. |
ExportParams
Field | Description |
---|---|
resource_types[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
resource_ids[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
stream_names[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
levels[] | LogLevel.Level The maximum number of elements is 10. |
filter | string The maximum string length in characters is 1000. |
Create
Creates a export in the specified folder.
rpc Create (CreateExportRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateExportMetadata
Operation.response:Export
CreateExportRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create a export 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 export. 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 export. The maximum string length in characters is 256. |
labels | map<string,string> Export 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]* . |
group_id | string Required. Logging Group ID logs exported from The maximum string length in characters is 64. |
sink_id | string Required. Logging Sink ID logs exported to The maximum string length in characters is 64. |
params | ExportParams Required. Parameters for logs filtration |
ExportParams
Field | Description |
---|---|
resource_types[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
resource_ids[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
stream_names[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
levels[] | LogLevel.Level The maximum number of elements is 10. |
filter | string The maximum string length in characters is 1000. |
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. |
CreateExportMetadata
Field | Description |
---|---|
export_id | string ID of the export being created. |
Export
Field | Description |
---|---|
id | string Export ID. |
folder_id | string Export folder ID. |
cloud_id | string Export cloud ID. |
created_at | google.protobuf.Timestamp Export creation time. |
name | string Export name. |
description | string Export description. |
labels | map<string,string> Export lables. |
group_id | string Group logs are exported from. |
sink_id | string Sink logs are exported to. |
params | ExportParams Parameters of logs filtration. |
Update
Updates the specified export.
rpc Update (UpdateExportRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateExportMetadata
Operation.response:Export
UpdateExportRequest
Field | Description |
---|---|
export_id | string Required. ID of the export to update. To get a export ID make a ExportService.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 export. 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 export. The maximum string length in characters is 256. |
labels | map<string,string> New export 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]* . |
group_id | string Required. New logging Group ID logs exported from The maximum string length in characters is 64. |
sink_id | string Required. New logging Sink ID logs exported to The maximum string length in characters is 64. |
params | ExportParams Required. New parameters for logs filtration |
ExportParams
Field | Description |
---|---|
resource_types[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
resource_ids[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
stream_names[] | string The maximum string length in characters for each value is 63. The maximum number of elements is 100. |
levels[] | LogLevel.Level The maximum number of elements is 10. |
filter | string The maximum string length in characters is 1000. |
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. |
UpdateExportMetadata
Field | Description |
---|---|
export_id | string ID of the export being updated. |
Export
Field | Description |
---|---|
id | string Export ID. |
folder_id | string Export folder ID. |
cloud_id | string Export cloud ID. |
created_at | google.protobuf.Timestamp Export creation time. |
name | string Export name. |
description | string Export description. |
labels | map<string,string> Export lables. |
group_id | string Group logs are exported from. |
sink_id | string Sink logs are exported to. |
params | ExportParams Parameters of logs filtration. |
Delete
Deletes the specified export.
rpc Delete (DeleteExportRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteExportMetadata
Operation.response:google.protobuf.Empty
DeleteExportRequest
Field | Description |
---|---|
export_id | string Required. ID of the export to delete. To get a export ID make a ExportService.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. |
DeleteExportMetadata
Field | Description |
---|---|
export_id | string ID of the export being deleted. |
ListOperations
Lists operations for the specified export.
rpc ListOperations (ListExportOperationsRequest) returns (ListExportOperationsResponse)
ListExportOperationsRequest
Field | Description |
---|---|
export_id | string Required. ID of the export to list operations for. To get a export ID make a ExportService.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 ListExportOperationsResponse.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 ListExportOperationsResponse.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. |
ListExportOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of operations for the specified export. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified [ListOExportperationsRequest.page_size], use next_page_token as the value for the ListExportOperationsRequest.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 export.
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 export.
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 export.
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. |