Yandex Cloud
Search
Contact UsGet started
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • AI for business
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Yandex MPP Analytics for PostgreSQL
  • Getting started
  • Access management
  • Pricing policy
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • Get
        • List
        • Delete
  • Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes

In this article:

  • gRPC request
  • ListBackupsRequest
  • ListBackupsResponse
  • Backup
  1. API reference
  2. gRPC
  3. Backup
  4. List

Managed Service for Greenplum® API, gRPC: BackupService.List

Written by
Yandex Cloud
Updated at November 26, 2024
  • gRPC request
  • ListBackupsRequest
  • ListBackupsResponse
  • Backup

Returns the list of available backups for the specified Greenplum® cluster.

gRPC requestgRPC request

rpc List (ListBackupsRequest) returns (ListBackupsResponse)

ListBackupsRequestListBackupsRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

folder_id

string

Required field. ID of the folder to list backups in.

page_size

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

Default value is 100.

page_token

string

The page token. To get the next page of results, set page_token to the ListBackupsResponse.next_page_token returned by the previous list request.

ListBackupsResponseListBackupsResponse

{
  "backups": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "source_cluster_id": "string",
      "started_at": "google.protobuf.Timestamp",
      "size": "int64",
      "type": "BackupCreationType",
      "method": "BackupMethod",
      "journal_size": "int64"
    }
  ],
  "next_page_token": "string"
}

Field

Description

backups[]

Backup

Requested list of backups.

next_page_token

string

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

If the number of results is larger than ListBackupsRequest.page_size specified in the request, use the next_page_token as the value for the ListBackupsRequest.page_token parameter in the next list request.

Each subsequent ListBackups request has its own next_page_token to continue paging through the results.

BackupBackup

Field

Description

id

string

Required. ID of the backup.

folder_id

string

ID of the folder that the backup belongs to.

created_at

google.protobuf.Timestamp

Time when the backup operation was completed.

source_cluster_id

string

ID of the Greenplum® cluster that the backup was created for.

started_at

google.protobuf.Timestamp

Time when the backup operation was started.

size

int64

Size of the backup in bytes.

type

enum BackupCreationType

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

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

method

enum BackupMethod

Method of backup creation

  • BACKUP_METHOD_UNSPECIFIED
  • BASE: Base backup
  • INCREMENTAL: Delta (incremental) Greenplum backup

journal_size

int64

Size of the journal associated with backup, in bytes

Was the article helpful?

Previous
Get
Next
Delete
© 2025 Direct Cursus Technology L.L.C.