DescribeScalingRules - Auto Scaling - Alibaba Cloud ドキュメントセンター

スケーリングルールを照会します。このオペレーションを呼び出す際に、スケーリングルールの ID、名前、または Alibaba Cloud リソースネーム (ARN) を指定して、対象のスケーリングルールの調整方法、インスタンスのウォームアップ期間、および関連付けられたイベントトリガーのタスクなどの詳細を照会できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ess:DescribeScalingRules

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	照会するスケーリングルールが属するスケーリンググループのリージョン ID です。	cn-qingdao
PageNumber	integer	任意	ページ番号です。ページは 1 から始まります。デフォルト値：1	1
PageSize	integer	任意	ページあたりのエントリ数です。最大値：50。デフォルト値：10	50
ScalingGroupId	string	任意	スケーリンググループの ID です。	asg-bp1ffogfdauy0jw0****
ScalingRuleType	string	任意	スケーリングルールのタイプです。有効な値は次のとおりです。 SimpleScalingRule：`AdjustmentType` パラメーターと `AdjustmentValue` パラメーターの値に基づいて ECS インスタンスの数を調整します。 TargetTrackingScalingRule：動的な方法でスケーリングする必要がある ECS インスタンスの数を計算し、事前定義されたメトリクスの値を `TargetValue` パラメーターの値に近くなるように維持します。 StepScalingRule：指定されたしきい値とメトリクス値に基づいて、ECS インスタンスを段階的にスケーリングします。 PredictiveScalingRule：機械学習を使用してスケーリンググループの履歴モニタリングデータを分析し、メトリクスの将来値を予測します。さらに、Auto Scaling (ESS) は、スケーリンググループの境界値を調整するためのスケジュールされたタスクを自動的に作成します。	SimpleScalingRule
ShowAlarmRules	boolean	任意	スケーリングルールに関連付けられているイベントトリガーのタスクを返すかどうかを指定します。有効な値は次のとおりです。 true false デフォルト値：false	false
ScalingRuleIds	array	任意	照会するスケーリングルールの ID の配列です。
	string	任意	照会するスケーリングルールの ID です。	asr-bp1dvirgwkoowxk7****
ScalingRuleNames	array	任意	照会するスケーリングルールの名前の配列です。
	string	任意	照会するスケーリングルールの名前です。	scalingrule****
ScalingRuleAris	array	任意	照会するスケーリングルールの一意の識別子の配列です。
	string	任意	照会するスケーリングルールの一意の識別子です。	ari:acs:ess:cn-hangzhou:140692647406**:scalingrule/asr-bp1dvirgwkoowxk7**

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	返されたページのページ番号です。	1
PageSize	integer	ページごとに返されるエントリ数です。	50
TotalCount	integer	スケーリングルールの総数です。	1
ScalingRules	array<object>	スケーリングルールです。
	array<object>	スケーリングルールです。
