volcenginecc.autoscaling.getScalingGroup

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getScalingGroup

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 getScalingGroup(args: GetScalingGroupArgs, opts?: InvokeOptions): Promise<GetScalingGroupResult>
function getScalingGroupOutput(args: GetScalingGroupOutputArgs, opts?: InvokeOptions): Output<GetScalingGroupResult>

def get_scaling_group(id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetScalingGroupResult
def get_scaling_group_output(id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetScalingGroupResult]

func LookupScalingGroup(ctx *Context, args *LookupScalingGroupArgs, opts ...InvokeOption) (*LookupScalingGroupResult, error)
func LookupScalingGroupOutput(ctx *Context, args *LookupScalingGroupOutputArgs, opts ...InvokeOption) LookupScalingGroupResultOutput

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

public static class GetScalingGroup 
{
    public static Task<GetScalingGroupResult> InvokeAsync(GetScalingGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetScalingGroupResult> Invoke(GetScalingGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetScalingGroupResult> getScalingGroup(GetScalingGroupArgs args, InvokeOptions options)
public static Output<GetScalingGroupResult> getScalingGroup(GetScalingGroupArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:autoscaling/getScalingGroup:getScalingGroup
  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.

getScalingGroup Result

The following output properties are available:

ActiveScalingConfigurationId string: ID of the scaling configuration bound to the scaling group
CreatedTime string: Scaling group creation time
DbInstanceIds List<string>: ID of the RDS database instance.
DefaultCooldown int: Cooldown period after a scaling activity (adding or removing ECS instances) completes. During the cooldown period, the scaling group does not perform other scaling activities; only scaling activities triggered by Cloud Monitoring alarms and scaling rules are effective. Value range: 5 ~ 86400 seconds. Default value: 300.
DesireInstanceNumber int: Expected number of running instances in the scaling group. 1. Must be no less than MinInstanceNumber and no greater than MaxInstanceNumber. 2. Default value: -1, which means the expected instance count feature is disabled. In this case, after the scaling group is created, scaling activities will automatically add the corresponding number of instances.
HealthCheckType string: Health check mode for the scaling group. 1. NONE: No instance health check. 2. ECS (default): Performs health checks on ECS instances in the scaling group.
Id string: Uniquely identifies the resource.
InstanceRemovePolicies List<Volcengine.GetScalingGroupInstanceRemovePolicy>: Instance removal policy
InstanceTerminatePolicy string: Instance removal policies: 1. OldestInstance: Removes the earliest instance added to the scaling group (including both automatically created and manually added instances). 2. NewestInstance: Removes the latest instance added to the scaling group (including both automatically created and manually added instances). 3. OldestScalingConfigurationWithOldestInstance (default): Removes the earliest automatically created instance in the scaling configuration that was first associated with the scaling group. 4. OldestScalingConfigurationWithNewestInstance: Removes the latest automatically created instance in the scaling configuration that was first associated with the scaling group.
Instances List<Volcengine.GetScalingGroupInstance>: Collection of instance subresources managed manually within the scaling group (Attach / Detach / Remove)
InstancesDistribution Volcengine.GetScalingGroupInstancesDistribution: Instance distribution policy.
IsEnableScalingGroup bool: Whether to enable the scaling group. true: enabled. false: stopped
LaunchTemplateId string: Instance launch template ID. When configured, it indicates that the launch template is used as the source for the scaling configuration.
LaunchTemplateOverrides List<Volcengine.GetScalingGroupLaunchTemplateOverride>: Instance launch template information
LaunchTemplateVersion string: Instance launch template version. 1. A specific template version number. 2. Default: always use the default template version. 3. Latest: always use the latest template version.
LifecycleState string: Status of the scaling group. Active: enabled. InActive: not activated. Deleting: deleting. Locked: locked. CoolingDown: cooling down. Unknown: unknown status.
LoadBalancerHealthCheckGracePeriod int: Grace period for CLB health checks on scaling group instances
MaxInstanceNumber int: Maximum number of instances in the scaling group. Default value: 0 ~ 100. You can adjust this in the Quota Center.
MinInstanceNumber int: Minimum number of instances in the scaling group. Default value: 0–100. You can adjust this in the quota center.
MultiAzPolicy string: Scaling strategy. If you select multiple subnets, you must configure this parameter. 1. PRIORITY (default): priority strategy. 2. BALANCE: balanced distribution strategy.
ProjectName string: Project to which the scaling group belongs. Default is 'default'. A resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length: 64 characters.
ScalingGroupId string: Scaling group ID.
ScalingGroupName string: Scaling group name, unique within the same region. Must start with a Chinese character or letter, and can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length limit: 1 ~ 128 characters. Special characters are not supported.
ScalingMode string: Instance recycling mode for the scaling group. 1. release (default): Release mode. 2. recycle: Stop-and-recycle mode.
ServerGroupAttributes List<Volcengine.GetScalingGroupServerGroupAttribute>: Load balancer information associated with the scaling group.
StoppedInstanceCount int: Number of instances in the scaling group that are in the disabled state.
SubnetIds List<string>: List of subnet IDs for the primary network interface of instances in the scaling group
SuspendedProcesses List<string>: Paused processes. If there are no paused processes, returns an empty value. ScaleIn: scale-in process. ScaleOut: scale-out process. HealthCheck: health check. AlarmNotification: alarm task. ScheduledAction: scheduled task.
Tags List<Volcengine.GetScalingGroupTag>: Tag list.
TotalInstanceCount int: Number of instances currently in the scaling group
UpdatedTime string: Scaling group update time.
VpcId string: VPC ID to which the scaling group belongs

ActiveScalingConfigurationId string: ID of the scaling configuration bound to the scaling group
CreatedTime string: Scaling group creation time
DbInstanceIds []string: ID of the RDS database instance.
DefaultCooldown int: Cooldown period after a scaling activity (adding or removing ECS instances) completes. During the cooldown period, the scaling group does not perform other scaling activities; only scaling activities triggered by Cloud Monitoring alarms and scaling rules are effective. Value range: 5 ~ 86400 seconds. Default value: 300.
DesireInstanceNumber int: Expected number of running instances in the scaling group. 1. Must be no less than MinInstanceNumber and no greater than MaxInstanceNumber. 2. Default value: -1, which means the expected instance count feature is disabled. In this case, after the scaling group is created, scaling activities will automatically add the corresponding number of instances.
HealthCheckType string: Health check mode for the scaling group. 1. NONE: No instance health check. 2. ECS (default): Performs health checks on ECS instances in the scaling group.
Id string: Uniquely identifies the resource.
InstanceRemovePolicies []GetScalingGroupInstanceRemovePolicy: Instance removal policy
InstanceTerminatePolicy string: Instance removal policies: 1. OldestInstance: Removes the earliest instance added to the scaling group (including both automatically created and manually added instances). 2. NewestInstance: Removes the latest instance added to the scaling group (including both automatically created and manually added instances). 3. OldestScalingConfigurationWithOldestInstance (default): Removes the earliest automatically created instance in the scaling configuration that was first associated with the scaling group. 4. OldestScalingConfigurationWithNewestInstance: Removes the latest automatically created instance in the scaling configuration that was first associated with the scaling group.
Instances []GetScalingGroupInstance: Collection of instance subresources managed manually within the scaling group (Attach / Detach / Remove)
InstancesDistribution GetScalingGroupInstancesDistribution: Instance distribution policy.
IsEnableScalingGroup bool: Whether to enable the scaling group. true: enabled. false: stopped
LaunchTemplateId string: Instance launch template ID. When configured, it indicates that the launch template is used as the source for the scaling configuration.
LaunchTemplateOverrides []GetScalingGroupLaunchTemplateOverride: Instance launch template information
LaunchTemplateVersion string: Instance launch template version. 1. A specific template version number. 2. Default: always use the default template version. 3. Latest: always use the latest template version.
LifecycleState string: Status of the scaling group. Active: enabled. InActive: not activated. Deleting: deleting. Locked: locked. CoolingDown: cooling down. Unknown: unknown status.
LoadBalancerHealthCheckGracePeriod int: Grace period for CLB health checks on scaling group instances
MaxInstanceNumber int: Maximum number of instances in the scaling group. Default value: 0 ~ 100. You can adjust this in the Quota Center.
MinInstanceNumber int: Minimum number of instances in the scaling group. Default value: 0–100. You can adjust this in the quota center.
MultiAzPolicy string: Scaling strategy. If you select multiple subnets, you must configure this parameter. 1. PRIORITY (default): priority strategy. 2. BALANCE: balanced distribution strategy.
ProjectName string: Project to which the scaling group belongs. Default is 'default'. A resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length: 64 characters.
ScalingGroupId string: Scaling group ID.
ScalingGroupName string: Scaling group name, unique within the same region. Must start with a Chinese character or letter, and can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length limit: 1 ~ 128 characters. Special characters are not supported.
ScalingMode string: Instance recycling mode for the scaling group. 1. release (default): Release mode. 2. recycle: Stop-and-recycle mode.
ServerGroupAttributes []GetScalingGroupServerGroupAttribute: Load balancer information associated with the scaling group.
StoppedInstanceCount int: Number of instances in the scaling group that are in the disabled state.
SubnetIds []string: List of subnet IDs for the primary network interface of instances in the scaling group
SuspendedProcesses []string: Paused processes. If there are no paused processes, returns an empty value. ScaleIn: scale-in process. ScaleOut: scale-out process. HealthCheck: health check. AlarmNotification: alarm task. ScheduledAction: scheduled task.
Tags []GetScalingGroupTag: Tag list.
TotalInstanceCount int: Number of instances currently in the scaling group
UpdatedTime string: Scaling group update time.
VpcId string: VPC ID to which the scaling group belongs

activeScalingConfigurationId String: ID of the scaling configuration bound to the scaling group
createdTime String: Scaling group creation time
dbInstanceIds List<String>: ID of the RDS database instance.
defaultCooldown Integer: Cooldown period after a scaling activity (adding or removing ECS instances) completes. During the cooldown period, the scaling group does not perform other scaling activities; only scaling activities triggered by Cloud Monitoring alarms and scaling rules are effective. Value range: 5 ~ 86400 seconds. Default value: 300.
desireInstanceNumber Integer: Expected number of running instances in the scaling group. 1. Must be no less than MinInstanceNumber and no greater than MaxInstanceNumber. 2. Default value: -1, which means the expected instance count feature is disabled. In this case, after the scaling group is created, scaling activities will automatically add the corresponding number of instances.
healthCheckType String: Health check mode for the scaling group. 1. NONE: No instance health check. 2. ECS (default): Performs health checks on ECS instances in the scaling group.
id String: Uniquely identifies the resource.
instanceRemovePolicies List<GetScalingGroupInstanceRemovePolicy>: Instance removal policy
instanceTerminatePolicy String: Instance removal policies: 1. OldestInstance: Removes the earliest instance added to the scaling group (including both automatically created and manually added instances). 2. NewestInstance: Removes the latest instance added to the scaling group (including both automatically created and manually added instances). 3. OldestScalingConfigurationWithOldestInstance (default): Removes the earliest automatically created instance in the scaling configuration that was first associated with the scaling group. 4. OldestScalingConfigurationWithNewestInstance: Removes the latest automatically created instance in the scaling configuration that was first associated with the scaling group.
instances List<GetScalingGroupInstance>: Collection of instance subresources managed manually within the scaling group (Attach / Detach / Remove)
instancesDistribution GetScalingGroupInstancesDistribution: Instance distribution policy.
isEnableScalingGroup Boolean: Whether to enable the scaling group. true: enabled. false: stopped
launchTemplateId String: Instance launch template ID. When configured, it indicates that the launch template is used as the source for the scaling configuration.
launchTemplateOverrides List<GetScalingGroupLaunchTemplateOverride>: Instance launch template information
launchTemplateVersion String: Instance launch template version. 1. A specific template version number. 2. Default: always use the default template version. 3. Latest: always use the latest template version.
lifecycleState String: Status of the scaling group. Active: enabled. InActive: not activated. Deleting: deleting. Locked: locked. CoolingDown: cooling down. Unknown: unknown status.
loadBalancerHealthCheckGracePeriod Integer: Grace period for CLB health checks on scaling group instances
maxInstanceNumber Integer: Maximum number of instances in the scaling group. Default value: 0 ~ 100. You can adjust this in the Quota Center.
minInstanceNumber Integer: Minimum number of instances in the scaling group. Default value: 0–100. You can adjust this in the quota center.
multiAzPolicy String: Scaling strategy. If you select multiple subnets, you must configure this parameter. 1. PRIORITY (default): priority strategy. 2. BALANCE: balanced distribution strategy.
projectName String: Project to which the scaling group belongs. Default is 'default'. A resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length: 64 characters.
scalingGroupId String: Scaling group ID.
scalingGroupName String: Scaling group name, unique within the same region. Must start with a Chinese character or letter, and can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length limit: 1 ~ 128 characters. Special characters are not supported.
scalingMode String: Instance recycling mode for the scaling group. 1. release (default): Release mode. 2. recycle: Stop-and-recycle mode.
serverGroupAttributes List<GetScalingGroupServerGroupAttribute>: Load balancer information associated with the scaling group.
stoppedInstanceCount Integer: Number of instances in the scaling group that are in the disabled state.
subnetIds List<String>: List of subnet IDs for the primary network interface of instances in the scaling group
suspendedProcesses List<String>: Paused processes. If there are no paused processes, returns an empty value. ScaleIn: scale-in process. ScaleOut: scale-out process. HealthCheck: health check. AlarmNotification: alarm task. ScheduledAction: scheduled task.
tags List<GetScalingGroupTag>: Tag list.
totalInstanceCount Integer: Number of instances currently in the scaling group
updatedTime String: Scaling group update time.
vpcId String: VPC ID to which the scaling group belongs

activeScalingConfigurationId string: ID of the scaling configuration bound to the scaling group
createdTime string: Scaling group creation time
dbInstanceIds string[]: ID of the RDS database instance.
defaultCooldown number: Cooldown period after a scaling activity (adding or removing ECS instances) completes. During the cooldown period, the scaling group does not perform other scaling activities; only scaling activities triggered by Cloud Monitoring alarms and scaling rules are effective. Value range: 5 ~ 86400 seconds. Default value: 300.
desireInstanceNumber number: Expected number of running instances in the scaling group. 1. Must be no less than MinInstanceNumber and no greater than MaxInstanceNumber. 2. Default value: -1, which means the expected instance count feature is disabled. In this case, after the scaling group is created, scaling activities will automatically add the corresponding number of instances.
healthCheckType string: Health check mode for the scaling group. 1. NONE: No instance health check. 2. ECS (default): Performs health checks on ECS instances in the scaling group.
id string: Uniquely identifies the resource.
instanceRemovePolicies GetScalingGroupInstanceRemovePolicy[]: Instance removal policy
instanceTerminatePolicy string: Instance removal policies: 1. OldestInstance: Removes the earliest instance added to the scaling group (including both automatically created and manually added instances). 2. NewestInstance: Removes the latest instance added to the scaling group (including both automatically created and manually added instances). 3. OldestScalingConfigurationWithOldestInstance (default): Removes the earliest automatically created instance in the scaling configuration that was first associated with the scaling group. 4. OldestScalingConfigurationWithNewestInstance: Removes the latest automatically created instance in the scaling configuration that was first associated with the scaling group.
instances GetScalingGroupInstance[]: Collection of instance subresources managed manually within the scaling group (Attach / Detach / Remove)
instancesDistribution GetScalingGroupInstancesDistribution: Instance distribution policy.
isEnableScalingGroup boolean: Whether to enable the scaling group. true: enabled. false: stopped
launchTemplateId string: Instance launch template ID. When configured, it indicates that the launch template is used as the source for the scaling configuration.
launchTemplateOverrides GetScalingGroupLaunchTemplateOverride[]: Instance launch template information
launchTemplateVersion string: Instance launch template version. 1. A specific template version number. 2. Default: always use the default template version. 3. Latest: always use the latest template version.
lifecycleState string: Status of the scaling group. Active: enabled. InActive: not activated. Deleting: deleting. Locked: locked. CoolingDown: cooling down. Unknown: unknown status.
loadBalancerHealthCheckGracePeriod number: Grace period for CLB health checks on scaling group instances
maxInstanceNumber number: Maximum number of instances in the scaling group. Default value: 0 ~ 100. You can adjust this in the Quota Center.
minInstanceNumber number: Minimum number of instances in the scaling group. Default value: 0–100. You can adjust this in the quota center.
multiAzPolicy string: Scaling strategy. If you select multiple subnets, you must configure this parameter. 1. PRIORITY (default): priority strategy. 2. BALANCE: balanced distribution strategy.
projectName string: Project to which the scaling group belongs. Default is 'default'. A resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length: 64 characters.
scalingGroupId string: Scaling group ID.
scalingGroupName string: Scaling group name, unique within the same region. Must start with a Chinese character or letter, and can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length limit: 1 ~ 128 characters. Special characters are not supported.
scalingMode string: Instance recycling mode for the scaling group. 1. release (default): Release mode. 2. recycle: Stop-and-recycle mode.
serverGroupAttributes GetScalingGroupServerGroupAttribute[]: Load balancer information associated with the scaling group.
stoppedInstanceCount number: Number of instances in the scaling group that are in the disabled state.
subnetIds string[]: List of subnet IDs for the primary network interface of instances in the scaling group
suspendedProcesses string[]: Paused processes. If there are no paused processes, returns an empty value. ScaleIn: scale-in process. ScaleOut: scale-out process. HealthCheck: health check. AlarmNotification: alarm task. ScheduledAction: scheduled task.
tags GetScalingGroupTag[]: Tag list.
totalInstanceCount number: Number of instances currently in the scaling group
updatedTime string: Scaling group update time.
vpcId string: VPC ID to which the scaling group belongs

active_scaling_configuration_id str: ID of the scaling configuration bound to the scaling group
created_time str: Scaling group creation time
db_instance_ids Sequence[str]: ID of the RDS database instance.
default_cooldown int: Cooldown period after a scaling activity (adding or removing ECS instances) completes. During the cooldown period, the scaling group does not perform other scaling activities; only scaling activities triggered by Cloud Monitoring alarms and scaling rules are effective. Value range: 5 ~ 86400 seconds. Default value: 300.
desire_instance_number int: Expected number of running instances in the scaling group. 1. Must be no less than MinInstanceNumber and no greater than MaxInstanceNumber. 2. Default value: -1, which means the expected instance count feature is disabled. In this case, after the scaling group is created, scaling activities will automatically add the corresponding number of instances.
health_check_type str: Health check mode for the scaling group. 1. NONE: No instance health check. 2. ECS (default): Performs health checks on ECS instances in the scaling group.
id str: Uniquely identifies the resource.
instance_remove_policies Sequence[GetScalingGroupInstanceRemovePolicy]: Instance removal policy
instance_terminate_policy str: Instance removal policies: 1. OldestInstance: Removes the earliest instance added to the scaling group (including both automatically created and manually added instances). 2. NewestInstance: Removes the latest instance added to the scaling group (including both automatically created and manually added instances). 3. OldestScalingConfigurationWithOldestInstance (default): Removes the earliest automatically created instance in the scaling configuration that was first associated with the scaling group. 4. OldestScalingConfigurationWithNewestInstance: Removes the latest automatically created instance in the scaling configuration that was first associated with the scaling group.
instances Sequence[GetScalingGroupInstance]: Collection of instance subresources managed manually within the scaling group (Attach / Detach / Remove)
instances_distribution GetScalingGroupInstancesDistribution: Instance distribution policy.
is_enable_scaling_group bool: Whether to enable the scaling group. true: enabled. false: stopped
launch_template_id str: Instance launch template ID. When configured, it indicates that the launch template is used as the source for the scaling configuration.
launch_template_overrides Sequence[GetScalingGroupLaunchTemplateOverride]: Instance launch template information
launch_template_version str: Instance launch template version. 1. A specific template version number. 2. Default: always use the default template version. 3. Latest: always use the latest template version.
lifecycle_state str: Status of the scaling group. Active: enabled. InActive: not activated. Deleting: deleting. Locked: locked. CoolingDown: cooling down. Unknown: unknown status.
load_balancer_health_check_grace_period int: Grace period for CLB health checks on scaling group instances
max_instance_number int: Maximum number of instances in the scaling group. Default value: 0 ~ 100. You can adjust this in the Quota Center.
min_instance_number int: Minimum number of instances in the scaling group. Default value: 0–100. You can adjust this in the quota center.
multi_az_policy str: Scaling strategy. If you select multiple subnets, you must configure this parameter. 1. PRIORITY (default): priority strategy. 2. BALANCE: balanced distribution strategy.
project_name str: Project to which the scaling group belongs. Default is 'default'. A resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length: 64 characters.
scaling_group_id str: Scaling group ID.
scaling_group_name str: Scaling group name, unique within the same region. Must start with a Chinese character or letter, and can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length limit: 1 ~ 128 characters. Special characters are not supported.
scaling_mode str: Instance recycling mode for the scaling group. 1. release (default): Release mode. 2. recycle: Stop-and-recycle mode.
server_group_attributes Sequence[GetScalingGroupServerGroupAttribute]: Load balancer information associated with the scaling group.
stopped_instance_count int: Number of instances in the scaling group that are in the disabled state.
subnet_ids Sequence[str]: List of subnet IDs for the primary network interface of instances in the scaling group
suspended_processes Sequence[str]: Paused processes. If there are no paused processes, returns an empty value. ScaleIn: scale-in process. ScaleOut: scale-out process. HealthCheck: health check. AlarmNotification: alarm task. ScheduledAction: scheduled task.
tags Sequence[GetScalingGroupTag]: Tag list.
total_instance_count int: Number of instances currently in the scaling group
updated_time str: Scaling group update time.
vpc_id str: VPC ID to which the scaling group belongs

activeScalingConfigurationId String: ID of the scaling configuration bound to the scaling group
createdTime String: Scaling group creation time
dbInstanceIds List<String>: ID of the RDS database instance.
defaultCooldown Number: Cooldown period after a scaling activity (adding or removing ECS instances) completes. During the cooldown period, the scaling group does not perform other scaling activities; only scaling activities triggered by Cloud Monitoring alarms and scaling rules are effective. Value range: 5 ~ 86400 seconds. Default value: 300.
desireInstanceNumber Number: Expected number of running instances in the scaling group. 1. Must be no less than MinInstanceNumber and no greater than MaxInstanceNumber. 2. Default value: -1, which means the expected instance count feature is disabled. In this case, after the scaling group is created, scaling activities will automatically add the corresponding number of instances.
healthCheckType String: Health check mode for the scaling group. 1. NONE: No instance health check. 2. ECS (default): Performs health checks on ECS instances in the scaling group.
id String: Uniquely identifies the resource.
instanceRemovePolicies List<Property Map>: Instance removal policy
instanceTerminatePolicy String: Instance removal policies: 1. OldestInstance: Removes the earliest instance added to the scaling group (including both automatically created and manually added instances). 2. NewestInstance: Removes the latest instance added to the scaling group (including both automatically created and manually added instances). 3. OldestScalingConfigurationWithOldestInstance (default): Removes the earliest automatically created instance in the scaling configuration that was first associated with the scaling group. 4. OldestScalingConfigurationWithNewestInstance: Removes the latest automatically created instance in the scaling configuration that was first associated with the scaling group.
instances List<Property Map>: Collection of instance subresources managed manually within the scaling group (Attach / Detach / Remove)
instancesDistribution Property Map: Instance distribution policy.
isEnableScalingGroup Boolean: Whether to enable the scaling group. true: enabled. false: stopped
launchTemplateId String: Instance launch template ID. When configured, it indicates that the launch template is used as the source for the scaling configuration.
launchTemplateOverrides List<Property Map>: Instance launch template information
launchTemplateVersion String: Instance launch template version. 1. A specific template version number. 2. Default: always use the default template version. 3. Latest: always use the latest template version.
lifecycleState String: Status of the scaling group. Active: enabled. InActive: not activated. Deleting: deleting. Locked: locked. CoolingDown: cooling down. Unknown: unknown status.
loadBalancerHealthCheckGracePeriod Number: Grace period for CLB health checks on scaling group instances
maxInstanceNumber Number: Maximum number of instances in the scaling group. Default value: 0 ~ 100. You can adjust this in the Quota Center.
minInstanceNumber Number: Minimum number of instances in the scaling group. Default value: 0–100. You can adjust this in the quota center.
multiAzPolicy String: Scaling strategy. If you select multiple subnets, you must configure this parameter. 1. PRIORITY (default): priority strategy. 2. BALANCE: balanced distribution strategy.
projectName String: Project to which the scaling group belongs. Default is 'default'. A resource can belong to only one project. Only letters, numbers, underscores '_', dots '.', and hyphens '-' are allowed. Maximum length: 64 characters.
scalingGroupId String: Scaling group ID.
scalingGroupName String: Scaling group name, unique within the same region. Must start with a Chinese character or letter, and can only contain Chinese characters, letters, numbers, underscores, and hyphens. Length limit: 1 ~ 128 characters. Special characters are not supported.
scalingMode String: Instance recycling mode for the scaling group. 1. release (default): Release mode. 2. recycle: Stop-and-recycle mode.
serverGroupAttributes List<Property Map>: Load balancer information associated with the scaling group.
stoppedInstanceCount Number: Number of instances in the scaling group that are in the disabled state.
subnetIds List<String>: List of subnet IDs for the primary network interface of instances in the scaling group
suspendedProcesses List<String>: Paused processes. If there are no paused processes, returns an empty value. ScaleIn: scale-in process. ScaleOut: scale-out process. HealthCheck: health check. AlarmNotification: alarm task. ScheduledAction: scheduled task.
tags List<Property Map>: Tag list.
totalInstanceCount Number: Number of instances currently in the scaling group
updatedTime String: Scaling group update time.
vpcId String: VPC ID to which the scaling group belongs

Supporting Types

GetScalingGroupInstance

CreatedTime string: Time when the instance joined the scaling group
CreationType string: How the instance joined the scaling group (Attached / AutoCreated)
Entrusted bool: Whether to enable managed mode for the instance when AttachInstances is performed
InstanceId string: ECS instance ID, unique identifier of the subresource
LaunchTemplateId string: Launch template ID used by the instance
LaunchTemplateVersion string: Launch template version used by the instance
LifecycleHook bool: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
ScalingConfigurationId string: Scaling configuration ID associated with the instance
ScalingPolicyId string: Scaling policy ID associated with the instance
Status string: Current status of the instance in the scaling group
ZoneId string: Availability zone of the instance

CreatedTime string: Time when the instance joined the scaling group
CreationType string: How the instance joined the scaling group (Attached / AutoCreated)
Entrusted bool: Whether to enable managed mode for the instance when AttachInstances is performed
InstanceId string: ECS instance ID, unique identifier of the subresource
LaunchTemplateId string: Launch template ID used by the instance
LaunchTemplateVersion string: Launch template version used by the instance
LifecycleHook bool: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
ScalingConfigurationId string: Scaling configuration ID associated with the instance
ScalingPolicyId string: Scaling policy ID associated with the instance
Status string: Current status of the instance in the scaling group
ZoneId string: Availability zone of the instance

createdTime String: Time when the instance joined the scaling group
creationType String: How the instance joined the scaling group (Attached / AutoCreated)
entrusted Boolean: Whether to enable managed mode for the instance when AttachInstances is performed
instanceId String: ECS instance ID, unique identifier of the subresource
launchTemplateId String: Launch template ID used by the instance
launchTemplateVersion String: Launch template version used by the instance
lifecycleHook Boolean: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
scalingConfigurationId String: Scaling configuration ID associated with the instance
scalingPolicyId String: Scaling policy ID associated with the instance
status String: Current status of the instance in the scaling group
zoneId String: Availability zone of the instance

createdTime string: Time when the instance joined the scaling group
creationType string: How the instance joined the scaling group (Attached / AutoCreated)
entrusted boolean: Whether to enable managed mode for the instance when AttachInstances is performed
instanceId string: ECS instance ID, unique identifier of the subresource
launchTemplateId string: Launch template ID used by the instance
launchTemplateVersion string: Launch template version used by the instance
lifecycleHook boolean: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
scalingConfigurationId string: Scaling configuration ID associated with the instance
scalingPolicyId string: Scaling policy ID associated with the instance
status string: Current status of the instance in the scaling group
zoneId string: Availability zone of the instance

created_time str: Time when the instance joined the scaling group
creation_type str: How the instance joined the scaling group (Attached / AutoCreated)
entrusted bool: Whether to enable managed mode for the instance when AttachInstances is performed
instance_id str: ECS instance ID, unique identifier of the subresource
launch_template_id str: Launch template ID used by the instance
launch_template_version str: Launch template version used by the instance
lifecycle_hook bool: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
scaling_configuration_id str: Scaling configuration ID associated with the instance
scaling_policy_id str: Scaling policy ID associated with the instance
status str: Current status of the instance in the scaling group
zone_id str: Availability zone of the instance

createdTime String: Time when the instance joined the scaling group
creationType String: How the instance joined the scaling group (Attached / AutoCreated)
entrusted Boolean: Whether to enable managed mode for the instance when AttachInstances is performed
instanceId String: ECS instance ID, unique identifier of the subresource
launchTemplateId String: Launch template ID used by the instance
launchTemplateVersion String: Launch template version used by the instance
lifecycleHook Boolean: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
scalingConfigurationId String: Scaling configuration ID associated with the instance
scalingPolicyId String: Scaling policy ID associated with the instance
status String: Current status of the instance in the scaling group
zoneId String: Availability zone of the instance

GetScalingGroupInstanceRemovePolicy

DecreaseDesiredCapacity bool: Whether to decrease the desired instance count synchronously when DetachInstances or RemoveInstances is performed
DetachOption string: Instance removal policy for DetachInstances
ForceDelete bool: Whether to force delete the instance when RemoveInstances is performed
InstanceId string: ECS instance ID, unique identifier of the subresource
LifecycleHook bool: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
Mode string: Mode: How to handle an instance when it is removed from the scaling group: Detach means only remove from the scaling group, Remove means remove and delete the instance
RemoveMode string: Removal mode for RemoveInstances

DecreaseDesiredCapacity bool: Whether to decrease the desired instance count synchronously when DetachInstances or RemoveInstances is performed
DetachOption string: Instance removal policy for DetachInstances
ForceDelete bool: Whether to force delete the instance when RemoveInstances is performed
InstanceId string: ECS instance ID, unique identifier of the subresource
LifecycleHook bool: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
Mode string: Mode: How to handle an instance when it is removed from the scaling group: Detach means only remove from the scaling group, Remove means remove and delete the instance
RemoveMode string: Removal mode for RemoveInstances

decreaseDesiredCapacity Boolean: Whether to decrease the desired instance count synchronously when DetachInstances or RemoveInstances is performed
detachOption String: Instance removal policy for DetachInstances
forceDelete Boolean: Whether to force delete the instance when RemoveInstances is performed
instanceId String: ECS instance ID, unique identifier of the subresource
lifecycleHook Boolean: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
mode String: Mode: How to handle an instance when it is removed from the scaling group: Detach means only remove from the scaling group, Remove means remove and delete the instance
removeMode String: Removal mode for RemoveInstances

decreaseDesiredCapacity boolean: Whether to decrease the desired instance count synchronously when DetachInstances or RemoveInstances is performed
detachOption string: Instance removal policy for DetachInstances
forceDelete boolean: Whether to force delete the instance when RemoveInstances is performed
instanceId string: ECS instance ID, unique identifier of the subresource
lifecycleHook boolean: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
mode string: Mode: How to handle an instance when it is removed from the scaling group: Detach means only remove from the scaling group, Remove means remove and delete the instance
removeMode string: Removal mode for RemoveInstances

decrease_desired_capacity bool: Whether to decrease the desired instance count synchronously when DetachInstances or RemoveInstances is performed
detach_option str: Instance removal policy for DetachInstances
force_delete bool: Whether to force delete the instance when RemoveInstances is performed
instance_id str: ECS instance ID, unique identifier of the subresource
lifecycle_hook bool: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
mode str: Mode: How to handle an instance when it is removed from the scaling group: Detach means only remove from the scaling group, Remove means remove and delete the instance
remove_mode str: Removal mode for RemoveInstances

decreaseDesiredCapacity Boolean: Whether to decrease the desired instance count synchronously when DetachInstances or RemoveInstances is performed
detachOption String: Instance removal policy for DetachInstances
forceDelete Boolean: Whether to force delete the instance when RemoveInstances is performed
instanceId String: ECS instance ID, unique identifier of the subresource
lifecycleHook Boolean: Whether to trigger lifecycle hooks when the instance is attached, detached, or removed
mode String: Mode: How to handle an instance when it is removed from the scaling group: Detach means only remove from the scaling group, Remove means remove and delete the instance
removeMode String: Removal mode for RemoveInstances

GetScalingGroupInstancesDistribution

CompensateWithOnDemand bool: Whether pay-as-you-go instances are allowed to supplement spot capacity if spot instances cannot be created due to price or inventory constraints. true: allowed. false (default): not allowed.
OnDemandBaseCapacity int: Minimum number of pay-as-you-go instances in the scaling group. Value range: 0~2000. If the number of pay-as-you-go instances in the group is less than this value, pay-as-you-go instances will be prioritized for creation.
OnDemandPercentageAboveBaseCapacity int: After the scaling group meets the minimum number of pay-as-you-go instances, the proportion of pay-as-you-go instances among the excess instances. Value range: 0–100.
SpotInstanceRemedy bool: Whether to allow preemptible instance replacement upon expiration. If enabled, the scaling group will proactively create a new preemptible instance to replace the current one about 5 minutes before the preemptible instance is reclaimed. true: allowed. false (default): not allowed.

CompensateWithOnDemand bool: Whether pay-as-you-go instances are allowed to supplement spot capacity if spot instances cannot be created due to price or inventory constraints. true: allowed. false (default): not allowed.
OnDemandBaseCapacity int: Minimum number of pay-as-you-go instances in the scaling group. Value range: 0~2000. If the number of pay-as-you-go instances in the group is less than this value, pay-as-you-go instances will be prioritized for creation.
OnDemandPercentageAboveBaseCapacity int: After the scaling group meets the minimum number of pay-as-you-go instances, the proportion of pay-as-you-go instances among the excess instances. Value range: 0–100.
SpotInstanceRemedy bool: Whether to allow preemptible instance replacement upon expiration. If enabled, the scaling group will proactively create a new preemptible instance to replace the current one about 5 minutes before the preemptible instance is reclaimed. true: allowed. false (default): not allowed.

compensateWithOnDemand Boolean: Whether pay-as-you-go instances are allowed to supplement spot capacity if spot instances cannot be created due to price or inventory constraints. true: allowed. false (default): not allowed.
onDemandBaseCapacity Integer: Minimum number of pay-as-you-go instances in the scaling group. Value range: 0~2000. If the number of pay-as-you-go instances in the group is less than this value, pay-as-you-go instances will be prioritized for creation.
onDemandPercentageAboveBaseCapacity Integer: After the scaling group meets the minimum number of pay-as-you-go instances, the proportion of pay-as-you-go instances among the excess instances. Value range: 0–100.
spotInstanceRemedy Boolean: Whether to allow preemptible instance replacement upon expiration. If enabled, the scaling group will proactively create a new preemptible instance to replace the current one about 5 minutes before the preemptible instance is reclaimed. true: allowed. false (default): not allowed.

compensateWithOnDemand boolean: Whether pay-as-you-go instances are allowed to supplement spot capacity if spot instances cannot be created due to price or inventory constraints. true: allowed. false (default): not allowed.
onDemandBaseCapacity number: Minimum number of pay-as-you-go instances in the scaling group. Value range: 0~2000. If the number of pay-as-you-go instances in the group is less than this value, pay-as-you-go instances will be prioritized for creation.
onDemandPercentageAboveBaseCapacity number: After the scaling group meets the minimum number of pay-as-you-go instances, the proportion of pay-as-you-go instances among the excess instances. Value range: 0–100.
spotInstanceRemedy boolean: Whether to allow preemptible instance replacement upon expiration. If enabled, the scaling group will proactively create a new preemptible instance to replace the current one about 5 minutes before the preemptible instance is reclaimed. true: allowed. false (default): not allowed.

compensate_with_on_demand bool: Whether pay-as-you-go instances are allowed to supplement spot capacity if spot instances cannot be created due to price or inventory constraints. true: allowed. false (default): not allowed.
on_demand_base_capacity int: Minimum number of pay-as-you-go instances in the scaling group. Value range: 0~2000. If the number of pay-as-you-go instances in the group is less than this value, pay-as-you-go instances will be prioritized for creation.
on_demand_percentage_above_base_capacity int: After the scaling group meets the minimum number of pay-as-you-go instances, the proportion of pay-as-you-go instances among the excess instances. Value range: 0–100.
spot_instance_remedy bool: Whether to allow preemptible instance replacement upon expiration. If enabled, the scaling group will proactively create a new preemptible instance to replace the current one about 5 minutes before the preemptible instance is reclaimed. true: allowed. false (default): not allowed.

compensateWithOnDemand Boolean: Whether pay-as-you-go instances are allowed to supplement spot capacity if spot instances cannot be created due to price or inventory constraints. true: allowed. false (default): not allowed.
onDemandBaseCapacity Number: Minimum number of pay-as-you-go instances in the scaling group. Value range: 0~2000. If the number of pay-as-you-go instances in the group is less than this value, pay-as-you-go instances will be prioritized for creation.
onDemandPercentageAboveBaseCapacity Number: After the scaling group meets the minimum number of pay-as-you-go instances, the proportion of pay-as-you-go instances among the excess instances. Value range: 0–100.
spotInstanceRemedy Boolean: Whether to allow preemptible instance replacement upon expiration. If enabled, the scaling group will proactively create a new preemptible instance to replace the current one about 5 minutes before the preemptible instance is reclaimed. true: allowed. false (default): not allowed.

GetScalingGroupLaunchTemplateOverride

InstanceType string: Specify the instance type. This parameter is valid only when the LaunchTemplateId parameter is set.
PriceLimit double: Specify the maximum hourly price for spot instance types. This parameter is valid only when the LaunchTemplateId parameter is set and the launch template's billing mode is SpotWithPriceLimit.
WeightedCapacity int: Instance type weight

InstanceType string: Specify the instance type. This parameter is valid only when the LaunchTemplateId parameter is set.
PriceLimit float64: Specify the maximum hourly price for spot instance types. This parameter is valid only when the LaunchTemplateId parameter is set and the launch template's billing mode is SpotWithPriceLimit.
WeightedCapacity int: Instance type weight

instanceType String: Specify the instance type. This parameter is valid only when the LaunchTemplateId parameter is set.
priceLimit Double: Specify the maximum hourly price for spot instance types. This parameter is valid only when the LaunchTemplateId parameter is set and the launch template's billing mode is SpotWithPriceLimit.
weightedCapacity Integer: Instance type weight

instanceType string: Specify the instance type. This parameter is valid only when the LaunchTemplateId parameter is set.
priceLimit number: Specify the maximum hourly price for spot instance types. This parameter is valid only when the LaunchTemplateId parameter is set and the launch template's billing mode is SpotWithPriceLimit.
weightedCapacity number: Instance type weight

instance_type str: Specify the instance type. This parameter is valid only when the LaunchTemplateId parameter is set.
price_limit float: Specify the maximum hourly price for spot instance types. This parameter is valid only when the LaunchTemplateId parameter is set and the launch template's billing mode is SpotWithPriceLimit.
weighted_capacity int: Instance type weight

instanceType String: Specify the instance type. This parameter is valid only when the LaunchTemplateId parameter is set.
priceLimit Number: Specify the maximum hourly price for spot instance types. This parameter is valid only when the LaunchTemplateId parameter is set and the launch template's billing mode is SpotWithPriceLimit.
weightedCapacity Number: Instance type weight

GetScalingGroupServerGroupAttribute

LoadBalancerId string: ID of the load balancer instance.
Port int: Port number of the server in the backend server group for load balancing. Range: 1–65535.
ServerGroupId string: Backend server group ID for load balancing.
Type string: Load balancing server group type. A single CLB/ALB supports up to 20 backend server groups, and the total number of backend servers supported by all CLB/ALB is 100. ALB: Application Load Balancer. CLB: Classic Load Balancer (default).
Weight int: Weight of servers in the backend server group of the load balancer

LoadBalancerId string: ID of the load balancer instance.
Port int: Port number of the server in the backend server group for load balancing. Range: 1–65535.
ServerGroupId string: Backend server group ID for load balancing.
Type string: Load balancing server group type. A single CLB/ALB supports up to 20 backend server groups, and the total number of backend servers supported by all CLB/ALB is 100. ALB: Application Load Balancer. CLB: Classic Load Balancer (default).
Weight int: Weight of servers in the backend server group of the load balancer

loadBalancerId String: ID of the load balancer instance.
port Integer: Port number of the server in the backend server group for load balancing. Range: 1–65535.
serverGroupId String: Backend server group ID for load balancing.
type String: Load balancing server group type. A single CLB/ALB supports up to 20 backend server groups, and the total number of backend servers supported by all CLB/ALB is 100. ALB: Application Load Balancer. CLB: Classic Load Balancer (default).
weight Integer: Weight of servers in the backend server group of the load balancer

loadBalancerId string: ID of the load balancer instance.
port number: Port number of the server in the backend server group for load balancing. Range: 1–65535.
serverGroupId string: Backend server group ID for load balancing.
type string: Load balancing server group type. A single CLB/ALB supports up to 20 backend server groups, and the total number of backend servers supported by all CLB/ALB is 100. ALB: Application Load Balancer. CLB: Classic Load Balancer (default).
weight number: Weight of servers in the backend server group of the load balancer

load_balancer_id str: ID of the load balancer instance.
port int: Port number of the server in the backend server group for load balancing. Range: 1–65535.
server_group_id str: Backend server group ID for load balancing.
type str: Load balancing server group type. A single CLB/ALB supports up to 20 backend server groups, and the total number of backend servers supported by all CLB/ALB is 100. ALB: Application Load Balancer. CLB: Classic Load Balancer (default).
weight int: Weight of servers in the backend server group of the load balancer

loadBalancerId String: ID of the load balancer instance.
port Number: Port number of the server in the backend server group for load balancing. Range: 1–65535.
serverGroupId String: Backend server group ID for load balancing.
type String: Load balancing server group type. A single CLB/ALB supports up to 20 backend server groups, and the total number of backend servers supported by all CLB/ALB is 100. ALB: Application Load Balancer. CLB: Classic Load Balancer (default).
weight Number: Weight of servers in the backend server group of the load balancer

GetScalingGroupTag

Key string: User label tag key
Value string: The value of the user tag.

Key string: User label tag key
Value string: The value of the user tag.

key String: User label tag key
value String: The value of the user tag.

key string: User label tag key
value string: The value of the user tag.

key str: User label tag key
value str: The value of the user tag.

key String: User label tag key
value String: The value of the user tag.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.autoscaling.getScalingGroup

On this page

On this page

Using getScalingGroup

getScalingGroup Result

Supporting Types

GetScalingGroupInstance

GetScalingGroupInstanceRemovePolicy

GetScalingGroupInstancesDistribution

GetScalingGroupLaunchTemplateOverride

GetScalingGroupServerGroupAttribute

GetScalingGroupTag

Package Details

On this page

On this page