Managed Service for OpenSearch API, REST: Cluster.ListBackups

Field

Description

clusterId

string

Required field. ID of the OpenSearch cluster.

To get the ID, use a ClusterService.List request.

Field

Description

pageSize

string (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 ListClusterBackupsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set page_token to the ListClusterBackupsResponse.nextPageToken
returned by the previous list request.

Field

Description

backups[]

Backup

List of the OpenSearch cluster backups.

nextPageToken

string

This token allows you to get the next page of results for list requests.

If the number of results is larger than ListClustersRequest.pageSize, use the nextPageToken as the value
for the ListClustersRequest.pageToken parameter in the next list request.

Each subsequent list request has its own nextPageToken to continue paging through the results.

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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.

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.