1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. clb
  6. getServerGroup
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.clb.getServerGroup

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Data Source schema for Volcengine::CLB::ServerGroup

    Using getServerGroup

    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 getServerGroup(args: GetServerGroupArgs, opts?: InvokeOptions): Promise<GetServerGroupResult>
function getServerGroupOutput(args: GetServerGroupOutputArgs, opts?: InvokeOptions): Output<GetServerGroupResult>
    def get_server_group(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetServerGroupResult
def get_server_group_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetServerGroupResult]
    func LookupServerGroup(ctx *Context, args *LookupServerGroupArgs, opts ...InvokeOption) (*LookupServerGroupResult, error)
func LookupServerGroupOutput(ctx *Context, args *LookupServerGroupOutputArgs, opts ...InvokeOption) LookupServerGroupResultOutput

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

    public static class GetServerGroup 
{
    public static Task<GetServerGroupResult> InvokeAsync(GetServerGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetServerGroupResult> Invoke(GetServerGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServerGroupResult> getServerGroup(GetServerGroupArgs args, InvokeOptions options)
public static Output<GetServerGroupResult> getServerGroup(GetServerGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:clb/getServerGroup:getServerGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getServerGroup Result

    The following output properties are available:

    AddressIpVersion string
    IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
    AnyPortEnabled string
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    CreateTime string
    Creation time of the backend server group.
    Description string
    Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    Id string
    Uniquely identifies the resource.
    Listeners List<Volcengine.GetServerGroupListener>
    Listener information associated with the backend server group.
    LoadBalancerId string
    CLB instance ID to which the backend server group belongs.
    ServerGroupId string
    Backend server group ID.
    ServerGroupName string
    Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
    Servers List<Volcengine.GetServerGroupServer>
    Information about servers in the backend server group.
    Tags List<Volcengine.GetServerGroupTag>
    Tag information.
    Type string
    Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
    UpdateTime string
    Last operation time of the backend server group.
    AddressIpVersion string
    IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
    AnyPortEnabled string
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    CreateTime string
    Creation time of the backend server group.
    Description string
    Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    Id string
    Uniquely identifies the resource.
    Listeners []GetServerGroupListener
    Listener information associated with the backend server group.
    LoadBalancerId string
    CLB instance ID to which the backend server group belongs.
    ServerGroupId string
    Backend server group ID.
    ServerGroupName string
    Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
    Servers []GetServerGroupServer
    Information about servers in the backend server group.
    Tags []GetServerGroupTag
    Tag information.
    Type string
    Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
    UpdateTime string
    Last operation time of the backend server group.
    addressIpVersion String
    IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
    anyPortEnabled String
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    createTime String
    Creation time of the backend server group.
    description String
    Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    id String
    Uniquely identifies the resource.
    listeners List<GetServerGroupListener>
    Listener information associated with the backend server group.
    loadBalancerId String
    CLB instance ID to which the backend server group belongs.
    serverGroupId String
    Backend server group ID.
    serverGroupName String
    Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
    servers List<GetServerGroupServer>
    Information about servers in the backend server group.
    tags List<GetServerGroupTag>
    Tag information.
    type String
    Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
    updateTime String
    Last operation time of the backend server group.
    addressIpVersion string
    IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
    anyPortEnabled string
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    createTime string
    Creation time of the backend server group.
    description string
    Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    id string
    Uniquely identifies the resource.
    listeners GetServerGroupListener[]
    Listener information associated with the backend server group.
    loadBalancerId string
    CLB instance ID to which the backend server group belongs.
    serverGroupId string
    Backend server group ID.
    serverGroupName string
    Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
    servers GetServerGroupServer[]
    Information about servers in the backend server group.
    tags GetServerGroupTag[]
    Tag information.
    type string
    Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
    updateTime string
    Last operation time of the backend server group.
    address_ip_version str
    IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
    any_port_enabled str
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    create_time str
    Creation time of the backend server group.
    description str
    Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    id str
    Uniquely identifies the resource.
    listeners Sequence[GetServerGroupListener]
    Listener information associated with the backend server group.
    load_balancer_id str
    CLB instance ID to which the backend server group belongs.
    server_group_id str
    Backend server group ID.
    server_group_name str
    Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
    servers Sequence[GetServerGroupServer]
    Information about servers in the backend server group.
    tags Sequence[GetServerGroupTag]
    Tag information.
    type str
    Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
    update_time str
    Last operation time of the backend server group.
    addressIpVersion String
    IP address type of the backend server group. ipv4: The backend server group is of IPv4 type. ipv6: The backend server group is of IPv6 type.
    anyPortEnabled String
    Whether to enable all-port forwarding. on: enable all-port forwarding. off: disable all-port forwarding.
    createTime String
    Creation time of the backend server group.
    description String
    Description of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    id String
    Uniquely identifies the resource.
    listeners List<Property Map>
    Listener information associated with the backend server group.
    loadBalancerId String
    CLB instance ID to which the backend server group belongs.
    serverGroupId String
    Backend server group ID.
    serverGroupName String
    Name of the backend server group. Must start with a letter, number, or Chinese character, and can include letters, numbers, Chinese characters, and the following special characters: period (.), underscore (_), and hyphen (-). Limit: 1–128 characters. If not specified, defaults to the backend server group ID.
    servers List<Property Map>
    Information about servers in the backend server group.
    tags List<Property Map>
    Tag information.
    type String
    Type of the backend server group. instance: This backend server group can only add the primary or auxiliary network card of a cloud server as backend servers. ip: This backend server group can only add IP addresses as backend servers.
    updateTime String
    Last operation time of the backend server group.

    Supporting Types

    GetServerGroupListener

    ListenerId string
    Listener ID.
    ListenerId string
    Listener ID.
    listenerId String
    Listener ID.
    listenerId string
    Listener ID.
    listener_id str
    Listener ID.
    listenerId String
    Listener ID.

    GetServerGroupServer

    AnyPortEnabled string
    Enable all-port forwarding. on: enabled. off (default): disabled.
    Description string
    Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    InstanceId string
    Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
    Ip string
    Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
    Port int
    Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
    ServerId string
    Backend server ID.
    Type string
    Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
    Weight int
    Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
    AnyPortEnabled string
    Enable all-port forwarding. on: enabled. off (default): disabled.
    Description string
    Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    InstanceId string
    Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
    Ip string
    Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
    Port int
    Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
    ServerId string
    Backend server ID.
    Type string
    Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
    Weight int
    Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
    anyPortEnabled String
    Enable all-port forwarding. on: enabled. off (default): disabled.
    description String
    Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    instanceId String
    Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
    ip String
    Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
    port Integer
    Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
    serverId String
    Backend server ID.
    type String
    Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
    weight Integer
    Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
    anyPortEnabled string
    Enable all-port forwarding. on: enabled. off (default): disabled.
    description string
    Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    instanceId string
    Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
    ip string
    Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
    port number
    Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
    serverId string
    Backend server ID.
    type string
    Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
    weight number
    Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
    any_port_enabled str
    Enable all-port forwarding. on: enabled. off (default): disabled.
    description str
    Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    instance_id str
    Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
    ip str
    Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
    port int
    Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
    server_id str
    Backend server ID.
    type str
    Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
    weight int
    Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.
    anyPortEnabled String
    Enable all-port forwarding. on: enabled. off (default): disabled.
    description String
    Backend server description. Must start with a letter, number, or Chinese character. Can include letters, numbers, Chinese characters, and the following special characters: comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), Chinese period (。). Length limit: 0–255 characters. If not specified, defaults to an empty string.
    instanceId String
    Backend server. Value options: When Type is ecs, provide the cloud server instance ID. When Type is eni, provide the ID of the auxiliary network card attached to the cloud server. When Type is ip, provide the IP address as the backend server.
    ip String
    Private IP address of the backend server. Use '&' to separate multiple backend server IP addresses.
    port Number
    Port number on which the backend server receives requests. Value range: 1–65535. If the AnyPortEnabled parameter is 'off' and you need to add backend servers at the same time, this parameter must be provided. If AnyPortEnabled is 'on', this parameter defaults to 0.
    serverId String
    Backend server ID.
    type String
    Backend server instance type. When the Type parameter is instance, value options are: ecs: cloud server instance. eni: auxiliary network card. When the Type parameter is ip, this parameter value is ip.
    weight Number
    Backend server weight, range: 0–100. If not specified, defaults to 0. 0 means requests will not be forwarded to this backend server.

    GetServerGroupTag

    Key string
    Information about bound tag keys.
    Value string
    Bound tag value information.
    Key string
    Information about bound tag keys.
    Value string
    Bound tag value information.
    key String
    Information about bound tag keys.
    value String
    Bound tag value information.
    key string
    Information about bound tag keys.
    value string
    Bound tag value information.
    key str
    Information about bound tag keys.
    value str
    Bound tag value information.
    key String
    Information about bound tag keys.
    value String
    Bound tag value information.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.