Getting information about a backup policy

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

1. Get a list of backup policies in the default folder:

   yc backup policy list
   

   Result:

   +----------------------+----------------------+-----------------+---------+---------------------+---------------------+
   |          ID          |      FOLDER ID       |      NAME       | ENABLED |     CREATED AT      |     UPDATED AT      |
   +----------------------+----------------------+-----------------+---------+---------------------+---------------------+
   | cdgp2n2s73lg******** | b1gsm0k26v1l******** | Default daily   | true    | 2023-07-20 13:55:14 | 2024-08-15 08:27:41 |
   | cdguolnopexf******** | b1gsm0k26v1l******** | Default weekly  | true    | 2023-07-20 13:55:14 | 2023-09-05 16:24:05 |
   | cdgklelzc4pi******** | b1gsm0k26v1l******** | Default monthly | true    | 2023-07-20 13:55:15 | 2024-09-02 08:40:18 |
   +----------------------+----------------------+-----------------+---------+---------------------+---------------------+
   

   Save ID and NAME of the policy you want to get information on.

2. View the description of the CLI command for information about a backup policy:

   yc backup policy get --help
   

3. Get information about the backup policy by specifying its name or ID:

   yc backup policy get <backup_policy_ID>
   

   Result:

   id: cdgvykqerzzc********
   name: Default weekly
   created_at: "2023-10-09T20:23:46.980915356Z"
   updated_at: "2023-10-09T20:23:46.978341789Z"
   enabled: true
   settings:
     compression: NORMAL
     format: AUTO
     multi_volume_snapshotting_enabled: true
     preserve_file_security_settings: true
     reattempts:
       enabled: true
       interval:
         type: SECONDS
         count: "30"
       max_attempts: "30"
   ...
   

For more information about the command, see the CLI reference.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

To get information about a backup policy using Terraform:

1. Add the data and output sections to the Terraform configuration file:

   data "yandex_backup_policy" "my_policy" {
     policy_id = "<policy_ID>"
   }
   
   output "my_policy_schedule" {
     value = data.yandex_backup_policy.my_policy.scheduling
   }
   

   Where:

   • data "yandex_backup_policy": Description of the backup policy as a data source:
     • policy_id: Backup policy ID. You can also use the name parameter representing the name of the backup policy.
   • output "my_policy_schedule": Output variable that contains information about the backup policy schedule:
     • value: Returned value.

   You can replace scheduling with any other policy parameter to get the information you need.

   For more information about the yandex_backup_policy data source parameters, see the relevant provider documentation.

2. Create resources:

   1. In the terminal, go to the directory where you edited the configuration file.

   2. Make sure the configuration file is correct using this command:

      terraform validate
      

      If the configuration is correct, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will create the required resources and display the output variable values in the terminal. To check the results, run:

   terraform output
   

   Result:

   my_policy_name = toset([
     {
       "backup_sets" = toset([
         {
           "execute_by_interval" = 0
           "execute_by_time" = toset([
             {
               "include_last_day_of_month" = false
               "monthdays" = tolist([])
               "months" = tolist([])
               "repeat_at" = tolist([
                 "01:45",
   ...
   "enabled" = true
   "max_parallel_backups" = 2
   "random_max_delay" = "30m"
   "scheme" = "ALWAYS_INCREMENTAL"
   "weekly_backup_day" = "MONDAY"
   ...
   

To get detailed information about a backup policy, use the get REST API method for the Policy resource or the PolicyService/Get gRPC API call.