Managing backup policies in Managed Service for PostgreSQL

Get an IAM token for API authentication and place it in an environment variable:

export IAM_TOKEN="<IAM_token>"

Call the BackupRetentionPolicy.Create method, for instance, via the following cURL request:

curl \
  --request POST \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --header "Content-Type: application/json" \
  --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<cluster_ID>/retention_policies' \
  --data '{
             "cron": {
               "dayOfMonth": "<day_of_month>",
               "month": "<month>",
               "dayOfWeek": "<day_of_week>"
             },
             "retainForDays": "<retention_period_in_days>",
             "description": "<policy_description>",
             "policyName": "<policy_name>"
         }'

Where:

• dayOfMonth: Day of the month. Allowed values: 1-31.

• month: Month. Allowed values: 1-12 or JAN-DEC.

• dayOfWeek: Day of the week. Allowed values: 0-6 or SUN-SAT.

• retainForDays: Backup retention period in days. The minimum value is 7.

  The dayOfMonth, month, and dayOfWeek define the schedule for creating backups. The schedule is defined as a cron expression without hours and minutes.

  Cron expressions also support the following special characters:

  • *: Selecting all possible values. A backup will be created on each scheduled interval (day or month) when possible, provided it does not conflict with other settings. This option is used by default if the setting is not specified.
  • ,: Listing multiple values.
  • –: Specifying a range of values.
  • /: Specifying a step value. For example, */3 for the dayOfMonth setting means a backup will be created every three days.

  If no schedule settings are specified, backups are created using the cron expression * * *, meaning they run daily.

  Examples of cron expressions:

  • 1 */6 *: Backup is created on the first day of the month, every six months.
  • 31 jan SUN: Backup is created on Sundays in January, and also on January 31.
  • * * WED: Backup is created every Wednesday.

  You can test your cron expression in this editor.

You can get the cluster ID from the list of clusters.

Check the server response to make sure your request was successful.

Get an IAM token for API authentication and place it in an environment variable:

export IAM_TOKEN="<IAM_token>"

Clone the cloudapi repository:

cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi

Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

To create a policy:

1. Call the BackupRetentionPolicyService.Create method, for instance, via the following gRPCurl request:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/backup_retention_policy_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "cron": {
                "day_of_month": "<day_of_month>",
                "month": "<month>",
                "day_of_week": "<day_of_week>"
             },
             "retain_for_days": "<backup_retention_period_in_days>",
             "description": "<policy_description>",
             "policy_name": "<policy_name>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.postgresql.v1.BackupRetentionPolicyService.Create
   

   Where:

   • day_of_month: Day of the month. Allowed values: 1–31.

   • month: Month. Allowed values: 1–12 or JAN–DEC.

   • day_of_week: Day of the week. Allowed values: 0–6 or SUN–SAT.

   • retain_for_days: Backup retention period in days. The minimum value is 7.

     The day_of_month, month, and day_of_week define the schedule for creating backups. The schedule is defined as a cron expression without hours and minutes.

     Cron expressions also support the following special characters:

     • *: Selecting all possible values. A backup will be created on each scheduled interval (day or month) when possible, provided it does not conflict with other settings. This option is used by default if the setting is not specified.
     • ,: Listing multiple values.
     • –: Specifying a range of values.
     • /: Specifying a step value. For example, */3 for the day_of_month setting means a backup will be created every three days.

     If no schedule settings are specified, backups are created using the cron expression * * *, meaning they run daily.

     Examples of cron expressions:

     • 1 */6 *: Backup is created on the first day of the month, every six months.
     • 31 jan SUN: Backup is created on Sundays in January, and also on January 31.
     • * * WED: Backup is created every Wednesday.

     You can test your cron expression in this editor.

   You can get the cluster ID from the cluster list.

2. Check the server response to make sure your request was successful.

Get an IAM token for API authentication and place it in an environment variable:

export IAM_TOKEN="<IAM_token>"

Call the BackupRetentionPolicy.List method, for instance, via the following cURL request:

curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<cluster_ID>/retention_policies?pageSize=<number_of_results>'

Where page_size is the number of query results per page. Specify a number greater than zero.

You can get the cluster ID from the list of clusters.

Check the server response to make sure your request was successful.

Get an IAM token for API authentication and place it in an environment variable:

export IAM_TOKEN="<IAM_token>"

Clone the cloudapi repository:

cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi

Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

To get a list of policies for a cluster:

1. Call the BackupRetentionPolicyService.List method, for instance, via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/backup_retention_policy_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<cluster_ID>",
           "page_size": "<number_of_results>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.BackupRetentionPolicyService.List
   

   Where page_size is the number of query results per page. Specify a number greater than zero.

   You can get the cluster ID from the list of clusters.

2. Check the server response to make sure your request was successful.

Get an IAM token for API authentication and place it in an environment variable:

export IAM_TOKEN="<IAM_token>"

Call the BackupRetentionPolicy.Delete method, for instance, via the following cURL request:

curl \
  --request DELETE \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<cluster_ID>/retention_policies/<policy_ID>'

You can get the cluster ID from the list of clusters, and the policy ID from the list of policies.

Check the server response to make sure your request was successful.

Get an IAM token for API authentication and place it in an environment variable:

export IAM_TOKEN="<IAM_token>"

Clone the cloudapi repository:

cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi

Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

To delete a policy:

1. Call the BackupRetentionPolicyService.Delete method, for instance, via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/backup_retention_policy_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "policy_id": "<policy_ID>",
           "cluster_id": "<cluster_ID>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.BackupRetentionPolicyService.Delete
   

   You can get the cluster ID from the list of clusters, and the policy ID from the list of policies.

2. Check the server response to make sure your request was successful.