Managed Service for Elasticsearch API, gRPC: BackupService
Written by
Updated at December 13, 2022
Call | Description |
---|---|
Get | Returns the specified backup of Elasticsearch cluster. |
List | Returns the list of available backups for the specified Elasticsearch cluster. |
Calls BackupService
Get
Returns the specified backup of Elasticsearch cluster.
rpc Get (GetBackupRequest) returns (Backup)
GetBackupRequest
Field | Description |
---|---|
backup_id | string Required. 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 associated Elasticsearch cluster. |
started_at | google.protobuf.Timestamp The time when the backup operation was started. |
created_at | google.protobuf.Timestamp The time when the backup was created (i.e. when the backup operation completed). |
indices[] | string Indices names. (max 100) The maximum number of elements is 100. |
elasticsearch_version | string Elasticsearch version used to create the snapshot |
size_bytes | int64 Total size of all indices in backup. in bytes |
indices_total | int64 Total count of indices in backup |
List
Returns the list of available backups for the specified Elasticsearch cluster.
rpc List (ListBackupsRequest) returns (ListBackupsResponse)
ListBackupsRequest
Field | Description |
---|---|
folder_id | string Required. 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 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 Requested list of backups. |
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 Required. ID of the backup. |
folder_id | string ID of the folder that the backup belongs to. |
source_cluster_id | string ID of the associated Elasticsearch cluster. |
started_at | google.protobuf.Timestamp The time when the backup operation was started. |
created_at | google.protobuf.Timestamp The time when the backup was created (i.e. when the backup operation completed). |
indices[] | string Indices names. (max 100) The maximum number of elements is 100. |
elasticsearch_version | string Elasticsearch version used to create the snapshot |
size_bytes | int64 Total size of all indices in backup. in bytes |
indices_total | int64 Total count of indices in backup |