Getting information about an instance group
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:
- In the management console
, open the folder the instance group is in. - Select Compute Cloud.
- In the left-hand panel, select
Instance groups. - Click the name of your instance group.
If you do not have the Yandex Cloud CLI yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name
or --folder-id
parameter.
-
See the description of the CLI command for getting information about an instance group:
yc compute instance-group get --help
-
Get a list of instance groups in the default folder:
yc compute instance-group list
Result:
+----------------------+-----------------------+------+ | ID | NAME | SIZE | +----------------------+-----------------------+------+ | amc65sbgfqeq******** | first-instance-group | 2 | +----------------------+-----------------------+------+
-
Select
ID
orNAME
of the instance group in question, e.g.,first-instance-group
. -
Get information about the instance group:
yc compute instance-group get --name first-instance-group
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the documentation on the Terraform
If you don't have Terraform, install it and configure the Yandex Cloud provider.
To get information about an instance group using Terraform:
-
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 . -
Create the resources:
-
In the terminal, change to the folder where you edited the configuration file.
-
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.
-
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.
-
Apply the configuration changes:
terraform apply
-
Confirm the changes: type
yes
in the terminal and press Enter.
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.