Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
published on Thursday, Apr 2, 2026 by Byteplus
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
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 dictionaryThe 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:
- Adjustment
Type 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.
- 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 Byteplus.Get Scaling Policy Alarm Policy - 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.
- Is
Enabled boolPolicy - Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
- Scaling
Group stringId - Scaling group ID.
- Scaling
Policy stringId - Scaling rule ID.
- Scaling
Policy stringName - Name of the scaling rule.
- Scaling
Policy stringType - Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
- Scheduled
Policy Byteplus.Get Scaling Policy Scheduled Policy - 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 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.
- 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 GetScaling Policy Alarm Policy - 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.
- Is
Enabled boolPolicy - Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
- Scaling
Group stringId - Scaling group ID.
- Scaling
Policy stringId - Scaling rule ID.
- Scaling
Policy stringName - Name of the scaling rule.
- Scaling
Policy stringType - Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
- Scheduled
Policy GetScaling Policy Scheduled Policy - 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 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.
- adjustment
Value 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.
- alarm
Policy GetScaling Policy Alarm Policy - 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.
- is
Enabled BooleanPolicy - Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
- scaling
Group StringId - Scaling group ID.
- scaling
Policy StringId - Scaling rule ID.
- scaling
Policy StringName - Name of the scaling rule.
- scaling
Policy StringType - Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
- scheduled
Policy GetScaling Policy Scheduled Policy - 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 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.
- adjustment
Value 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.
- alarm
Policy GetScaling Policy Alarm Policy - 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.
- is
Enabled booleanPolicy - Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
- scaling
Group stringId - Scaling group ID.
- scaling
Policy stringId - Scaling rule ID.
- scaling
Policy stringName - Name of the scaling rule.
- scaling
Policy stringType - Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
- scheduled
Policy GetScaling Policy Scheduled Policy - 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 GetScaling Policy Alarm Policy - 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_ boolpolicy - Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
- scaling_
group_ strid - Scaling group ID.
- scaling_
policy_ strid - Scaling rule ID.
- scaling_
policy_ strname - Name of the scaling rule.
- scaling_
policy_ strtype - Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
- scheduled_
policy GetScaling Policy Scheduled Policy - 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.
- adjustment
Type 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.
- adjustment
Value 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.
- alarm
Policy 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.
- is
Enabled BooleanPolicy - Status of the scaling rule. Options: true: enabled. false: disabled. The scaling group must be in Active status.
- scaling
Group StringId - Scaling group ID.
- scaling
Policy StringId - Scaling rule ID.
- scaling
Policy StringName - Name of the scaling rule.
- scaling
Policy StringType - Type of scaling rule. Options: Scheduled: scheduled task. Recurrence: recurring task. Alarm: alarm task.
- scheduled
Policy 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.
Get Scaling Policy Alarm Policy Condition - Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.
- Condition
Operator 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.
Get Scaling Policy Alarm Policy Condition> - 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.
- 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 string - Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.
- Condition
Get
Scaling Policy Alarm Policy Condition - Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.
- Condition
Operator 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
[]Get
Scaling Policy Alarm Policy Condition - 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.
- 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 string - Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.
- condition
Get
Scaling Policy Alarm Policy Condition - Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.
- condition
Operator 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<Get
Scaling Policy Alarm Policy Condition> - 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.
- evaluation
Count 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.
- rule
Type String - Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.
- condition
Get
Scaling Policy Alarm Policy Condition - Detailed monitoring metric information for single-metric monitoring. Valid only when ScalingPolicyType is set to Alarm.
- condition
Operator 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
Get
Scaling Policy Alarm Policy Condition[] - 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.
- evaluation
Count 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.
- rule
Type string - Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.
- condition
Get
Scaling Policy Alarm Policy Condition - 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[Get
Scaling Policy Alarm Policy Condition] - 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.
- condition
Operator 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.
- evaluation
Count 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.
- rule
Type String - Type of alarm task. Options: Static: static monitoring collected by agent. Valid only when ScalingPolicyType is set to Alarm and required.
GetScalingPolicyAlarmPolicyCondition
- Comparison
Operator string - Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
- Metric
Name 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.
- Metric
Unit 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 string - Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
- Metric
Name 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.
- Metric
Unit 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 String - Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
- metric
Name 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.
- metric
Unit 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 string - Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
- metric
Name 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.
- metric
Unit 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.
- comparison
Operator String - Rule expression object for metric alarms. >: Greater than. <: Less than. =: Equal to.
- metric
Name 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.
- metric
Unit 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
- Launch
Time 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.
- Launch
Time stringRead - Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
- Recurrence
End stringTime - 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 stringTime Read - Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
- Recurrence
Start stringTime - Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
- Recurrence
Type 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.
- Recurrence
Value 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 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.
- Launch
Time stringRead - Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
- Recurrence
End stringTime - 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 stringTime Read - Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
- Recurrence
Start stringTime - Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
- Recurrence
Type 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.
- Recurrence
Value 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 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.
- launch
Time StringRead - Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
- recurrence
End StringTime - 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 StringTime Read - Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
- recurrence
Start StringTime - Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
- recurrence
Type 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.
- recurrence
Value 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 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.
- launch
Time stringRead - Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
- recurrence
End stringTime - 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 stringTime Read - Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
- recurrence
Start stringTime - Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
- recurrence
Type 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.
- recurrence
Value 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_ strread - Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
- recurrence_
end_ strtime - 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_ strtime_ read - Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
- recurrence_
start_ strtime - 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.
- launch
Time 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.
- launch
Time StringRead - Indicates the task trigger time. This is a read-only field; use LaunchTime to modify or create.
- recurrence
End StringTime - 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 StringTime Read - Indicates the end time for the recurring task. Read-only field; use RecurrenceEndTime for modification or creation.
- recurrence
Start StringTime - Indicates the start time for the recurring task. Valid only when ScalingPolicyType is set to Recurrence.
- recurrence
Type 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.
- recurrence
Value 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
byteplusccTerraform Provider.
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
published on Thursday, Apr 2, 2026 by Byteplus