MetricName	string	スケーリングルールに関連付けられているアラームのメトリクス名です。	CpuUtilization
AdjustmentType	string	スケーリングルールの調整方法です。有効な値は次のとおりです： QuantityChangeInCapacity：指定された数の Elastic Compute Service (ECS) インスタンスをスケーリンググループに追加または削除します。 PercentChangeInCapacity：指定されたパーセンテージの ECS インスタンスをスケーリンググループに追加または削除します。 TotalCapacity：スケーリンググループ内の ECS インスタンスの数を指定された数に調整します。	QuantityChangeInCapacity
InitialMaxSize	integer	スケーリンググループに含めることができる ECS インスタンスの最大数です。このパラメーターを指定する場合は、PredictiveValueBehavior も指定する必要があります。	100
EstimatedInstanceWarmup	integer	インスタンスのウォームアップ期間です。ウォームアップ期間中、新しいインスタンスに対して一連の準備措置が取られます。ウォームアップ中のインスタンスのパフォーマンスメトリクスは、モニタリング範囲にはカウントされません。	300
ScaleOutEvaluationCount	integer	スケールアウト目的のアラームがアラートをトリガーする前に、しきい値条件を連続して満たす必要がある回数です。ターゲット追跡スケーリングルールを作成すると、アラームが自動的に作成され、そのルールに関連付けられます。	3
PredictiveScalingMode	string	予測スケーリングルールのモードです。有効な値は次のとおりです： PredictAndScale：予測を提供し、予測タスクを作成します。 PredictOnly：予測を提供しますが、予測タスクは作成しません。	PredictAndScale
MinAdjustmentMagnitude	integer	スケーリングされるインスタンスの最小数です。このパラメーターは、ScalingRuleType を SimpleScalingRule または StepScalingRule に設定し、AdjustmentType を PercentChangeInCapacity に設定した場合にのみ有効になります。	1
ScalingRuleAri	string	スケーリングルールの一意の識別子です。	ari:acs:ess:cn-hangzhou:140692647406**:scalingrule/asr-bp1dvirgwkoowxk7**
PredictiveTaskBufferTime	integer	予測タスクが実行される前のバッファ時間です。デフォルトでは、予測スケーリングルールに基づいて自動的に作成されるすべての予測タスクは、正時に実行されます。予測タスクが実行される前に、リソース準備のためのバッファ時間を指定できます。有効な値： 0～60。単位：分。	30
MinSize	integer	スケーリンググループに含める必要がある ECS インスタンスの最小数です。	1
ScalingGroupId	string	スケーリンググループの ID です。	asg-bp1ffogfdauy0jw0****
PredictiveValueBehavior	string	予測された最大値に対するアクションです。有効な値は次のとおりです： MaxOverridePredictiveValue：予測値が初期の最大容量より大きい場合、予測タスクの最大値として初期の最大容量を使用します。 PredictiveValueOverrideMax：予測値が初期の最大容量より大きい場合、予測タスクの最大値として予測値を使用します。 PredictiveValueOverrideMaxWithBuffer： PredictiveValueBuffer で指定された比率で予測値を増加させ、この比率で増加した予測値が初期の最大容量より大きい場合、増加した値を予測タスクの最大値として使用します。	MaxOverridePredictiveValue
TargetValue	number	メトリクスのターゲット値です。ScalingRuleType を TargetTrackingScalingRule または PredictiveScalingRule に設定した場合、Auto Scaling (ESS) は、スケーリンググループにインスタンスを追加または削除することで、メトリクス値をターゲット値に近づけるよう調整します。	0.125
Cooldown	integer	スケーリングルールのクールダウン期間です。このパラメーターは、ScalingRuleType を簡易スケーリングルールに設定した場合にのみ使用できます。有効な値： 0～86400。単位：秒。	20
MaxSize	integer	スケーリンググループに含めることができる ECS インスタンスの最大数です。	2
PredictiveValueBuffer	integer	PredictiveValueBehavior が PredictiveValueOverrideMaxWithBuffer に設定されている場合に、予測値を増加させる比率です。この比率で増加した予測値が初期の最大容量より大きい場合、増加した値を予測タスクの最大値として使用します。有効な値： 0～100。	50
ScalingRuleType	string	スケーリングルールのタイプです。有効な値は次のとおりです： SimpleScalingRule：簡易スケーリングルールです。簡易スケーリングルールが実行されると、Auto Scaling (ESS) は AdjustmentType と AdjustmentValue の値に基づいて、スケーリンググループ内の ECS インスタンスの数を調整します。 TargetTrackingScalingRule：ターゲット追跡スケーリングルールです。ターゲット追跡スケーリングルールが実行されると、Auto Scaling (ESS) は事前定義されたメトリクス (MetricName) に基づいてスケーリングする ECS インスタンスまたはエラスティックコンテナインスタンスの数を動的に計算し、メトリクス値が指定されたターゲット値 (TargetValue) に近付くよう維持しようとします。 StepScalingRule：ステップスケーリングルールです。ステップスケーリングルールが実行されると、Auto Scaling (ESS) は事前定義されたしきい値とメトリクス値に基づいて、インスタンスを段階的にスケーリングします。 PredictiveScalingRule：予測スケーリングルールです。予測スケーリングルールが実行されると、Auto Scaling (ESS) は機械学習技術に基づいて履歴モニタリングデータを分析し、メトリクスデータの傾向を予測します。また、Auto Scaling (ESS) はスケーリンググループの境界値を動的に調整するためのスケジュールされたタスクを作成します。	SimpleScalingRule
AdjustmentValue	integer	スケーリングルールに基づいてスケーリングされるインスタンスの数です。	1
ScaleInEvaluationCount	integer	スケールイン目的のアラームがアラートをトリガーする前に、しきい値条件を連続して満たす必要がある回数です。ターゲット追跡スケーリングルールを作成すると、アラームが自動的に作成され、そのルールに関連付けられます。	15
DisableScaleIn	boolean	スケールインが無効になっているかどうかを示します。このパラメーターは、ScalingRuleType を TargetTrackingScalingRule に設定した場合にのみ有効になります。有効な値は次のとおりです： true false	true
ScalingRuleName	string	スケーリングルールの名前です。	scalingrule****
ScalingRuleId	string	スケーリングルールの ID です。	asr-bp1dvirgwkoowxk7****
Alarms	array<object>	スケーリングルールに関連付けられているアラームです。このパラメーターの値は、ShowAlarmRules を true に設定した場合にのみ返されます。それ以外の場合は、null が返されます。
	array<object>	スケーリングルールに関連付けられているアラームです。このパラメーターの値は、ShowAlarmRules を true に設定した場合にのみ返されます。それ以外の場合は、null が返されます。
