すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::ESS::ScalingRule

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::ESS::ScalingRule

    最終更新日:Jan 16, 2025

    ALIYUN::ESS::ScalingRule は、スケーリングルールを作成するために使用されます。

    構文

    {
  "Type": "ALIYUN::ESS::ScalingRule",
  "Properties": {
    "AdjustmentValue": Integer,
    "Cooldown": Integer,
    "ScalingGroupId": String,
    "AdjustmentType": String,
    "ScalingRuleName": String,
    "MetricName": String,
    "PredictiveTaskBufferTime": Integer,
    "ScalingRuleType": String,
    "PredictiveValueBuffer": Integer,
    "TargetValue": Number,
    "StepAdjustment": List,
    "PredictiveValueBehavior": String,
    "DisableScaleIn": Boolean,
    "InitialMaxSize": Integer,
    "MinAdjustmentMagnitude": Integer,
    "EstimatedInstanceWarmup": Integer,
    "PredictiveScalingMode": String,
    "ScaleInEvaluationCount": Integer,
    "ScaleOutEvaluationCount": Integer
  }
}

    プロパティ

    プロパティタイプ必須編集可能説明制約
    AdjustmentValueIntegerいいえはい

    スケーリング発生時に増減する ECS インスタンスの数。このパラメーターは、ScalingRuleType パラメーターが SimpleScalingRule または StepScalingRule に設定されている場合にのみ有効になります。

    		AdjustmentType の値に基づく有効な値：
    • AdjustmentType パラメーターが QuantityChangeInCapacity に設定されている場合の有効な値：-500 ～ 500
    • AdjustmentType パラメーターが PercentChangeInCapacity に設定されている場合の有効な値：-100 ～ 10000
    • AdjustmentType パラメーターが TotalCapacity に設定されている場合の有効な値：0 ～ 1000
    説明 1 回のスケーリングアクティビティで調整される ECS インスタンスの数は 500 を超えることはできません。
    CooldownIntegerいいえはいスケーリングルールのクールダウン期間。このパラメーターは、ScalingRuleType パラメーターが SimpleScalingRule に設定されている場合にのみ有効になります。有効な値：0 ～ 86400。

    単位：秒。

    デフォルトでは、このプロパティは空です。

    ScalingGroupIdStringはいいいえスケーリングルールが属するスケーリンググループの ID。なし。
    AdjustmentTypeStringいいえはいスケーリングルールの調整方法。このパラメーターは、ScalingRuleType パラメーターが SimpleScalingRule または StepScalingRule に設定されている場合にのみ有効になります。有効な値：
    • QuantityChangeInCapacity：スケーリンググループ内の ECS インスタンスの指定された数を増減します。
    • PercentChangeInCapacity：スケーリンググループ内の ECS インスタンスの指定された割合を増減します。
    • TotalCapacity：スケーリンググループ内の ECS インスタンスの数を特定の数まで増減します。
    ScalingRuleNameStringいいえはいスケーリングルール名。名前は 2 ～ 64 文字で、数字、文字、アンダースコア（_）、ハイフン（-）、ピリオド（.）を含めることができます。数字または文字で始める必要があります。

    このパラメーターが指定されていない場合、デフォルトで ScalingRuleId の値が使用されます。

    MetricNameStringいいえいいえ監視する定義済みメトリック。このパラメーターは必須であり、ScalingRuleType パラメーターが TargetTrackingScalingRule または PredictiveScalingRule に設定されている場合にのみ適用されます。
    • ScalingRuleType パラメーターが TargetTrackingScalingRule に設定されている場合の有効な値：
      • CpuUtilization：平均 CPU 使用率
      • ClassicInternetRx：クラシックネットワーク経由の平均インターネット受信トラフィック
      • ClassicInternetTx：クラシックネットワーク経由の平均インターネット送信トラフィック
      • VpcInternetRx：VPC 経由の平均インターネット受信トラフィック
      • VpcInternetTx：VPC 経由の平均インターネット送信トラフィック
      • IntranetRx：内部ネットワーク経由の平均受信トラフィック
      • IntranetTx：内部ネットワーク経由の平均送信トラフィック
    • ScalingRuleType パラメーターが PredictiveScalingRule に設定されている場合の有効な値：
      • CpuUtilization：平均 CPU 使用率
      • IntranetRx：内部ネットワーク経由の平均受信トラフィック
      • IntranetTx：内部ネットワーク経由の平均送信トラフィック
    PredictiveTaskBufferTimeIntegerいいえいいえ予測タスク実行時間より前のバッファ期間。デフォルトでは、予測スケーリングルール用に自動的に作成されるすべてのスケジュール済みタスクは毎時実行されます。リソースを事前に準備できるように、バッファ期間を設定して予測タスクを事前に実行できます。有効な値：0 ～ 60。

    単位：分。

    デフォルト値：0。
    ScalingRuleTypeStringいいえいいえスケーリングルールのタイプ。デフォルト値：SimpleScalingRule。有効な値：
    • SimpleScalingRule：AdjustmentType および AdjustmentValue の値に基づいて ECS インスタンスをスケーリングします。
    • TargetTrackingScalingRule：スケーリングする ECS インスタンスの数を動的に計算し、定義済みメトリックの値を TargetValue に近づけます。
    • StepScalingRule：指定されたしきい値とメトリック値に基づいて ECS インスタンスを段階的にスケーリングします。
    • PredictiveScalingRule：機械学習を使用してスケーリンググループの履歴監視データを分析し、メトリックの将来値を予測します。ルールはスケーリンググループの境界値を設定するためのスケジュール済みタスクを自動的に作成します。
    PredictiveValueBufferIntegerいいえいいえPredictiveValueBehavior が PredictiveValueOverrideMaxWithBuffer に設定されている場合、予測値に対する増分の比率。この比率で増加した予測値が初期最大容量より大きい場合、増加後の値が予測タスクの最大値として使用されます。有効な値：0 ～ 100。

    デフォルト値：0。

    TargetValueNumberいいえいいえ期待されるメトリック値。このパラメーターは、ScalingRuleType パラメーターが TargetTrackingScalingRule または PredictiveScalingRule に設定されている場合にのみ有効になります。値は 0 より大きく、小数点以下最大 3 桁まで指定できます。
    StepAdjustmentListいいえいいえステップスケーリングのステップ調整。詳細については、StepAdjustment プロパティ をご参照ください。
    PredictiveValueBehaviorStringいいえいいえ予測最大値に対して実行されるアクション。デフォルト値：MaxOverridePredictiveValue。有効な値：
    • MaxOverridePredictiveValue：予測値が初期最大容量より大きい場合、予測タスクの最大値として初期最大容量を使用します。
    • PredictiveValueOverrideMax：予測値が初期最大容量より大きい場合、予測タスクの最大値として予測値を使用します。
    • PredictiveValueOverrideMaxWithBuffer：予測値を PredictiveValueBuffer で指定された比率で増加させます。増加後の値が初期最大容量より大きい場合、増加後の値が予測タスクの最大値として使用されます。
    DisableScaleInBooleanいいえいいえスケールインを無効にするかどうかを指定します。このパラメーターは、ScalingRuleType パラメーターが TargetTrackingScalingRule に設定されている場合にのみ有効になります。デフォルト値：false。有効な値：
    • true
    • false
    InitialMaxSizeIntegerいいえいいえPredictiveValueBehavior パラメーターと共に使用される、スケーリンググループ内の ECS インスタンスの最大数。このパラメーターのデフォルト値は MaxSize の値です。
    MinAdjustmentMagnitudeIntegerいいえいいえスケーリングルールで調整される ECS インスタンスの最小数。このパラメーターは、ScalingRuleType パラメーターが SimpleScalingRule または StepScalingRule に設定され、AdjustmentType パラメーターが PercentChangeInCapacity に設定されている場合にのみ有効になります。
    EstimatedInstanceWarmupIntegerいいえいいえECS インスタンスのウォームアップ期間。このパラメーターは、ScalingRuleType パラメーターが TargetTrackingScalingRule または StepScalingRule に設定されている場合にのみ有効になります。有効な値：0 ～ 86400。

    単位：秒。

    デフォルト値：300。

    システムはウォームアップ状態の ECS インスタンスをスケーリンググループに追加しますが、ウォームアップ期間中は CloudMonitor に監視データを報告しません。

    説明 システムが調整される ECS インスタンスの数を計算する場合、ウォームアップ状態の ECS インスタンスはスケーリンググループの現在の容量の一部としてカウントされません。
    PredictiveScalingModeStringいいえいいえ予測スケーリングルールのモード。デフォルト値：PredictAndScale。有効な値：
    • PredictAndScale：予測結果を生成し、予測タスクを作成します。
    • PredictOnly：予測結果を生成しますが、予測タスクは作成しません。
    ScaleInEvaluationCountIntegerいいえはいスケールインアクティビティ用に作成されたイベントトリガータスクがアラートをトリガーする前にしきい値条件を満たす必要がある連続回数。ターゲットトラッキングスケーリングルールが作成されると、イベントトリガータスクが自動的に作成されます。

    デフォルト値：15。

    ScaleOutEvaluationCountIntegerいいえはいスケールアウトアクティビティ用に作成されたイベントトリガータスクがアラートをトリガーする前にしきい値条件を満たす必要がある連続回数。ターゲットトラッキングスケーリングルールが作成されると、イベントトリガータスクが自動的に作成されます。

    デフォルト値：3。

    StepAdjustment 構文

    "StepAdjustment": [
  {
    "MetricIntervalUpperBound": Number,
    "ScalingAdjustment": Integer,
    "MetricIntervalLowerBound": Number
  }
]

    StepAdjustment プロパティ

    プロパティタイプ必須編集可能説明制約
    MetricIntervalUpperBoundNumberいいえいいえステップ調整で指定された上限値。このパラメーターは、ScalingRuleType パラメーターが StepScalingRule に設定されている場合にのみ有効になります。有効な値：-9.999999E18 ～ 9.999999E18
    ScalingAdjustmentIntegerいいえいいえステップ調整で調整される ECS インスタンスの指定数。このパラメーターは、ScalingRuleType パラメーターが StepScalingRule に設定されている場合にのみ有効になります。なし。
    MetricIntervalLowerBoundNumberいいえいいえステップ調整で指定された下限値。このパラメーターは、ScalingRuleType パラメーターが StepScalingRule に設定されている場合にのみ有効になります。有効な値：-9.999999E18 ～ 9.999999E18

    戻り値

    Fn::GetAtt

    • ScalingRuleAri：スケーリングルールの一意の識別子。
    • ScalingRuleId：スケーリングルールの ID。この ID は、システムによって生成されるグローバルに一意の識別子（GUID）です。

    例

    • YAML 形式

      ROSTemplateFormatVersion: '2015-09-01'
Description: Test ESS ScalingRule
Parameters:
  AutoScalingGroupId:
    Type: String
    AssociationProperty: ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId
Resources:
  ScalingRule:
    Type: ALIYUN::ESS::ScalingRule
    Properties:
      AdjustmentType: QuantityChangeInCapacity
      ScalingGroupId:
        Ref: AutoScalingGroupId
      AdjustmentValue: 1
Outputs: {}

    • JSON 形式

      {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test ESS ScalingRule",
  "Parameters": {
    "AutoScalingGroupId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ESS::AutoScalingGroup::AutoScalingGroupId"
    }
  },
  "Resources": {
    "ScalingRule": {
      "Type": "ALIYUN::ESS::ScalingRule",
      "Properties": {
        "AdjustmentType": "QuantityChangeInCapacity",
        "ScalingGroupId": {
          "Ref": "AutoScalingGroupId"
        },
        "AdjustmentValue": 1
      }
    }
  },
  "Outputs": {
  }
}