1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. clb
  5. getServerGroup
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.clb.getServerGroup

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::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: bytepluscc: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地址类型。ipv4：后端服务器组为IPv4类型。ipv6：后端服务器组为IPv6类型。
    AnyPortEnabled string
    是否开启全端口转发。on：开启全端口转发。off：关闭全端口转发。
    CreateTime string
    后端服务器组的创建时间。
    Description string
    后端服务器组的描述。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个符。不填则默认为空字符串。
    Id string
    Uniquely identifies the resource.
    Listeners List<Byteplus.GetServerGroupListener>
    后端服务器组关联的监听器信息。
    LoadBalancerId string
    后端服务器组所属的CLB实例ID。
    ServerGroupId string
    后端服务器组的ID。
    ServerGroupName string
    后端服务器组的名称。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。不填默认为后端服务器组ID。
    Servers List<Byteplus.GetServerGroupServer>
    后端服务器组中服务器的信息。
    Tags List<Byteplus.GetServerGroupTag>
    标签信息。
    Type string
    后端服务器组的类型。instance：表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。ip：表示该后端服务器组只能添加IP地址作为后端服务器。
    UpdateTime string
    后端服务器组的最近操作时间。
    AddressIpVersion string
    后端服务器组的IP地址类型。ipv4：后端服务器组为IPv4类型。ipv6：后端服务器组为IPv6类型。
    AnyPortEnabled string
    是否开启全端口转发。on：开启全端口转发。off：关闭全端口转发。
    CreateTime string
    后端服务器组的创建时间。
    Description string
    后端服务器组的描述。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个符。不填则默认为空字符串。
    Id string
    Uniquely identifies the resource.
    Listeners []GetServerGroupListener
    后端服务器组关联的监听器信息。
    LoadBalancerId string
    后端服务器组所属的CLB实例ID。
    ServerGroupId string
    后端服务器组的ID。
    ServerGroupName string
    后端服务器组的名称。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。不填默认为后端服务器组ID。
    Servers []GetServerGroupServer
    后端服务器组中服务器的信息。
    Tags []GetServerGroupTag
    标签信息。
    Type string
    后端服务器组的类型。instance：表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。ip：表示该后端服务器组只能添加IP地址作为后端服务器。
    UpdateTime string
    后端服务器组的最近操作时间。
    addressIpVersion String
    后端服务器组的IP地址类型。ipv4：后端服务器组为IPv4类型。ipv6：后端服务器组为IPv6类型。
    anyPortEnabled String
    是否开启全端口转发。on：开启全端口转发。off：关闭全端口转发。
    createTime String
    后端服务器组的创建时间。
    description String
    后端服务器组的描述。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个符。不填则默认为空字符串。
    id String
    Uniquely identifies the resource.
    listeners List<GetServerGroupListener>
    后端服务器组关联的监听器信息。
    loadBalancerId String
    后端服务器组所属的CLB实例ID。
    serverGroupId String
    后端服务器组的ID。
    serverGroupName String
    后端服务器组的名称。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。不填默认为后端服务器组ID。
    servers List<GetServerGroupServer>
    后端服务器组中服务器的信息。
    tags List<GetServerGroupTag>
    标签信息。
    type String
    后端服务器组的类型。instance：表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。ip：表示该后端服务器组只能添加IP地址作为后端服务器。
    updateTime String
    后端服务器组的最近操作时间。
    addressIpVersion string
    后端服务器组的IP地址类型。ipv4：后端服务器组为IPv4类型。ipv6：后端服务器组为IPv6类型。
    anyPortEnabled string
    是否开启全端口转发。on：开启全端口转发。off：关闭全端口转发。
    createTime string
    后端服务器组的创建时间。
    description string
    后端服务器组的描述。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个符。不填则默认为空字符串。
    id string
    Uniquely identifies the resource.
    listeners GetServerGroupListener[]
    后端服务器组关联的监听器信息。
    loadBalancerId string
    后端服务器组所属的CLB实例ID。
    serverGroupId string
    后端服务器组的ID。
    serverGroupName string
    后端服务器组的名称。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。不填默认为后端服务器组ID。
    servers GetServerGroupServer[]
    后端服务器组中服务器的信息。
    tags GetServerGroupTag[]
    标签信息。
    type string
    后端服务器组的类型。instance：表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。ip：表示该后端服务器组只能添加IP地址作为后端服务器。
    updateTime string
    后端服务器组的最近操作时间。
    address_ip_version str
    后端服务器组的IP地址类型。ipv4：后端服务器组为IPv4类型。ipv6：后端服务器组为IPv6类型。
    any_port_enabled str
    是否开启全端口转发。on：开启全端口转发。off：关闭全端口转发。
    create_time str
    后端服务器组的创建时间。
    description str
    后端服务器组的描述。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个符。不填则默认为空字符串。
    id str
    Uniquely identifies the resource.
    listeners Sequence[GetServerGroupListener]
    后端服务器组关联的监听器信息。
    load_balancer_id str
    后端服务器组所属的CLB实例ID。
    server_group_id str
    后端服务器组的ID。
    server_group_name str
    后端服务器组的名称。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。不填默认为后端服务器组ID。
    servers Sequence[GetServerGroupServer]
    后端服务器组中服务器的信息。
    tags Sequence[GetServerGroupTag]
    标签信息。
    type str
    后端服务器组的类型。instance：表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。ip：表示该后端服务器组只能添加IP地址作为后端服务器。
    update_time str
    后端服务器组的最近操作时间。
    addressIpVersion String
    后端服务器组的IP地址类型。ipv4：后端服务器组为IPv4类型。ipv6：后端服务器组为IPv6类型。
    anyPortEnabled String
    是否开启全端口转发。on：开启全端口转发。off：关闭全端口转发。
    createTime String
    后端服务器组的创建时间。
    description String
    后端服务器组的描述。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255个符。不填则默认为空字符串。
    id String
    Uniquely identifies the resource.
    listeners List<Property Map>
    后端服务器组关联的监听器信息。
    loadBalancerId String
    后端服务器组所属的CLB实例ID。
    serverGroupId String
    后端服务器组的ID。
    serverGroupName String
    后端服务器组的名称。必须以字母、数字或中文开头，可包含字母、数字、中文及以下特殊字符：点号（.）、下划线（_）和中划线（-）。限制为1 ～ 128个字符。不填默认为后端服务器组ID。
    servers List<Property Map>
    后端服务器组中服务器的信息。
    tags List<Property Map>
    标签信息。
    type String
    后端服务器组的类型。instance：表示该后端服务器组只能添加云服务器的主网卡或辅助网卡作为后端服务器。ip：表示该后端服务器组只能添加IP地址作为后端服务器。
    updateTime String
    后端服务器组的最近操作时间。

    Supporting Types

    GetServerGroupListener

    ListenerId string
    监听器的ID。
    ListenerId string
    监听器的ID。
    listenerId String
    监听器的ID。
    listenerId string
    监听器的ID。
    listener_id str
    监听器的ID。
    listenerId String
    监听器的ID。

    GetServerGroupServer

    AnyPortEnabled string
    是否开启全端口转发。on：开启。off（默认值）：关闭。
    Description string
    后端服务器的描述。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255字符。不填则默认为空字符串。
    InstanceId string
    后端服务器。取值情况如下：当 Type 取ecs时，传云服务器实例的ID。当Type 取eni时，传已挂载至云服务器的辅助网卡的ID。当 Type 取ip时，传IP地址作为后端服务器。
    Ip string
    后端服务器的私网IP地址。多个后端服务器IP之间使用“&”分隔。
    Port int
    后端服务器接收请求的端口号。取值范围为1～65535。参数AnyPortEnabled为“off”，且需要同时添加后端服务器时，该参数必须传入；参数AnyPortEnabled为“on”时，该参数默认为0。
    ServerId string
    后端服务器ID。
    Type string
    后端服务器实例类型。当参数Type取instance时，取值如下：ecs：云服务器实例。eni：网卡。当参数Type取ip时，本参数取值为ip。
    Weight int
    后端服务器的权重，取值范围为0 ～ 100。不填则默认为0。0表示不会将请求转发给该后端服务器。
    AnyPortEnabled string
    是否开启全端口转发。on：开启。off（默认值）：关闭。
    Description string
    后端服务器的描述。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255字符。不填则默认为空字符串。
    InstanceId string
    后端服务器。取值情况如下：当 Type 取ecs时，传云服务器实例的ID。当Type 取eni时，传已挂载至云服务器的辅助网卡的ID。当 Type 取ip时，传IP地址作为后端服务器。
    Ip string
    后端服务器的私网IP地址。多个后端服务器IP之间使用“&”分隔。
    Port int
    后端服务器接收请求的端口号。取值范围为1～65535。参数AnyPortEnabled为“off”，且需要同时添加后端服务器时，该参数必须传入；参数AnyPortEnabled为“on”时，该参数默认为0。
    ServerId string
    后端服务器ID。
    Type string
    后端服务器实例类型。当参数Type取instance时，取值如下：ecs：云服务器实例。eni：网卡。当参数Type取ip时，本参数取值为ip。
    Weight int
    后端服务器的权重，取值范围为0 ～ 100。不填则默认为0。0表示不会将请求转发给该后端服务器。
    anyPortEnabled String
    是否开启全端口转发。on：开启。off（默认值）：关闭。
    description String
    后端服务器的描述。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255字符。不填则默认为空字符串。
    instanceId String
    后端服务器。取值情况如下：当 Type 取ecs时，传云服务器实例的ID。当Type 取eni时，传已挂载至云服务器的辅助网卡的ID。当 Type 取ip时，传IP地址作为后端服务器。
    ip String
    后端服务器的私网IP地址。多个后端服务器IP之间使用“&”分隔。
    port Integer
    后端服务器接收请求的端口号。取值范围为1～65535。参数AnyPortEnabled为“off”，且需要同时添加后端服务器时，该参数必须传入；参数AnyPortEnabled为“on”时，该参数默认为0。
    serverId String
    后端服务器ID。
    type String
    后端服务器实例类型。当参数Type取instance时，取值如下：ecs：云服务器实例。eni：网卡。当参数Type取ip时，本参数取值为ip。
    weight Integer
    后端服务器的权重，取值范围为0 ～ 100。不填则默认为0。0表示不会将请求转发给该后端服务器。
    anyPortEnabled string
    是否开启全端口转发。on：开启。off（默认值）：关闭。
    description string
    后端服务器的描述。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255字符。不填则默认为空字符串。
    instanceId string
    后端服务器。取值情况如下：当 Type 取ecs时，传云服务器实例的ID。当Type 取eni时，传已挂载至云服务器的辅助网卡的ID。当 Type 取ip时，传IP地址作为后端服务器。
    ip string
    后端服务器的私网IP地址。多个后端服务器IP之间使用“&”分隔。
    port number
    后端服务器接收请求的端口号。取值范围为1～65535。参数AnyPortEnabled为“off”，且需要同时添加后端服务器时，该参数必须传入；参数AnyPortEnabled为“on”时，该参数默认为0。
    serverId string
    后端服务器ID。
    type string
    后端服务器实例类型。当参数Type取instance时，取值如下：ecs：云服务器实例。eni：网卡。当参数Type取ip时，本参数取值为ip。
    weight number
    后端服务器的权重，取值范围为0 ～ 100。不填则默认为0。0表示不会将请求转发给该后端服务器。
    any_port_enabled str
    是否开启全端口转发。on：开启。off（默认值）：关闭。
    description str
    后端服务器的描述。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255字符。不填则默认为空字符串。
    instance_id str
    后端服务器。取值情况如下：当 Type 取ecs时，传云服务器实例的ID。当Type 取eni时，传已挂载至云服务器的辅助网卡的ID。当 Type 取ip时，传IP地址作为后端服务器。
    ip str
    后端服务器的私网IP地址。多个后端服务器IP之间使用“&”分隔。
    port int
    后端服务器接收请求的端口号。取值范围为1～65535。参数AnyPortEnabled为“off”，且需要同时添加后端服务器时，该参数必须传入；参数AnyPortEnabled为“on”时，该参数默认为0。
    server_id str
    后端服务器ID。
    type str
    后端服务器实例类型。当参数Type取instance时，取值如下：ecs：云服务器实例。eni：网卡。当参数Type取ip时，本参数取值为ip。
    weight int
    后端服务器的权重，取值范围为0 ～ 100。不填则默认为0。0表示不会将请求转发给该后端服务器。
    anyPortEnabled String
    是否开启全端口转发。on：开启。off（默认值）：关闭。
    description String
    后端服务器的描述。必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。长度限制为0 ～ 255字符。不填则默认为空字符串。
    instanceId String
    后端服务器。取值情况如下：当 Type 取ecs时，传云服务器实例的ID。当Type 取eni时，传已挂载至云服务器的辅助网卡的ID。当 Type 取ip时，传IP地址作为后端服务器。
    ip String
    后端服务器的私网IP地址。多个后端服务器IP之间使用“&”分隔。
    port Number
    后端服务器接收请求的端口号。取值范围为1～65535。参数AnyPortEnabled为“off”，且需要同时添加后端服务器时，该参数必须传入；参数AnyPortEnabled为“on”时，该参数默认为0。
    serverId String
    后端服务器ID。
    type String
    后端服务器实例类型。当参数Type取instance时，取值如下：ecs：云服务器实例。eni：网卡。当参数Type取ip时，本参数取值为ip。
    weight Number
    后端服务器的权重，取值范围为0 ～ 100。不填则默认为0。0表示不会将请求转发给该后端服务器。

    GetServerGroupTag

    Key string
    绑定的标签键信息。
    Value string
    绑定的标签值信息。
    Key string
    绑定的标签键信息。
    Value string
    绑定的标签值信息。
    key String
    绑定的标签键信息。
    value String
    绑定的标签值信息。
    key string
    绑定的标签键信息。
    value string
    绑定的标签值信息。
    key str
    绑定的标签键信息。
    value str
    绑定的标签值信息。
    key String
    绑定的标签键信息。
    value String
    绑定的标签值信息。

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.