AlarmTaskId	string	スケーリングルールに関連付けられているアラームの ID です。	asg-bp18p2yfxow2dloq**_1f9458d1-70e1-4bee-8c7f-7a47695b**
ComparisonOperator	string	スケーリングルールに関連付けられているアラームのメトリクスの統計値としきい値の間の比較演算子です。比較演算子は、メトリクス値とメトリクスのしきい値が、どのような関係にある場合にアラート条件を満たすかを示します。メトリクス値がしきい値以上： >= メトリクス値がしきい値以下： <= メトリクス値がしきい値より大きい： > メトリクス値がしきい値より小さい： <	>=
MetricName	string	スケーリングルールに関連付けられているアラームのメトリクス名です。	CpuUtilization
EvaluationCount	integer	スケーリングルールに関連付けられているアラームがアラートをトリガーする前に、アラート条件を連続して満たす必要がある回数です。	3
AlarmTaskName	string	スケーリングルールに関連付けられているアラームの名前です。	alarmtask****
MetricType	string	スケーリングルールに関連付けられているアラームのメトリクスのタイプです。有効な値は次のとおりです： system：システムメトリクス custom：カスタムメトリクス	system
Threshold	number	スケーリングルールに関連付けられているアラームのしきい値です。	50
Statistics	string	スケーリングルールに関連付けられているアラームの統計方法です。有効な値は次のとおりです： Average Maximum Minimum	Average
Dimensions	array<object>	スケーリングルールに関連付けられているアラームのディメンションです。
	object	スケーリングルールに関連付けられているアラームのディメンションです。
DimensionKey	string	メトリクスに関連付けられているディメンションのキーです。有効な値は次のとおりです： ScalingGroupId：スケーリンググループの ID です。 userId：ユーザーアカウントの ID です。	scaling_group
DimensionValue	string	メトリクスに関連付けられているディメンションの値です。	asg-bp18p2yfxow2dloq****
Period	integer	ターゲット追跡スケーリングルールにおけるメトリクスデータの統計期間です。	60
StepAdjustments	array<object>	ステップスケーリングルールのステップ調整です。
	object	ステップスケーリングルールのステップ調整です。
MetricIntervalUpperBound	number	ステップ調整の上限です。有効な値： -9.999999E18～9.999999E18。	5.0
ScalingAdjustment	integer	ステップ調整でスケーリングされる ECS インスタンスの数です。	1
MetricIntervalLowerBound	number	ステップ調整の下限です。有効な値： -9.999999E18～9.999999E18。	1.0
AlarmDimensions	array<object>	ディメンションです。このパラメーターは、ターゲット追跡スケーリングルールに適用されます。事前定義されたメトリクスが追加のディメンションを必要とする場合に、このパラメーターを指定できます。たとえば、LoadBalancerRealServerAverageQps メトリクスを事前定義する場合、このパラメーターを使用して rulePool ディメンションを指定する必要があります。
	object
