Managed Service for YDB API, gRPC: BackupService
A set of methods for managing backups.
Call | Description |
---|---|
Get | Returns the specified backup. |
ListPaths | |
List | Retrieves a list of backups. |
ListAccessBindings | |
SetAccessBindings | |
UpdateAccessBindings | |
Delete | Deletes the specified backup. |
Calls BackupService
Get
Returns the specified backup.
rpc Get (GetBackupRequest) returns (Backup)
GetBackupRequest
Field | Description |
---|---|
backup_id | string Required. Required. ID of the YDB backup. The maximum string length in characters is 50. |
Backup
Field | Description |
---|---|
id | string id of backup |
name | string human readable backup name. |
folder_id | string |
database_id | string |
description | string description of backup. |
created_at | google.protobuf.Timestamp |
started_at | google.protobuf.Timestamp indicates when backup started. |
completed_at | google.protobuf.Timestamp indicates when backup completed. |
status | enum Status |
backup_settings | BackupSettings settings used to make backup. |
type | enum Type
|
size | int64 size of backup in bytes. |
BackupSettings
Field | Description |
---|---|
name | string name of backup settings The maximum string length in characters is 256. |
description | string human readable description. The maximum string length in characters is 256. |
backup_schedule | BackupSchedule provide schedule. if empty, backup will be disabled. |
backup_time_to_live | google.protobuf.Duration provide time to live of backup. |
source_paths[] | string provide a list of source paths. Each path can be directory, table or even database itself. Each directory (or database) will be traversed recursively and all childs of directory will be included to backup. By default, backup will be created for full database. The maximum number of elements is 256. |
source_paths_to_exclude[] | string provide a list of paths to exclude from backup. Each path is a directory, table, or database. Each directory (or database) will be traversed recursively and all childs of directory will be excluded. The maximum number of elements is 256. |
type | enum Type |
storage_class | enum StorageClass |
BackupSchedule
Field | Description |
---|---|
policy | oneof: daily_backup_schedule , weekly_backup_schedule or recurring_backup_schedule |
daily_backup_schedule | DailyBackupSchedule |
weekly_backup_schedule | WeeklyBackupSchedule |
recurring_backup_schedule | RecurringBackupSchedule |
next_execute_time | google.protobuf.Timestamp output only field: when next backup will be executed using provided schedule. |
DailyBackupSchedule
Field | Description |
---|---|
execute_time | google.type.TimeOfDay Required. |
WeeklyBackupSchedule
Field | Description |
---|---|
days_of_week[] | DaysOfWeekBackupSchedule The number of elements must be in the range 1-7. |
DaysOfWeekBackupSchedule
Field | Description |
---|---|
days[] | google.type.DayOfWeek The number of elements must be in the range 1-7. |
execute_time | google.type.TimeOfDay Required. |
RecurringBackupSchedule
Field | Description |
---|---|
start_time | google.protobuf.Timestamp Required. Timestamp of the first recurrence. |
recurrence | string Required. An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this backup reccurs. The FREQ values of MINUTELY, and SECONDLY are not supported. |
ListPaths
rpc ListPaths (ListPathsRequest) returns (ListPathsResponse)
ListPathsRequest
Field | Description |
---|---|
backup_id | string Required. Required. ID of the YDB backup. 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 next_page_token that can be used to get the next page of results in subsequent ListPaths requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. Set page_token to the next_page_token returned by a previous ListPaths request to get the next page of results. The maximum string length in characters is 100. |
ListPathsResponse
Field | Description |
---|---|
paths[] | string |
next_page_token | string |
List
Retrieves a list of backups.
rpc List (ListBackupsRequest) returns (ListBackupsResponse)
ListBackupsRequest
Field | Description |
---|---|
folder_id | string |
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 next_page_token that can be used to get the next page of results in subsequent ListBackups requests. Acceptable values are 0 to 1000, inclusive. Default value: 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token. Set page_token to the next_page_token returned by a previous ListBackups request to get the next page of results. The maximum string length in characters is 100. |
ListBackupsResponse
Field | Description |
---|---|
backups[] | Backup |
next_page_token | string This token allows you to get the next page of results for ListBackups requests, if the number of results is larger than page_size specified in the request. To get the next page, specify the value of next_page_token as a value for the page_token parameter in the next ListBackups request. Subsequent ListBackups requests will have their own next_page_token to continue paging through the results. |
Backup
Field | Description |
---|---|
id | string id of backup |
name | string human readable backup name. |
folder_id | string |
database_id | string |
description | string description of backup. |
created_at | google.protobuf.Timestamp |
started_at | google.protobuf.Timestamp indicates when backup started. |
completed_at | google.protobuf.Timestamp indicates when backup completed. |
status | enum Status |
backup_settings | BackupSettings settings used to make backup. |
type | enum Type
|
size | int64 size of backup in bytes. |
BackupSettings
Field | Description |
---|---|
name | string name of backup settings The maximum string length in characters is 256. |
description | string human readable description. The maximum string length in characters is 256. |
backup_schedule | BackupSchedule provide schedule. if empty, backup will be disabled. |
backup_time_to_live | google.protobuf.Duration provide time to live of backup. |
source_paths[] | string provide a list of source paths. Each path can be directory, table or even database itself. Each directory (or database) will be traversed recursively and all childs of directory will be included to backup. By default, backup will be created for full database. The maximum number of elements is 256. |
source_paths_to_exclude[] | string provide a list of paths to exclude from backup. Each path is a directory, table, or database. Each directory (or database) will be traversed recursively and all childs of directory will be excluded. The maximum number of elements is 256. |
type | enum Type |
storage_class | enum StorageClass |
BackupSchedule
Field | Description |
---|---|
policy | oneof: daily_backup_schedule , weekly_backup_schedule or recurring_backup_schedule |
daily_backup_schedule | DailyBackupSchedule |
weekly_backup_schedule | WeeklyBackupSchedule |
recurring_backup_schedule | RecurringBackupSchedule |
next_execute_time | google.protobuf.Timestamp output only field: when next backup will be executed using provided schedule. |
DailyBackupSchedule
Field | Description |
---|---|
execute_time | google.type.TimeOfDay Required. |
WeeklyBackupSchedule
Field | Description |
---|---|
days_of_week[] | DaysOfWeekBackupSchedule The number of elements must be in the range 1-7. |
DaysOfWeekBackupSchedule
Field | Description |
---|---|
days[] | google.type.DayOfWeek The number of elements must be in the range 1-7. |
execute_time | google.type.TimeOfDay Required. |
RecurringBackupSchedule
Field | Description |
---|---|
start_time | google.protobuf.Timestamp Required. Timestamp of the first recurrence. |
recurrence | string Required. An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this backup reccurs. The FREQ values of MINUTELY, and SECONDLY are not supported. |
ListAccessBindings
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
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
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. |
Delete
Deletes the specified backup.
rpc Delete (DeleteBackupRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteBackupMetadata
Operation.response:google.protobuf.Empty
DeleteBackupRequest
Field | Description |
---|---|
backup_id | string |
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. |
DeleteBackupMetadata
Field | Description |
---|---|
backup_id | string |
database_id | string |