Managed Service for OpenSearch API, REST: Backup methods
A set of methods for managing backups.
JSON Representation
{
"id": "string",
"folderId": "string",
"sourceClusterId": "string",
"startedAt": "string",
"createdAt": "string",
"indices": [
"string"
],
"opensearchVersion": "string",
"sizeBytes": "string",
"indicesTotal": "string"
}
Field | Description |
---|---|
id | string Required. ID of the backup. |
folderId | string ID of the folder that the backup belongs to. |
sourceClusterId | string ID of the OpenSearch cluster that the backup was created for. |
startedAt | string (date-time) Time when the backup operation was started. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
createdAt | string (date-time) Time when the backup operation was completed. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
indices[] | string Names of indices in the backup. The maximum number of elements is 100. |
opensearchVersion | string OpenSearch version used to create the backup. |
sizeBytes | string (int64) Size of the backup in bytes. |
indicesTotal | string (int64) The number of indices in the backup. |
Methods
Method | Description |
---|---|
get | Returns the specified backup of an OpenSearch cluster. |
list | Returns the list of available backups for the specified OpenSearch cluster. |