Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Compute Cloud
    • All guides
      • Getting a list of instance groups
      • Getting information about an instance group
      • Getting a list of instances in a group
    • Viewing service resource operations
  • Yandex Container Solution
  • Access management
  • Pricing policy
  • Terraform reference
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  1. Step-by-step guides
  2. Getting information about an instance group
  3. Getting information about an instance group

Getting information about an instance group

Written by
Yandex Cloud
Updated at June 4, 2025

After creating an instance group, you can get basic information about it.

You can only use the CLI or API to retrieve custom metadata provided when creating or updating the instance group.

To get information about an instance group:

Management console
CLI
Terraform
API
  1. In the management console, open the folder the instance group is in.
  2. Select Compute Cloud.
  3. In the left-hand panel, select Instance groups.
  4. Click the name of your instance group.

If you do not have the Yandex Cloud CLI 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. See the description of the CLI command for getting information about an instance group:

    yc compute instance-group get --help
    
  2. Get a list of instance groups in the default folder:

    yc compute instance-group list
    

    Result:

    +----------------------+-----------------------+------+
    |          ID          |         NAME          | SIZE |
    +----------------------+-----------------------+------+
    | amc65sbgfqeq******** | first-instance-group  |    2 |
    +----------------------+-----------------------+------+
    
  3. Select ID or NAME of the instance group in question, e.g., first-instance-group.

  4. Get information about the instance group:

    yc compute instance-group get --name first-instance-group
    

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 its mirror.

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

To get information about an instance group using Terraform:

  1. In the Terraform configuration file, define the parameters of the resources you want to create:

    data "yandex_compute_instance_group" "my_group" {
      instance_group_id = "<instance_group_ID>"
    }
    
    output "instancegroupvm_external_ip" {
      value = "${data.yandex_compute_instance_group.my_group.instances.*.network_interface.0.nat_ip_address}"
    }
    

    Where:

    • data "yandex_compute_instance_group": Description of the data source to get information about the instance group from:
      • instance_group_id: Instance group ID.
    • output "instancegroupvm_external_ip": List of all public IP addresses of the group instances to return in the output:
      • value: Returned value.

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

  2. Create the 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 all the required resources and display the output variable values in the terminal. To check the results, run this command:

    terraform output instancegroupvm_external_ip
    

    Result:

    instancegroupvm_external_ip = tolist([
      "158.160.112.7",
      "158.160.2.119",
    ])
    

Use the get REST API method for the InstanceGroup resource or the InstanceGroupService/Get gRPC API call.

To request a list of available instance groups, use the listInstances REST API method or the InstanceGroupService/ListInstances gRPC API call.

Was the article helpful?

Previous
Getting a list of instance groups
Next
Getting a list of instances in a group
Yandex project
© 2025 Yandex.Cloud LLC