DimensionKey	string	メトリクスのディメンションキーです。	rulePool
DimensionValue	string	メトリクスのディメンション値です。	sgp-l1cbirz451yxu2****
MetricType	string	メトリクスのタイプです。有効な値は次のとおりです： system： CloudMonitor のシステムメトリクス。 custom： CloudMonitor にレポートされるカスタムメトリクス。 hybrid：ハイブリッドクラウド監視のメトリクス。	system
HybridMonitorNamespace	string	ハイブリッドクラウド監視の名前空間 ID です。ハイブリッドクラウド監視の名前空間の管理方法については、「名前空間の管理」をご参照ください。	aliyun-test
HybridMetrics	array<object>	ハイブリッドクラウド監視のメトリクスです。詳細については、「カスタムターゲット追跡スケーリングルールの作成」をご参照ください。
	array<object>
Id	string	メトリクス式におけるメトリクスの参照 ID です。	a
Expression	string	複数のハイブリッドクラウド監視メトリクスで構成されるメトリクス式です。スケーリングイベントをトリガーするために使用される結果を計算します。式は逆ポーランド記法 (RPN) 形式で記述され、`+, -, *, /` の演算子のみをサポートします。	(a+b)/2
MetricName	string	ハイブリッドクラウド監視メトリクスの名前です。	AliyunSmq_NumberOfMessagesVisible
Statistic	string	メトリクス値の統計方法です。有効な値は次のとおりです： Average：指定された間隔内のすべてのメトリクス値の平均値が計算されます。 Minimum：指定された間隔内のすべてのメトリクス値の最小値が計算されます。 Maximum：指定された間隔内のすべてのメトリクス値の最大値が計算されます。	Average
Dimensions	array<object>	メトリクスのディメンションです。このパラメーターは、監視対象のリソースを指定するために使用されます。
	object
DimensionKey	string	メトリクスディメンションのキーです。	queue
DimensionValue	string	メトリクスディメンションの値です。	testQueue

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "ScalingRules": [
    {
      "MetricName": "CpuUtilization",
      "AdjustmentType": "QuantityChangeInCapacity",
      "InitialMaxSize": 100,
      "EstimatedInstanceWarmup": 300,
      "ScaleOutEvaluationCount": 3,
      "PredictiveScalingMode": "PredictAndScale",
      "MinAdjustmentMagnitude": 1,
      "ScalingRuleAri": "ari:acs:ess:cn-hangzhou:140692647406****:scalingrule/asr-bp1dvirgwkoowxk7****",
      "PredictiveTaskBufferTime": 30,
      "MinSize": 1,
      "ScalingGroupId": "asg-bp1ffogfdauy0jw0****",
      "PredictiveValueBehavior": "MaxOverridePredictiveValue",
      "TargetValue": 0.125,
      "Cooldown": 20,
      "MaxSize": 2,
      "PredictiveValueBuffer": 50,
      "ScalingRuleType": "SimpleScalingRule",
      "AdjustmentValue": 1,
      "ScaleInEvaluationCount": 15,
      "DisableScaleIn": true,
      "ScalingRuleName": "scalingrule****",
      "ScalingRuleId": "asr-bp1dvirgwkoowxk7****",
      "Alarms": [
        {
          "AlarmTaskId": "asg-bp18p2yfxow2dloq****_1f9458d1-70e1-4bee-8c7f-7a47695b****",
          "ComparisonOperator": ">=",
          "MetricName": "CpuUtilization",
          "EvaluationCount": 3,
          "AlarmTaskName": "alarmtask****",
          "MetricType": "system",
          "Threshold": 50,
          "Statistics": "Average",
          "Dimensions": [
            {
              "DimensionKey": "scaling_group",
              "DimensionValue": "asg-bp18p2yfxow2dloq****"
            }
          ],
          "Period": 60
        }
      ],
      "StepAdjustments": [
        {
          "MetricIntervalUpperBound": 5,
          "ScalingAdjustment": 1,
          "MetricIntervalLowerBound": 1
        }
      ],
      "AlarmDimensions": [
        {
          "DimensionKey": "rulePool",
          "DimensionValue": "sgp-l1cbirz451yxu2****"
        }
      ],
      "MetricType": "system",
      "HybridMonitorNamespace": "aliyun-test",
      "HybridMetrics": [
        {
          "Id": "a",
          "Expression": "(a+b)/2",
          "MetricName": "AliyunSmq_NumberOfMessagesVisible",
          "Statistic": "Average",
          "Dimensions": [
            {
              "DimensionKey": "queue",
              "DimensionValue": "testQueue"
            }
          ]
        }
      ]
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。