1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. autoscaling
  5. getScalingPolicy
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
bytepluscc logo
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus

    Data Source schema for Byteplus::AutoScaling::ScalingPolicy

    Using getScalingPolicy

    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 getScalingPolicy(args: GetScalingPolicyArgs, opts?: InvokeOptions): Promise<GetScalingPolicyResult>
    function getScalingPolicyOutput(args: GetScalingPolicyOutputArgs, opts?: InvokeOptions): Output<GetScalingPolicyResult>
    def get_scaling_policy(id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetScalingPolicyResult
    def get_scaling_policy_output(id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetScalingPolicyResult]
    func LookupScalingPolicy(ctx *Context, args *LookupScalingPolicyArgs, opts ...InvokeOption) (*LookupScalingPolicyResult, error)
    func LookupScalingPolicyOutput(ctx *Context, args *LookupScalingPolicyOutputArgs, opts ...InvokeOption) LookupScalingPolicyResultOutput

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

    public static class GetScalingPolicy 
    {
        public static Task<GetScalingPolicyResult> InvokeAsync(GetScalingPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetScalingPolicyResult> Invoke(GetScalingPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetScalingPolicyResult> getScalingPolicy(GetScalingPolicyArgs args, InvokeOptions options)
    public static Output<GetScalingPolicyResult> getScalingPolicy(GetScalingPolicyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: bytepluscc:autoscaling/getScalingPolicy:getScalingPolicy
      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.

    getScalingPolicy Result

    The following output properties are available:

    AdjustmentType string
    Scaling actions for the scaling rule, applicable to simple and step rules. QuantityChangeInCapacity: increase or decrease a specified number of instances. PercentChangeInCapacity: increase or decrease a specified percentage of instances. TotalCapacity: adjust the number of instances in the current scaling group to the specified value.
    AdjustmentValue int
    Adjustment value for scaling actions, applicable to simple and step rules. When AdjustmentType is set to QuantityChangeInCapacity: -100 to 100, cannot be 0, unit: instances. When AdjustmentType is set to PercentChangeInCapacity: -100 to 10000, cannot be 0, unit: %. When AdjustmentType is set to TotalCapacity: defaults to 0 to 100, unit: instances.
    AlarmPolicy Byteplus.GetScalingPolicyAlarmPolicy
    Detailed information about the alarm task.
    Cooldown int
    Cooldown time for scaling rules. Value: 0–86400, unit: seconds. If not specified, the scaling group's cooldown time is used by default.
    Id string
    Uniquely identifies the resource.
    IsEnabledPolicy bool
    Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
    ScalingGroupId string
    Scaling group ID.
    ScalingPolicyId string
    Scaling rule ID.
    ScalingPolicyName string
    Name of the scaling rule.
    ScalingPolicyType string
    Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
    ScheduledPolicy Byteplus.GetScalingPolicyScheduledPolicy
    Detailed information for scheduled/recurring tasks.
    Status string
    Status of the scaling rule. Options: Active: enabled. Inactive: disabled. The scaling group must be in Active status.
    AdjustmentType string
    Scaling actions for the scaling rule, applicable to simple and step rules. QuantityChangeInCapacity: increase or decrease a specified number of instances. PercentChangeInCapacity: increase or decrease a specified percentage of instances. TotalCapacity: adjust the number of instances in the current scaling group to the specified value.
    AdjustmentValue int
    Adjustment value for scaling actions, applicable to simple and step rules. When AdjustmentType is set to QuantityChangeInCapacity: -100 to 100, cannot be 0, unit: instances. When AdjustmentType is set to PercentChangeInCapacity: -100 to 10000, cannot be 0, unit: %. When AdjustmentType is set to TotalCapacity: defaults to 0 to 100, unit: instances.
    AlarmPolicy GetScalingPolicyAlarmPolicy
    Detailed information about the alarm task.
    Cooldown int
    Cooldown time for scaling rules. Value: 0–86400, unit: seconds. If not specified, the scaling group's cooldown time is used by default.
    Id string
    Uniquely identifies the resource.
    IsEnabledPolicy bool
    Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
    ScalingGroupId string
    Scaling group ID.
    ScalingPolicyId string
    Scaling rule ID.
    ScalingPolicyName string
    Name of the scaling rule.
    ScalingPolicyType string
    Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
    ScheduledPolicy GetScalingPolicyScheduledPolicy
    Detailed information for scheduled/recurring tasks.
    Status string
    Status of the scaling rule. Options: Active: enabled. Inactive: disabled. The scaling group must be in Active status.
    adjustmentType String
    Scaling actions for the scaling rule, applicable to simple and step rules. QuantityChangeInCapacity: increase or decrease a specified number of instances. PercentChangeInCapacity: increase or decrease a specified percentage of instances. TotalCapacity: adjust the number of instances in the current scaling group to the specified value.
    adjustmentValue Integer
    Adjustment value for scaling actions, applicable to simple and step rules. When AdjustmentType is set to QuantityChangeInCapacity: -100 to 100, cannot be 0, unit: instances. When AdjustmentType is set to PercentChangeInCapacity: -100 to 10000, cannot be 0, unit: %. When AdjustmentType is set to TotalCapacity: defaults to 0 to 100, unit: instances.
    alarmPolicy GetScalingPolicyAlarmPolicy
    Detailed information about the alarm task.
    cooldown Integer
    Cooldown time for scaling rules. Value: 0–86400, unit: seconds. If not specified, the scaling group's cooldown time is used by default.
    id String
    Uniquely identifies the resource.
    isEnabledPolicy Boolean
    Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
    scalingGroupId String
    Scaling group ID.
    scalingPolicyId String
    Scaling rule ID.
    scalingPolicyName String
    Name of the scaling rule.
    scalingPolicyType String
    Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
    scheduledPolicy GetScalingPolicyScheduledPolicy
    Detailed information for scheduled/recurring tasks.
    status String
    Status of the scaling rule. Options: Active: enabled. Inactive: disabled. The scaling group must be in Active status.
    adjustmentType string
    Scaling actions for the scaling rule, applicable to simple and step rules. QuantityChangeInCapacity: increase or decrease a specified number of instances. PercentChangeInCapacity: increase or decrease a specified percentage of instances. TotalCapacity: adjust the number of instances in the current scaling group to the specified value.
    adjustmentValue number
    Adjustment value for scaling actions, applicable to simple and step rules. When AdjustmentType is set to QuantityChangeInCapacity: -100 to 100, cannot be 0, unit: instances. When AdjustmentType is set to PercentChangeInCapacity: -100 to 10000, cannot be 0, unit: %. When AdjustmentType is set to TotalCapacity: defaults to 0 to 100, unit: instances.
    alarmPolicy GetScalingPolicyAlarmPolicy
    Detailed information about the alarm task.
    cooldown number
    Cooldown time for scaling rules. Value: 0–86400, unit: seconds. If not specified, the scaling group's cooldown time is used by default.
    id string
    Uniquely identifies the resource.
    isEnabledPolicy boolean
    Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
    scalingGroupId string
    Scaling group ID.
    scalingPolicyId string
    Scaling rule ID.
    scalingPolicyName string
    Name of the scaling rule.
    scalingPolicyType string
    Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
    scheduledPolicy GetScalingPolicyScheduledPolicy
    Detailed information for scheduled/recurring tasks.
    status string
    Status of the scaling rule. Options: Active: enabled. Inactive: disabled. The scaling group must be in Active status.
    adjustment_type str
    Scaling actions for the scaling rule, applicable to simple and step rules. QuantityChangeInCapacity: increase or decrease a specified number of instances. PercentChangeInCapacity: increase or decrease a specified percentage of instances. TotalCapacity: adjust the number of instances in the current scaling group to the specified value.
    adjustment_value int
    Adjustment value for scaling actions, applicable to simple and step rules. When AdjustmentType is set to QuantityChangeInCapacity: -100 to 100, cannot be 0, unit: instances. When AdjustmentType is set to PercentChangeInCapacity: -100 to 10000, cannot be 0, unit: %. When AdjustmentType is set to TotalCapacity: defaults to 0 to 100, unit: instances.
    alarm_policy GetScalingPolicyAlarmPolicy
    Detailed information about the alarm task.
    cooldown int
    Cooldown time for scaling rules. Value: 0–86400, unit: seconds. If not specified, the scaling group's cooldown time is used by default.
    id str
    Uniquely identifies the resource.
    is_enabled_policy bool
    Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
    scaling_group_id str
    Scaling group ID.
    scaling_policy_id str
    Scaling rule ID.
    scaling_policy_name str
    Name of the scaling rule.
    scaling_policy_type str
    Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
    scheduled_policy GetScalingPolicyScheduledPolicy
    Detailed information for scheduled/recurring tasks.
    status str
    Status of the scaling rule. Options: Active: enabled. Inactive: disabled. The scaling group must be in Active status.
    adjustmentType String
    Scaling actions for the scaling rule, applicable to simple and step rules. QuantityChangeInCapacity: increase or decrease a specified number of instances. PercentChangeInCapacity: increase or decrease a specified percentage of instances. TotalCapacity: adjust the number of instances in the current scaling group to the specified value.
    adjustmentValue Number
    Adjustment value for scaling actions, applicable to simple and step rules. When AdjustmentType is set to QuantityChangeInCapacity: -100 to 100, cannot be 0, unit: instances. When AdjustmentType is set to PercentChangeInCapacity: -100 to 10000, cannot be 0, unit: %. When AdjustmentType is set to TotalCapacity: defaults to 0 to 100, unit: instances.
    alarmPolicy Property Map
    Detailed information about the alarm task.
    cooldown Number
    Cooldown time for scaling rules. Value: 0–86400, unit: seconds. If not specified, the scaling group's cooldown time is used by default.
    id String
    Uniquely identifies the resource.
    isEnabledPolicy Boolean
    Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
    scalingGroupId String
    Scaling group ID.
    scalingPolicyId String
    Scaling rule ID.
    scalingPolicyName String
    Name of the scaling rule.
    scalingPolicyType String
    Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
    scheduledPolicy Property Map
    Detailed information for scheduled/recurring tasks.
    status String
    Status of the scaling rule. Options: Active: enabled. Inactive: disabled. The scaling group must be in Active status.

    Supporting Types

    GetScalingPolicyAlarmPolicy

    Condition Byteplus.GetScalingPolicyAlarmPolicyCondition
    Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.
    ConditionOperator string
    Determination conditions for multi-metric alarms. &&: Alarm is triggered only when all metrics meet the conditions. || (default): Alarm is triggered when any metric meets the condition.
    Conditions List<Byteplus.GetScalingPolicyAlarmPolicyCondition>
    Detailed information about monitoring metrics for multi-metric monitoring. Valid only when ScalingPolicyType is set to Alarm. You must configure either AlarmPolicy.Condition.x or AlarmPolicy.Conditions.x parameters. If both are configured, only AlarmPolicy.Conditions.x takes effect.
    Effective string
    The effective period for the alarm task.
    EvaluationCount int
    Scaling actions are triggered when monitoring metric data reaches the threshold for several consecutive times. Valid only when ScalingPolicyType is set to Alarm and required.
    RuleType string
    Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.
    Condition GetScalingPolicyAlarmPolicyCondition
    Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.
    ConditionOperator string
    Determination conditions for multi-metric alarms. &&: Alarm is triggered only when all metrics meet the conditions. || (default): Alarm is triggered when any metric meets the condition.
    Conditions []GetScalingPolicyAlarmPolicyCondition
    Detailed information about monitoring metrics for multi-metric monitoring. Valid only when ScalingPolicyType is set to Alarm. You must configure either AlarmPolicy.Condition.x or AlarmPolicy.Conditions.x parameters. If both are configured, only AlarmPolicy.Conditions.x takes effect.
    Effective string
    The effective period for the alarm task.
    EvaluationCount int
    Scaling actions are triggered when monitoring metric data reaches the threshold for several consecutive times. Valid only when ScalingPolicyType is set to Alarm and required.
    RuleType string
    Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.
    condition GetScalingPolicyAlarmPolicyCondition
    Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.
    conditionOperator String
    Determination conditions for multi-metric alarms. &&: Alarm is triggered only when all metrics meet the conditions. || (default): Alarm is triggered when any metric meets the condition.
    conditions List<GetScalingPolicyAlarmPolicyCondition>
    Detailed information about monitoring metrics for multi-metric monitoring. Valid only when ScalingPolicyType is set to Alarm. You must configure either AlarmPolicy.Condition.x or AlarmPolicy.Conditions.x parameters. If both are configured, only AlarmPolicy.Conditions.x takes effect.
    effective String
    The effective period for the alarm task.
    evaluationCount Integer
    Scaling actions are triggered when monitoring metric data reaches the threshold for several consecutive times. Valid only when ScalingPolicyType is set to Alarm and required.
    ruleType String
    Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.
    condition GetScalingPolicyAlarmPolicyCondition
    Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.
    conditionOperator string
    Determination conditions for multi-metric alarms. &&: Alarm is triggered only when all metrics meet the conditions. || (default): Alarm is triggered when any metric meets the condition.
    conditions GetScalingPolicyAlarmPolicyCondition[]
    Detailed information about monitoring metrics for multi-metric monitoring. Valid only when ScalingPolicyType is set to Alarm. You must configure either AlarmPolicy.Condition.x or AlarmPolicy.Conditions.x parameters. If both are configured, only AlarmPolicy.Conditions.x takes effect.
    effective string
    The effective period for the alarm task.
    evaluationCount number
    Scaling actions are triggered when monitoring metric data reaches the threshold for several consecutive times. Valid only when ScalingPolicyType is set to Alarm and required.
    ruleType string
    Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.
    condition GetScalingPolicyAlarmPolicyCondition
    Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.
    condition_operator str
    Determination conditions for multi-metric alarms. &&: Alarm is triggered only when all metrics meet the conditions. || (default): Alarm is triggered when any metric meets the condition.
    conditions Sequence[GetScalingPolicyAlarmPolicyCondition]
    Detailed information about monitoring metrics for multi-metric monitoring. Valid only when ScalingPolicyType is set to Alarm. You must configure either AlarmPolicy.Condition.x or AlarmPolicy.Conditions.x parameters. If both are configured, only AlarmPolicy.Conditions.x takes effect.
    effective str
    The effective period for the alarm task.
    evaluation_count int
    Scaling actions are triggered when monitoring metric data reaches the threshold for several consecutive times. Valid only when ScalingPolicyType is set to Alarm and required.
    rule_type str
    Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.
    condition Property Map
    Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.
    conditionOperator String
    Determination conditions for multi-metric alarms. &&: Alarm is triggered only when all metrics meet the conditions. || (default): Alarm is triggered when any metric meets the condition.
    conditions List<Property Map>
    Detailed information about monitoring metrics for multi-metric monitoring. Valid only when ScalingPolicyType is set to Alarm. You must configure either AlarmPolicy.Condition.x or AlarmPolicy.Conditions.x parameters. If both are configured, only AlarmPolicy.Conditions.x takes effect.
    effective String
    The effective period for the alarm task.
    evaluationCount Number
    Scaling actions are triggered when monitoring metric data reaches the threshold for several consecutive times. Valid only when ScalingPolicyType is set to Alarm and required.
    ruleType String
    Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.

    GetScalingPolicyAlarmPolicyCondition

    ComparisonOperator string
    Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
    MetricName string
    Monitoring metric names for metric alarms. CpuTotalMax: Maximum in-band CPU usage. CpuTotalMin: Minimum in-band CPU usage. CpuTotalAvg: Average in-band CPU usage. MemoryUsedUtilizationMax: Maximum in-band memory usage. MemoryUsedUtilizationMin: Minimum in-band memory usage. MemoryUsedUtilizationAvg: Average in-band memory usage. InstanceCpuBusyMax: Maximum out-of-band CPU utilization. InstanceCpuBusyMin: Minimum out-of-band CPU utilization. InstanceCpuBusyAvg: Average out-of-band CPU utilization. InstanceNetTxBitsAvg: Average out-of-band network outbound rate. InstanceNetRxBitsAvg: Average out-of-band network inbound rate. InstanceNetTxPacketsAvg: Average out-of-band network packet send rate. InstanceNetRxPacketsAvg: Average out-of-band network packet receive rate. SystemDiskReadBytesAvg: Average in-band system disk read bandwidth. SystemDiskWriteBytesAvg: Average in-band system disk write bandwidth. SystemDiskReadIOPSAvg: Average in-band system disk read IOPS. SystemDiskWriteIOPSAvg: Average in-band system disk write IOPS. NetTcpConnection_Avg: Average in-band TCP connection count.
    MetricUnit string
    The unit for the monitoring metric threshold when an alarm is triggered. When the AlarmPolicy.Conditions.MetricName parameter is set to CPU/memory usage: Percent. When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write bandwidth: Bytes/Second(IEC). When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write IOPS: Count/Second. When the AlarmPolicy.Conditions.MetricName parameter is set to TCP connections: Count. When the AlarmPolicy.Condition.MetricName parameter is set to network inbound/outbound rate: Bits/Second(IEC). When the AlarmPolicy.Condition.MetricName parameter is set to network packet transmission rate: Packet/Second.
    Threshold string
    The threshold value for the monitoring metric when an alarm is triggered. When AlarmPolicy.Conditions.MetricUnit is set to Percent: 1–100. When AlarmPolicy.Conditions.MetricUnit is set to Bytes/Second(IEC): an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count/Second: an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count: an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Bits/Second(IEC): an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Packet/Second: an integer greater than 0.
    ComparisonOperator string
    Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
    MetricName string
    Monitoring metric names for metric alarms. CpuTotalMax: Maximum in-band CPU usage. CpuTotalMin: Minimum in-band CPU usage. CpuTotalAvg: Average in-band CPU usage. MemoryUsedUtilizationMax: Maximum in-band memory usage. MemoryUsedUtilizationMin: Minimum in-band memory usage. MemoryUsedUtilizationAvg: Average in-band memory usage. InstanceCpuBusyMax: Maximum out-of-band CPU utilization. InstanceCpuBusyMin: Minimum out-of-band CPU utilization. InstanceCpuBusyAvg: Average out-of-band CPU utilization. InstanceNetTxBitsAvg: Average out-of-band network outbound rate. InstanceNetRxBitsAvg: Average out-of-band network inbound rate. InstanceNetTxPacketsAvg: Average out-of-band network packet send rate. InstanceNetRxPacketsAvg: Average out-of-band network packet receive rate. SystemDiskReadBytesAvg: Average in-band system disk read bandwidth. SystemDiskWriteBytesAvg: Average in-band system disk write bandwidth. SystemDiskReadIOPSAvg: Average in-band system disk read IOPS. SystemDiskWriteIOPSAvg: Average in-band system disk write IOPS. NetTcpConnection_Avg: Average in-band TCP connection count.
    MetricUnit string
    The unit for the monitoring metric threshold when an alarm is triggered. When the AlarmPolicy.Conditions.MetricName parameter is set to CPU/memory usage: Percent. When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write bandwidth: Bytes/Second(IEC). When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write IOPS: Count/Second. When the AlarmPolicy.Conditions.MetricName parameter is set to TCP connections: Count. When the AlarmPolicy.Condition.MetricName parameter is set to network inbound/outbound rate: Bits/Second(IEC). When the AlarmPolicy.Condition.MetricName parameter is set to network packet transmission rate: Packet/Second.
    Threshold string
    The threshold value for the monitoring metric when an alarm is triggered. When AlarmPolicy.Conditions.MetricUnit is set to Percent: 1–100. When AlarmPolicy.Conditions.MetricUnit is set to Bytes/Second(IEC): an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count/Second: an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count: an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Bits/Second(IEC): an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Packet/Second: an integer greater than 0.
    comparisonOperator String
    Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
    metricName String
    Monitoring metric names for metric alarms. CpuTotalMax: Maximum in-band CPU usage. CpuTotalMin: Minimum in-band CPU usage. CpuTotalAvg: Average in-band CPU usage. MemoryUsedUtilizationMax: Maximum in-band memory usage. MemoryUsedUtilizationMin: Minimum in-band memory usage. MemoryUsedUtilizationAvg: Average in-band memory usage. InstanceCpuBusyMax: Maximum out-of-band CPU utilization. InstanceCpuBusyMin: Minimum out-of-band CPU utilization. InstanceCpuBusyAvg: Average out-of-band CPU utilization. InstanceNetTxBitsAvg: Average out-of-band network outbound rate. InstanceNetRxBitsAvg: Average out-of-band network inbound rate. InstanceNetTxPacketsAvg: Average out-of-band network packet send rate. InstanceNetRxPacketsAvg: Average out-of-band network packet receive rate. SystemDiskReadBytesAvg: Average in-band system disk read bandwidth. SystemDiskWriteBytesAvg: Average in-band system disk write bandwidth. SystemDiskReadIOPSAvg: Average in-band system disk read IOPS. SystemDiskWriteIOPSAvg: Average in-band system disk write IOPS. NetTcpConnection_Avg: Average in-band TCP connection count.
    metricUnit String
    The unit for the monitoring metric threshold when an alarm is triggered. When the AlarmPolicy.Conditions.MetricName parameter is set to CPU/memory usage: Percent. When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write bandwidth: Bytes/Second(IEC). When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write IOPS: Count/Second. When the AlarmPolicy.Conditions.MetricName parameter is set to TCP connections: Count. When the AlarmPolicy.Condition.MetricName parameter is set to network inbound/outbound rate: Bits/Second(IEC). When the AlarmPolicy.Condition.MetricName parameter is set to network packet transmission rate: Packet/Second.
    threshold String
    The threshold value for the monitoring metric when an alarm is triggered. When AlarmPolicy.Conditions.MetricUnit is set to Percent: 1–100. When AlarmPolicy.Conditions.MetricUnit is set to Bytes/Second(IEC): an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count/Second: an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count: an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Bits/Second(IEC): an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Packet/Second: an integer greater than 0.
    comparisonOperator string
    Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
    metricName string
    Monitoring metric names for metric alarms. CpuTotalMax: Maximum in-band CPU usage. CpuTotalMin: Minimum in-band CPU usage. CpuTotalAvg: Average in-band CPU usage. MemoryUsedUtilizationMax: Maximum in-band memory usage. MemoryUsedUtilizationMin: Minimum in-band memory usage. MemoryUsedUtilizationAvg: Average in-band memory usage. InstanceCpuBusyMax: Maximum out-of-band CPU utilization. InstanceCpuBusyMin: Minimum out-of-band CPU utilization. InstanceCpuBusyAvg: Average out-of-band CPU utilization. InstanceNetTxBitsAvg: Average out-of-band network outbound rate. InstanceNetRxBitsAvg: Average out-of-band network inbound rate. InstanceNetTxPacketsAvg: Average out-of-band network packet send rate. InstanceNetRxPacketsAvg: Average out-of-band network packet receive rate. SystemDiskReadBytesAvg: Average in-band system disk read bandwidth. SystemDiskWriteBytesAvg: Average in-band system disk write bandwidth. SystemDiskReadIOPSAvg: Average in-band system disk read IOPS. SystemDiskWriteIOPSAvg: Average in-band system disk write IOPS. NetTcpConnection_Avg: Average in-band TCP connection count.
    metricUnit string
    The unit for the monitoring metric threshold when an alarm is triggered. When the AlarmPolicy.Conditions.MetricName parameter is set to CPU/memory usage: Percent. When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write bandwidth: Bytes/Second(IEC). When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write IOPS: Count/Second. When the AlarmPolicy.Conditions.MetricName parameter is set to TCP connections: Count. When the AlarmPolicy.Condition.MetricName parameter is set to network inbound/outbound rate: Bits/Second(IEC). When the AlarmPolicy.Condition.MetricName parameter is set to network packet transmission rate: Packet/Second.
    threshold string
    The threshold value for the monitoring metric when an alarm is triggered. When AlarmPolicy.Conditions.MetricUnit is set to Percent: 1–100. When AlarmPolicy.Conditions.MetricUnit is set to Bytes/Second(IEC): an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count/Second: an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count: an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Bits/Second(IEC): an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Packet/Second: an integer greater than 0.
    comparison_operator str
    Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
    metric_name str
    Monitoring metric names for metric alarms. CpuTotalMax: Maximum in-band CPU usage. CpuTotalMin: Minimum in-band CPU usage. CpuTotalAvg: Average in-band CPU usage. MemoryUsedUtilizationMax: Maximum in-band memory usage. MemoryUsedUtilizationMin: Minimum in-band memory usage. MemoryUsedUtilizationAvg: Average in-band memory usage. InstanceCpuBusyMax: Maximum out-of-band CPU utilization. InstanceCpuBusyMin: Minimum out-of-band CPU utilization. InstanceCpuBusyAvg: Average out-of-band CPU utilization. InstanceNetTxBitsAvg: Average out-of-band network outbound rate. InstanceNetRxBitsAvg: Average out-of-band network inbound rate. InstanceNetTxPacketsAvg: Average out-of-band network packet send rate. InstanceNetRxPacketsAvg: Average out-of-band network packet receive rate. SystemDiskReadBytesAvg: Average in-band system disk read bandwidth. SystemDiskWriteBytesAvg: Average in-band system disk write bandwidth. SystemDiskReadIOPSAvg: Average in-band system disk read IOPS. SystemDiskWriteIOPSAvg: Average in-band system disk write IOPS. NetTcpConnection_Avg: Average in-band TCP connection count.
    metric_unit str
    The unit for the monitoring metric threshold when an alarm is triggered. When the AlarmPolicy.Conditions.MetricName parameter is set to CPU/memory usage: Percent. When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write bandwidth: Bytes/Second(IEC). When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write IOPS: Count/Second. When the AlarmPolicy.Conditions.MetricName parameter is set to TCP connections: Count. When the AlarmPolicy.Condition.MetricName parameter is set to network inbound/outbound rate: Bits/Second(IEC). When the AlarmPolicy.Condition.MetricName parameter is set to network packet transmission rate: Packet/Second.
    threshold str
    The threshold value for the monitoring metric when an alarm is triggered. When AlarmPolicy.Conditions.MetricUnit is set to Percent: 1–100. When AlarmPolicy.Conditions.MetricUnit is set to Bytes/Second(IEC): an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count/Second: an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count: an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Bits/Second(IEC): an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Packet/Second: an integer greater than 0.
    comparisonOperator String
    Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
    metricName String
    Monitoring metric names for metric alarms. CpuTotalMax: Maximum in-band CPU usage. CpuTotalMin: Minimum in-band CPU usage. CpuTotalAvg: Average in-band CPU usage. MemoryUsedUtilizationMax: Maximum in-band memory usage. MemoryUsedUtilizationMin: Minimum in-band memory usage. MemoryUsedUtilizationAvg: Average in-band memory usage. InstanceCpuBusyMax: Maximum out-of-band CPU utilization. InstanceCpuBusyMin: Minimum out-of-band CPU utilization. InstanceCpuBusyAvg: Average out-of-band CPU utilization. InstanceNetTxBitsAvg: Average out-of-band network outbound rate. InstanceNetRxBitsAvg: Average out-of-band network inbound rate. InstanceNetTxPacketsAvg: Average out-of-band network packet send rate. InstanceNetRxPacketsAvg: Average out-of-band network packet receive rate. SystemDiskReadBytesAvg: Average in-band system disk read bandwidth. SystemDiskWriteBytesAvg: Average in-band system disk write bandwidth. SystemDiskReadIOPSAvg: Average in-band system disk read IOPS. SystemDiskWriteIOPSAvg: Average in-band system disk write IOPS. NetTcpConnection_Avg: Average in-band TCP connection count.
    metricUnit String
    The unit for the monitoring metric threshold when an alarm is triggered. When the AlarmPolicy.Conditions.MetricName parameter is set to CPU/memory usage: Percent. When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write bandwidth: Bytes/Second(IEC). When the AlarmPolicy.Conditions.MetricName parameter is set to system disk read/write IOPS: Count/Second. When the AlarmPolicy.Conditions.MetricName parameter is set to TCP connections: Count. When the AlarmPolicy.Condition.MetricName parameter is set to network inbound/outbound rate: Bits/Second(IEC). When the AlarmPolicy.Condition.MetricName parameter is set to network packet transmission rate: Packet/Second.
    threshold String
    The threshold value for the monitoring metric when an alarm is triggered. When AlarmPolicy.Conditions.MetricUnit is set to Percent: 1–100. When AlarmPolicy.Conditions.MetricUnit is set to Bytes/Second(IEC): an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count/Second: an integer greater than 0. When AlarmPolicy.Conditions.MetricUnit is set to Count: an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Bits/Second(IEC): an integer greater than 0. When AlarmPolicy.Condition.MetricUnit is set to Packet/Second: an integer greater than 0.

    GetScalingPolicyScheduledPolicy

    LaunchTime string
    Indicates the trigger time for the task. The default is the current time. When ScalingPolicyType is set to Scheduled, this specifies the trigger time for the scheduled task. When ScalingPolicyType is set to Recurrence: If ScheduledPolicy.RecurrenceType is empty, the task is executed only once at the specified date and time. If ScheduledPolicy.RecurrenceType is not empty, this specifies the start time for the recurring task.
    LaunchTimeRead string
    Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
    RecurrenceEndTime string
    Indicates the end time for the recurring task. Only supports selecting a time within 365 days from the creation date. If not configured, defaults to one day/week/month after the current time based on the recurrence cycle (ScheduledPolicy.RecurrenceType). If set to empty, the task never stops. Valid only when ScalingPolicyType is set to Recurrence and required.
    RecurrenceEndTimeRead string
    Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
    RecurrenceStartTime string
    Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
    RecurrenceType string
    Indicates the recurrence cycle for scheduled tasks. Values: Daily: Executes once every XX days. Weekly: Select specific days of the week, executes once per day. Monthly: Select XX to XX days of the month, executes once per day. Cron: Executes according to the specified Cron expression. Required and valid only when ScalingPolicyType is set to Recurrence.
    RecurrenceValue string
    Specifies the value for recurring tasks. When the ScheduledPolicy.RecurrenceType parameter is set to Daily, only one value can be entered: 1–31. When the ScheduledPolicy.RecurrenceType parameter is set to Weekly, multiple values can be entered, separated by commas (,). Values for Monday to Sunday are: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday). When the ScheduledPolicy.RecurrenceType parameter is set to Monthly, the format is A-B. Both A and B range from 1–31, and B must be greater than or equal to A. When the ScheduledPolicy.RecurrenceType parameter is set to Cron, it uses UTC+8 time and supports a five-field expression for minute, hour, day, month, and week. Wildcards supported include comma (,), question mark (?), hyphen (-), asterisk (*), hash (#), slash (/), L, and W. This field is valid and required when ScalingPolicyType is set to Recurrence.
    LaunchTime string
    Indicates the trigger time for the task. The default is the current time. When ScalingPolicyType is set to Scheduled, this specifies the trigger time for the scheduled task. When ScalingPolicyType is set to Recurrence: If ScheduledPolicy.RecurrenceType is empty, the task is executed only once at the specified date and time. If ScheduledPolicy.RecurrenceType is not empty, this specifies the start time for the recurring task.
    LaunchTimeRead string
    Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
    RecurrenceEndTime string
    Indicates the end time for the recurring task. Only supports selecting a time within 365 days from the creation date. If not configured, defaults to one day/week/month after the current time based on the recurrence cycle (ScheduledPolicy.RecurrenceType). If set to empty, the task never stops. Valid only when ScalingPolicyType is set to Recurrence and required.
    RecurrenceEndTimeRead string
    Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
    RecurrenceStartTime string
    Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
    RecurrenceType string
    Indicates the recurrence cycle for scheduled tasks. Values: Daily: Executes once every XX days. Weekly: Select specific days of the week, executes once per day. Monthly: Select XX to XX days of the month, executes once per day. Cron: Executes according to the specified Cron expression. Required and valid only when ScalingPolicyType is set to Recurrence.
    RecurrenceValue string
    Specifies the value for recurring tasks. When the ScheduledPolicy.RecurrenceType parameter is set to Daily, only one value can be entered: 1–31. When the ScheduledPolicy.RecurrenceType parameter is set to Weekly, multiple values can be entered, separated by commas (,). Values for Monday to Sunday are: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday). When the ScheduledPolicy.RecurrenceType parameter is set to Monthly, the format is A-B. Both A and B range from 1–31, and B must be greater than or equal to A. When the ScheduledPolicy.RecurrenceType parameter is set to Cron, it uses UTC+8 time and supports a five-field expression for minute, hour, day, month, and week. Wildcards supported include comma (,), question mark (?), hyphen (-), asterisk (*), hash (#), slash (/), L, and W. This field is valid and required when ScalingPolicyType is set to Recurrence.
    launchTime String
    Indicates the trigger time for the task. The default is the current time. When ScalingPolicyType is set to Scheduled, this specifies the trigger time for the scheduled task. When ScalingPolicyType is set to Recurrence: If ScheduledPolicy.RecurrenceType is empty, the task is executed only once at the specified date and time. If ScheduledPolicy.RecurrenceType is not empty, this specifies the start time for the recurring task.
    launchTimeRead String
    Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
    recurrenceEndTime String
    Indicates the end time for the recurring task. Only supports selecting a time within 365 days from the creation date. If not configured, defaults to one day/week/month after the current time based on the recurrence cycle (ScheduledPolicy.RecurrenceType). If set to empty, the task never stops. Valid only when ScalingPolicyType is set to Recurrence and required.
    recurrenceEndTimeRead String
    Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
    recurrenceStartTime String
    Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
    recurrenceType String
    Indicates the recurrence cycle for scheduled tasks. Values: Daily: Executes once every XX days. Weekly: Select specific days of the week, executes once per day. Monthly: Select XX to XX days of the month, executes once per day. Cron: Executes according to the specified Cron expression. Required and valid only when ScalingPolicyType is set to Recurrence.
    recurrenceValue String
    Specifies the value for recurring tasks. When the ScheduledPolicy.RecurrenceType parameter is set to Daily, only one value can be entered: 1–31. When the ScheduledPolicy.RecurrenceType parameter is set to Weekly, multiple values can be entered, separated by commas (,). Values for Monday to Sunday are: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday). When the ScheduledPolicy.RecurrenceType parameter is set to Monthly, the format is A-B. Both A and B range from 1–31, and B must be greater than or equal to A. When the ScheduledPolicy.RecurrenceType parameter is set to Cron, it uses UTC+8 time and supports a five-field expression for minute, hour, day, month, and week. Wildcards supported include comma (,), question mark (?), hyphen (-), asterisk (*), hash (#), slash (/), L, and W. This field is valid and required when ScalingPolicyType is set to Recurrence.
    launchTime string
    Indicates the trigger time for the task. The default is the current time. When ScalingPolicyType is set to Scheduled, this specifies the trigger time for the scheduled task. When ScalingPolicyType is set to Recurrence: If ScheduledPolicy.RecurrenceType is empty, the task is executed only once at the specified date and time. If ScheduledPolicy.RecurrenceType is not empty, this specifies the start time for the recurring task.
    launchTimeRead string
    Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
    recurrenceEndTime string
    Indicates the end time for the recurring task. Only supports selecting a time within 365 days from the creation date. If not configured, defaults to one day/week/month after the current time based on the recurrence cycle (ScheduledPolicy.RecurrenceType). If set to empty, the task never stops. Valid only when ScalingPolicyType is set to Recurrence and required.
    recurrenceEndTimeRead string
    Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
    recurrenceStartTime string
    Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
    recurrenceType string
    Indicates the recurrence cycle for scheduled tasks. Values: Daily: Executes once every XX days. Weekly: Select specific days of the week, executes once per day. Monthly: Select XX to XX days of the month, executes once per day. Cron: Executes according to the specified Cron expression. Required and valid only when ScalingPolicyType is set to Recurrence.
    recurrenceValue string
    Specifies the value for recurring tasks. When the ScheduledPolicy.RecurrenceType parameter is set to Daily, only one value can be entered: 1–31. When the ScheduledPolicy.RecurrenceType parameter is set to Weekly, multiple values can be entered, separated by commas (,). Values for Monday to Sunday are: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday). When the ScheduledPolicy.RecurrenceType parameter is set to Monthly, the format is A-B. Both A and B range from 1–31, and B must be greater than or equal to A. When the ScheduledPolicy.RecurrenceType parameter is set to Cron, it uses UTC+8 time and supports a five-field expression for minute, hour, day, month, and week. Wildcards supported include comma (,), question mark (?), hyphen (-), asterisk (*), hash (#), slash (/), L, and W. This field is valid and required when ScalingPolicyType is set to Recurrence.
    launch_time str
    Indicates the trigger time for the task. The default is the current time. When ScalingPolicyType is set to Scheduled, this specifies the trigger time for the scheduled task. When ScalingPolicyType is set to Recurrence: If ScheduledPolicy.RecurrenceType is empty, the task is executed only once at the specified date and time. If ScheduledPolicy.RecurrenceType is not empty, this specifies the start time for the recurring task.
    launch_time_read str
    Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
    recurrence_end_time str
    Indicates the end time for the recurring task. Only supports selecting a time within 365 days from the creation date. If not configured, defaults to one day/week/month after the current time based on the recurrence cycle (ScheduledPolicy.RecurrenceType). If set to empty, the task never stops. Valid only when ScalingPolicyType is set to Recurrence and required.
    recurrence_end_time_read str
    Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
    recurrence_start_time str
    Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
    recurrence_type str
    Indicates the recurrence cycle for scheduled tasks. Values: Daily: Executes once every XX days. Weekly: Select specific days of the week, executes once per day. Monthly: Select XX to XX days of the month, executes once per day. Cron: Executes according to the specified Cron expression. Required and valid only when ScalingPolicyType is set to Recurrence.
    recurrence_value str
    Specifies the value for recurring tasks. When the ScheduledPolicy.RecurrenceType parameter is set to Daily, only one value can be entered: 1–31. When the ScheduledPolicy.RecurrenceType parameter is set to Weekly, multiple values can be entered, separated by commas (,). Values for Monday to Sunday are: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday). When the ScheduledPolicy.RecurrenceType parameter is set to Monthly, the format is A-B. Both A and B range from 1–31, and B must be greater than or equal to A. When the ScheduledPolicy.RecurrenceType parameter is set to Cron, it uses UTC+8 time and supports a five-field expression for minute, hour, day, month, and week. Wildcards supported include comma (,), question mark (?), hyphen (-), asterisk (*), hash (#), slash (/), L, and W. This field is valid and required when ScalingPolicyType is set to Recurrence.
    launchTime String
    Indicates the trigger time for the task. The default is the current time. When ScalingPolicyType is set to Scheduled, this specifies the trigger time for the scheduled task. When ScalingPolicyType is set to Recurrence: If ScheduledPolicy.RecurrenceType is empty, the task is executed only once at the specified date and time. If ScheduledPolicy.RecurrenceType is not empty, this specifies the start time for the recurring task.
    launchTimeRead String
    Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
    recurrenceEndTime String
    Indicates the end time for the recurring task. Only supports selecting a time within 365 days from the creation date. If not configured, defaults to one day/week/month after the current time based on the recurrence cycle (ScheduledPolicy.RecurrenceType). If set to empty, the task never stops. Valid only when ScalingPolicyType is set to Recurrence and required.
    recurrenceEndTimeRead String
    Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
    recurrenceStartTime String
    Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
    recurrenceType String
    Indicates the recurrence cycle for scheduled tasks. Values: Daily: Executes once every XX days. Weekly: Select specific days of the week, executes once per day. Monthly: Select XX to XX days of the month, executes once per day. Cron: Executes according to the specified Cron expression. Required and valid only when ScalingPolicyType is set to Recurrence.
    recurrenceValue String
    Specifies the value for recurring tasks. When the ScheduledPolicy.RecurrenceType parameter is set to Daily, only one value can be entered: 1–31. When the ScheduledPolicy.RecurrenceType parameter is set to Weekly, multiple values can be entered, separated by commas (,). Values for Monday to Sunday are: 1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday). When the ScheduledPolicy.RecurrenceType parameter is set to Monthly, the format is A-B. Both A and B range from 1–31, and B must be greater than or equal to A. When the ScheduledPolicy.RecurrenceType parameter is set to Cron, it uses UTC+8 time and supports a five-field expression for minute, hour, day, month, and week. Wildcards supported include comma (,), question mark (?), hyphen (-), asterisk (*), hash (#), slash (/), L, and W. This field is valid and required when ScalingPolicyType is set to Recurrence.

    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.21
    published on Thursday, Apr 2, 2026 by Byteplus
      Try Pulumi Cloud free. Your team will thank you.