Getting information about a backend group

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. View the description of the CLI command to get information about a backend group:

   yc alb backend-group get --help
   

2. Get information about a backend group by specifying its name or ID:

   yc alb backend-group get <backend_group_name>
   

   Result:

   id: ds7maho6c4or********
   name: alb-bg
   folder_id: b1geoelk7fld********
   http:
     backends:
       - name: backend-1
         backend_weight: "1"
         port: "80"
         target_groups:
           target_group_ids:
             - ds7cjrs15ero********
         healthchecks:
           - timeout: 10s
             interval: 2s
             healthcheck_port: "80"
             http:
               path: /
   created_at: "2023-10-24T12:22:20.870326850Z"
   

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 documentation on the Terraform website or mirror website.

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

To get information about a backend group using Terraform:

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

   data "yandex_alb_backend_group" "my_bg" {
     backend_group_id = "<backend_group_ID>"
   }
   
   output "backend_group" {
     value = data.yandex_alb_backend_group.my_bg.http_backend
   }
   

   Where:

   • data "yandex_alb_backend_group": Description of the backend group as a data source:
     • backend_group_id: Backend group ID.
   • output "backend_group": Output variable that contains information about the connected HTTP backend:
     • value: Returned value.

   You can replace http_backend with any other parameter to get the information you need. For more information about the yandex_alb_backend_group data source parameters, see the 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:

   backend_group = tolist([
     {
       "healthcheck" = tolist([
         {
           "grpc_healthcheck" = tolist([])
           "healthcheck_port" = 80
           "healthy_threshold" = 1
           "http_healthcheck" = tolist([
             {
               "host" = ""
               "http2" = false
               "path" = "/health"
             },
           ])
           "interval" = "1s"
           "interval_jitter_percent" = 0
           "stream_healthcheck" = tolist([])
           "timeout" = "1s"
           "unhealthy_threshold" = 1
         },
         ...
   

To get detailed information about a backend group, use the get REST API method for the BackendGroup resource or the BackendGroupService/Get gRPC API call.