1. Packages
  2. Volcengine
  3. API Docs
  4. clb
  5. getServerGroups
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.clb.getServerGroups

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of server groups

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";

const fooZones = volcengine.ecs.getZones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    vpcId: fooVpc.id,
});
const fooClb = new volcengine.clb.Clb("fooClb", {
    type: "public",
    subnetId: fooSubnet.id,
    loadBalancerSpec: "small_1",
    description: "acc0Demo",
    loadBalancerName: "acc-test-create",
    eipBillingConfig: {
        isp: "BGP",
        eipBillingType: "PostPaidByBandwidth",
        bandwidth: 1,
    },
});
const fooServerGroup = new volcengine.clb.ServerGroup("fooServerGroup", {
    loadBalancerId: fooClb.id,
    serverGroupName: "acc-test-create",
    description: "hello demo11",
});
const fooServerGroups = volcengine.clb.getServerGroupsOutput({
    ids: [fooServerGroup.id],
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.get_zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_clb = volcengine.clb.Clb("fooClb",
    type="public",
    subnet_id=foo_subnet.id,
    load_balancer_spec="small_1",
    description="acc0Demo",
    load_balancer_name="acc-test-create",
    eip_billing_config=volcengine.clb.ClbEipBillingConfigArgs(
        isp="BGP",
        eip_billing_type="PostPaidByBandwidth",
        bandwidth=1,
    ))
foo_server_group = volcengine.clb.ServerGroup("fooServerGroup",
    load_balancer_id=foo_clb.id,
    server_group_name="acc-test-create",
    description="hello demo11")
foo_server_groups = volcengine.clb.get_server_groups_output(ids=[foo_server_group.id])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/clb"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.GetZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooClb, err := clb.NewClb(ctx, "fooClb", &clb.ClbArgs{
			Type:             pulumi.String("public"),
			SubnetId:         fooSubnet.ID(),
			LoadBalancerSpec: pulumi.String("small_1"),
			Description:      pulumi.String("acc0Demo"),
			LoadBalancerName: pulumi.String("acc-test-create"),
			EipBillingConfig: &clb.ClbEipBillingConfigArgs{
				Isp:            pulumi.String("BGP"),
				EipBillingType: pulumi.String("PostPaidByBandwidth"),
				Bandwidth:      pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		fooServerGroup, err := clb.NewServerGroup(ctx, "fooServerGroup", &clb.ServerGroupArgs{
			LoadBalancerId:  fooClb.ID(),
			ServerGroupName: pulumi.String("acc-test-create"),
			Description:     pulumi.String("hello demo11"),
		})
		if err != nil {
			return err
		}
		_ = clb.GetServerGroupsOutput(ctx, clb.GetServerGroupsOutputArgs{
			Ids: pulumi.StringArray{
				fooServerGroup.ID(),
			},
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.GetZones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooClb = new Volcengine.Clb.Clb("fooClb", new()
    {
        Type = "public",
        SubnetId = fooSubnet.Id,
        LoadBalancerSpec = "small_1",
        Description = "acc0Demo",
        LoadBalancerName = "acc-test-create",
        EipBillingConfig = new Volcengine.Clb.Inputs.ClbEipBillingConfigArgs
        {
            Isp = "BGP",
            EipBillingType = "PostPaidByBandwidth",
            Bandwidth = 1,
        },
    });

    var fooServerGroup = new Volcengine.Clb.ServerGroup("fooServerGroup", new()
    {
        LoadBalancerId = fooClb.Id,
        ServerGroupName = "acc-test-create",
        Description = "hello demo11",
    });

    var fooServerGroups = Volcengine.Clb.GetServerGroups.Invoke(new()
    {
        Ids = new[]
        {
            fooServerGroup.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.GetZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.clb.Clb;
import com.pulumi.volcengine.clb.ClbArgs;
import com.pulumi.volcengine.clb.inputs.ClbEipBillingConfigArgs;
import com.pulumi.volcengine.clb.ServerGroup;
import com.pulumi.volcengine.clb.ServerGroupArgs;
import com.pulumi.volcengine.clb.ClbFunctions;
import com.pulumi.volcengine.clb.inputs.GetServerGroupsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var fooZones = EcsFunctions.getZones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooClb = new Clb("fooClb", ClbArgs.builder()        
            .type("public")
            .subnetId(fooSubnet.id())
            .loadBalancerSpec("small_1")
            .description("acc0Demo")
            .loadBalancerName("acc-test-create")
            .eipBillingConfig(ClbEipBillingConfigArgs.builder()
                .isp("BGP")
                .eipBillingType("PostPaidByBandwidth")
                .bandwidth(1)
                .build())
            .build());

        var fooServerGroup = new ServerGroup("fooServerGroup", ServerGroupArgs.builder()        
            .loadBalancerId(fooClb.id())
            .serverGroupName("acc-test-create")
            .description("hello demo11")
            .build());

        final var fooServerGroups = ClbFunctions.getServerGroups(GetServerGroupsArgs.builder()
            .ids(fooServerGroup.id())
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  fooClb:
    type: volcengine:clb:Clb
    properties:
      type: public
      subnetId: ${fooSubnet.id}
      loadBalancerSpec: small_1
      description: acc0Demo
      loadBalancerName: acc-test-create
      eipBillingConfig:
        isp: BGP
        eipBillingType: PostPaidByBandwidth
        bandwidth: 1
  fooServerGroup:
    type: volcengine:clb:ServerGroup
    properties:
      loadBalancerId: ${fooClb.id}
      serverGroupName: acc-test-create
      description: hello demo11
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:getZones
      Arguments: {}
  fooServerGroups:
    fn::invoke:
      Function: volcengine:clb:getServerGroups
      Arguments:
        ids:
          - ${fooServerGroup.id}

    Using getServerGroups

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getServerGroups(args: GetServerGroupsArgs, opts?: InvokeOptions): Promise<GetServerGroupsResult>
function getServerGroupsOutput(args: GetServerGroupsOutputArgs, opts?: InvokeOptions): Output<GetServerGroupsResult>
    def get_server_groups(ids: Optional[Sequence[str]] = None,
                      load_balancer_id: Optional[str] = None,
                      name_regex: Optional[str] = None,
                      output_file: Optional[str] = None,
                      server_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetServerGroupsResult
def get_server_groups_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      load_balancer_id: Optional[pulumi.Input[str]] = None,
                      name_regex: Optional[pulumi.Input[str]] = None,
                      output_file: Optional[pulumi.Input[str]] = None,
                      server_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetServerGroupsResult]
    func GetServerGroups(ctx *Context, args *GetServerGroupsArgs, opts ...InvokeOption) (*GetServerGroupsResult, error)
func GetServerGroupsOutput(ctx *Context, args *GetServerGroupsOutputArgs, opts ...InvokeOption) GetServerGroupsResultOutput

    > Note: This function is named GetServerGroups in the Go SDK.

    public static class GetServerGroups 
{
    public static Task<GetServerGroupsResult> InvokeAsync(GetServerGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetServerGroupsResult> Invoke(GetServerGroupsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServerGroupsResult> getServerGroups(GetServerGroupsArgs args, InvokeOptions options)
public static Output<GetServerGroupsResult> getServerGroups(GetServerGroupsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:clb/getServerGroups:getServerGroups
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of ServerGroup IDs.
    LoadBalancerId string
    The id of the Clb.
    NameRegex string
    A Name Regex of ServerGroup.
    OutputFile string
    File name where to save data source results.
    ServerGroupName string
    The name of the ServerGroup.
    Ids []string
    A list of ServerGroup IDs.
    LoadBalancerId string
    The id of the Clb.
    NameRegex string
    A Name Regex of ServerGroup.
    OutputFile string
    File name where to save data source results.
    ServerGroupName string
    The name of the ServerGroup.
    ids List<String>
    A list of ServerGroup IDs.
    loadBalancerId String
    The id of the Clb.
    nameRegex String
    A Name Regex of ServerGroup.
    outputFile String
    File name where to save data source results.
    serverGroupName String
    The name of the ServerGroup.
    ids string[]
    A list of ServerGroup IDs.
    loadBalancerId string
    The id of the Clb.
    nameRegex string
    A Name Regex of ServerGroup.
    outputFile string
    File name where to save data source results.
    serverGroupName string
    The name of the ServerGroup.
    ids Sequence[str]
    A list of ServerGroup IDs.
    load_balancer_id str
    The id of the Clb.
    name_regex str
    A Name Regex of ServerGroup.
    output_file str
    File name where to save data source results.
    server_group_name str
    The name of the ServerGroup.
    ids List<String>
    A list of ServerGroup IDs.
    loadBalancerId String
    The id of the Clb.
    nameRegex String
    A Name Regex of ServerGroup.
    outputFile String
    File name where to save data source results.
    serverGroupName String
    The name of the ServerGroup.

    getServerGroups Result

    The following output properties are available:

    Groups List<GetServerGroupsGroup>
    The collection of ServerGroup query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of ServerGroup query.
    Ids List<string>
    LoadBalancerId string
    NameRegex string
    OutputFile string
    ServerGroupName string
    The name of the ServerGroup.
    Groups []GetServerGroupsGroup
    The collection of ServerGroup query.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of ServerGroup query.
    Ids []string
    LoadBalancerId string
    NameRegex string
    OutputFile string
    ServerGroupName string
    The name of the ServerGroup.
    groups List<GetServerGroupsGroup>
    The collection of ServerGroup query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of ServerGroup query.
    ids List<String>
    loadBalancerId String
    nameRegex String
    outputFile String
    serverGroupName String
    The name of the ServerGroup.
    groups GetServerGroupsGroup[]
    The collection of ServerGroup query.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of ServerGroup query.
    ids string[]
    loadBalancerId string
    nameRegex string
    outputFile string
    serverGroupName string
    The name of the ServerGroup.
    groups Sequence[GetServerGroupsGroup]
    The collection of ServerGroup query.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of ServerGroup query.
    ids Sequence[str]
    load_balancer_id str
    name_regex str
    output_file str
    server_group_name str
    The name of the ServerGroup.
    groups List<Property Map>
    The collection of ServerGroup query.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of ServerGroup query.
    ids List<String>
    loadBalancerId String
    nameRegex String
    outputFile String
    serverGroupName String
    The name of the ServerGroup.

    Supporting Types

    GetServerGroupsGroup

    AddressIpVersion string
    The address ip version of the ServerGroup.
    CreateTime string
    The create time of the ServerGroup.
    Description string
    The description of the ServerGroup.
    Id string
    The ID of the ServerGroup.
    ServerGroupId string
    The ID of the ServerGroup.
    ServerGroupName string
    The name of the ServerGroup.
    UpdateTime string
    The update time of the ServerGroup.
    AddressIpVersion string
    The address ip version of the ServerGroup.
    CreateTime string
    The create time of the ServerGroup.
    Description string
    The description of the ServerGroup.
    Id string
    The ID of the ServerGroup.
    ServerGroupId string
    The ID of the ServerGroup.
    ServerGroupName string
    The name of the ServerGroup.
    UpdateTime string
    The update time of the ServerGroup.
    addressIpVersion String
    The address ip version of the ServerGroup.
    createTime String
    The create time of the ServerGroup.
    description String
    The description of the ServerGroup.
    id String
    The ID of the ServerGroup.
    serverGroupId String
    The ID of the ServerGroup.
    serverGroupName String
    The name of the ServerGroup.
    updateTime String
    The update time of the ServerGroup.
    addressIpVersion string
    The address ip version of the ServerGroup.
    createTime string
    The create time of the ServerGroup.
    description string
    The description of the ServerGroup.
    id string
    The ID of the ServerGroup.
    serverGroupId string
    The ID of the ServerGroup.
    serverGroupName string
    The name of the ServerGroup.
    updateTime string
    The update time of the ServerGroup.
    address_ip_version str
    The address ip version of the ServerGroup.
    create_time str
    The create time of the ServerGroup.
    description str
    The description of the ServerGroup.
    id str
    The ID of the ServerGroup.
    server_group_id str
    The ID of the ServerGroup.
    server_group_name str
    The name of the ServerGroup.
    update_time str
    The update time of the ServerGroup.
    addressIpVersion String
    The address ip version of the ServerGroup.
    createTime String
    The create time of the ServerGroup.
    description String
    The description of the ServerGroup.
    id String
    The ID of the ServerGroup.
    serverGroupId String
    The ID of the ServerGroup.
    serverGroupName String
    The name of the ServerGroup.
    updateTime String
    The update time of the ServerGroup.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate