Method listBackups
Retrieves the list of available backups for the specified MongoDB cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}/backups
Path parameters
| Parameter | Description |
|---|---|
| clusterId | Required. ID of the MongoDB cluster. To get the MongoDB cluster ID, use a list request. The maximum string length in characters is 50. |
Query parameters
| Parameter | Description |
|---|---|
| pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a 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. The maximum value is 1000. |
| pageToken | Page token. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"backups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"sourceClusterId": "string",
"startedAt": "string",
"sourceShardNames": [
"string"
],
"size": "string",
"type": "string"
}
],
"nextPageToken": "string"
}
| Field | Description |
|---|---|
| backups[] | object List of MongoDB Backup resources. |
| backups[]. id |
string ID of the backup. Required. |
| backups[]. folderId |
string ID of the folder that the backup belongs to. |
| backups[]. createdAt |
string (date-time) Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed). String in RFC3339 text format. |
| backups[]. sourceClusterId |
string ID of the MongoDB cluster that the backup was created for. |
| backups[]. startedAt |
string (date-time) Time when the backup operation was started. String in RFC3339 text format. |
| backups[]. sourceShardNames[] |
string Shard names used as a source for backup. |
| backups[]. size |
string (int64) Size of backup in bytes |
| backups[]. type |
string How this backup was created (manual/automatic/etc...)
|
| nextPageToken | string This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results. |