Managed Service for OpenSearch API, gRPC: BackupService
Written by
Updated at December 13, 2022
A set of methods for managing backups.
Call | Description |
---|---|
Get | Returns the specified backup of an OpenSearch cluster. |
List | Returns the list of available backups for the specified OpenSearch cluster. |
Calls BackupService
Get
Returns the specified backup of an OpenSearch cluster.
rpc Get (GetBackupRequest) returns (Backup)
GetBackupRequest
Field | Description |
---|---|
backup_id | string Required. ID of the backup to return. |
Backup
Field | Description |
---|---|
id | string Required. ID of the backup. |
folder_id | string ID of the folder that the backup belongs to. |
source_cluster_id | string ID of the OpenSearch cluster that the backup was created for. |
started_at | google.protobuf.Timestamp Time when the backup operation was started. |
created_at | google.protobuf.Timestamp Time when the backup operation was completed. |
indices[] | string Names of indices in the backup. The maximum number of elements is 100. |
opensearch_version | string OpenSearch version used to create the backup. |
size_bytes | int64 Size of the backup in bytes. |
indices_total | int64 The number of indices in the backup. |
List
Returns the list of available backups for the specified OpenSearch cluster.
rpc List (ListBackupsRequest) returns (ListBackupsResponse)
ListBackupsRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list backups in. 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 ListBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value is 100. Acceptable values are 0 to 1000, inclusive. |
page_token | string The page token. To get the next page of results, set page_token to the ListBackupsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListBackupsResponse
Field | Description |
---|---|
backups[] | Backup Requested list of backups. |
next_page_token | string This token allows you to get the next page of results for a list request. If the number of results is larger than ListBackupsRequest.page_size specified in the request, use the next_page_token as the value for the ListBackupsRequest.page_token parameter in the next list request. Each subsequent ListBackups request has its own next_page_token to continue paging through the results. |
Backup
Field | Description |
---|---|
id | string Required. ID of the backup. |
folder_id | string ID of the folder that the backup belongs to. |
source_cluster_id | string ID of the OpenSearch cluster that the backup was created for. |
started_at | google.protobuf.Timestamp Time when the backup operation was started. |
created_at | google.protobuf.Timestamp Time when the backup operation was completed. |
indices[] | string Names of indices in the backup. The maximum number of elements is 100. |
opensearch_version | string OpenSearch version used to create the backup. |
size_bytes | int64 Size of the backup in bytes. |
indices_total | int64 The number of indices in the backup. |