Getting information about a disk snapshot schedule

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

1. See the description of the CLI command to get information about a schedule:

   yc compute snapshot-schedule get --help
   

2. Get information about your schedule by specifying its name or ID:

   yc compute snapshot-schedule get <schedule_name>
   

   Result:

   id: fd8cc5qd25cp********
   folder_id: b1gmit33ngp3********
   created_at: "2023-10-30T14:53:33Z"
   name: schedule-1
   status: ACTIVE
   schedule_policy:
     start_at: "2023-10-30T14:00:51Z"
     expression: 0 10 */1 * *
   snapshot_count: "2"
   snapshot_spec: {}
   

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

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

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To get information about a disk snapshot schedule using Terraform:

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

   data "yandex_compute_snapshot_schedule" "snapshot_schedule" {
     snapshot_schedule_id = "<schedule_ID>"
   }
   
   output "snapshot_schedule" {
     value = data.yandex_compute_snapshot_schedule.snapshot_schedule.status
   }
   

   Where:

   • data "yandex_compute_snapshot_schedule": Description of the disk snapshot schedule as a data source:
     • snapshot_schedule_id: Disk snapshot schedule ID.
   • output "snapshot_schedule": Output variable that contains information about the disk snapshot schedule:
     • value: Returned value.

   You can replace status with any other parameter to get the information you need. For more information about the yandex_compute_snapshot_schedule data source parameters, see the relevant provider documentation.

2. Create resources:

   1. In the terminal, change to the folder where you edited the configuration file.

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

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

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

   terraform output
   

   Result:

   snapshot_schedule = "inactive"
   

To get detailed information about a disk snapshot schedule, use the get REST API method for the SnapshotSchedule resource or the SnapshotScheduleService/Get gRPC API call.