Связаться с намиПодключиться

Managed Service for MongoDB API, gRPC: ClusterService.ListBackups

Статья создана
Обновлена 17 октября 2024 г.

Retrieves the list of available backups for the specified MongoDB cluster.

gRPC request

rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)

ListClusterBackupsRequest

{
  "clusterId": "string",
  "pageSize": "int64",
  "pageToken": "string"
}

Field

Description

clusterId

string

Required field. ID of the MongoDB cluster.
To get the MongoDB cluster ID, use a ClusterService.List request.

pageSize

int64

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListClusterBackupsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Acceptable values are 0 to 1000, inclusive. Default value: 100.

pageToken

string

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

ListClusterBackupsResponse

{
  "backups": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "google.protobuf.Timestamp",
      "sourceClusterId": "string",
      "startedAt": "google.protobuf.Timestamp",
      "sourceShardNames": [
        "string"
      ],
      "size": "int64",
      "type": "BackupType",
      "journalSize": "int64"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

backups[]

Backup

List of MongoDB Backup resources.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListClusterBackupsRequest.pageSize, use the nextPageToken as the value
for the ListClusterBackupsRequest.pageToken query parameter in the next list request.
Each subsequent list request will have its own nextPageToken to continue paging through the results.

Backup

A MongoDB Backup resource. For more information, see the
Developer's Guide.

Field

Description

id

string

ID of the backup. Required.

folderId

string

ID of the folder that the backup belongs to.

createdAt

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format
(i.e. when the backup operation was completed).

sourceClusterId

string

ID of the MongoDB cluster that the backup was created for.

startedAt

google.protobuf.Timestamp

Time when the backup operation was started.

sourceShardNames[]

string

Shard names used as a source for backup.

size

int64

Size of backup in bytes

type

enum BackupType

How this backup was created (manual/automatic/etc...)

  • BACKUP_TYPE_UNSPECIFIED
  • AUTOMATED: Backup created by automated daily schedule
  • MANUAL: Backup created by user request

journalSize

int64

Size of the journal associated with backup, in bytes
Предыдущая
ListOperations
Следующая
ListHosts