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

スケーリンググループ内のスケーリングルールを照会し、スケーリングルールに関する情報を返します。

今すぐお試しください

この 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	任意	ページングクエリの1ページあたりのエントリ数。最大値：50。デフォルト値：10。	50
ScalingGroupId	string	任意	スケーリンググループのID。	asg-bp1ffogfdauy0jw0****
ScalingRuleType	string	任意	スケーリングルールのタイプ。有効な値： SimpleScalingRule：シンプルスケーリング。調整方法（AdjustmentType）と調整値（AdjustmentValue）に基づいてECSインスタンスの数を調整します。 TargetTrackingScalingRule：ターゲットトラッキングスケーリングルール。事前定義された監視メトリック（MetricName）に基づいてスケールアウトまたはスケールインするECSインスタンスの数を動的に計算し、監視メトリック値をターゲット値（TargetValue）に近づけます。 StepScalingRule：ステップスケーリングルール。閾値とメトリック値に基づいてステップベースの拡張を提供します。 PredictiveScalingRule：予測スケーリングルール。機械学習を使用してスケーリンググループの過去の監視データを分析し、将来の監視メトリック値を予測し、スケーリンググループの境界を設定するスケジュールタスクの自動作成をサポートします。	SimpleScalingRule
ShowAlarmRules	boolean	任意	スケーリングルールに関連付けられたCloudMonitorイベントトリガータスクを返すかどうかを指定します。有効な値： true：スケーリングルールに関連付けられたCloudMonitorイベントトリガータスクを返します。 false：スケーリングルールに関連付けられたCloudMonitorイベントトリガータスクを返しません。デフォルト値：false。	false
ScalingRuleId	array	任意	照会するスケーリングルールNのID。Nの有効な値：1～10。	asr-bp1dvirgwkoowxk7****
	string	任意	照会するスケーリングルールNのID。Nの有効な値：1～10。	asr-bp1dvirgwkoowxk7****
ScalingRuleName	array	任意	照会するスケーリングルールNの名前。Nの有効な値：1～10。	scalingrule****
	string	任意	照会するスケーリングルールNの名前。Nの有効な値：1～10。	scalingrule****
ScalingRuleAri	array	任意	照会するスケーリングルールNの一意の識別子。Nの有効な値：1～10。	ari:acs:ess:cn-hangzhou:140692647406**:scalingrule/asr-bp1dvirgwkoowxk7**
	string	任意	照会するスケーリングルールNの一意の識別子。Nの有効な値：1～10。	ari:acs:ess:cn-hangzhou:140692647406**:scalingrule/asr-bp1dvirgwkoowxk7**

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	現在のページ番号。	1
PageSize	integer	1ページあたりのエントリ数。	50
TotalCount	integer	スケーリングルールの総数。	1
ScalingRules	object
ScalingRule	array<object>	スケーリングルール情報のコレクション。
	array<object>	スケーリングルール情報のコレクション。
MetricName	string	スケーリングルールの事前定義メトリック。ScalingRuleType を TargetTrackingScalingRule または PredictiveScalingRule に設定する場合、このパラメーターを指定する必要があります。 ScalingRuleType が TargetTrackingScalingRule に設定されている場合の有効な値： CpuUtilization：平均 CPU 使用率 ClassicInternetRx：クラシックネットワーク上の平均インバウンドインターネットトラフィック ClassicInternetTx：クラシックネットワーク上の平均アウトバウンドインターネットトラフィック VpcInternetRx：VPC 上の平均インバウンドインターネットトラフィック VpcInternetTx：VPC 上の平均アウトバウンドインターネットトラフィック IntranetRx：内部ネットワーク上の平均インバウンドトラフィック IntranetTx：内部ネットワーク上の平均アウトバウンドトラフィック ScalingRuleType が PredictiveScalingRule に設定されている場合の有効な値： CpuUtilization：平均 CPU 使用率 IntranetRx：内部ネットワーク上の平均インバウンドトラフィック IntranetTx：内部ネットワーク上の平均アウトバウンドトラフィック	CpuUtilization
AdjustmentType	string	スケーリングルールの調整方法。有効な値は次のとおりです。 QuantityChangeInCapacity：スケーリンググループに指定された数量の ECS インスタンスを追加するか、または指定された数量の ECS インスタンスを削除します。 PercentChangeInCapacity：スケーリンググループに指定されたパーセンテージ分の ECS インスタンスを追加するか、または指定されたパーセンテージ分の ECS インスタンスを削除します。 TotalCapacity：スケーリンググループ内の ECS インスタンスの数を指定された数量に調整します。	QuantityChangeInCapacity
InitialMaxSize	integer	スケーリンググループに追加できる ECS インスタンスの最大数。InitialMaxSize を指定する場合は、PredictiveValueBehavior も指定する必要があります。	100
EstimatedInstanceWarmup	integer	ECS インスタンスのウォームアップ期間。	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	目標値。	0.125
Cooldown	integer	スケーリングルールのクールダウン期間。このパラメーターは、ScalingRuleType を SimpleScalingRule に設定した場合にのみ使用可能です。有効値：0～86400。単位：秒。	20
MaxSize	integer	スケーリンググループに含まれる ECS インスタンスの最大数。	2
PredictiveValueBuffer	integer	PredictiveValueBehavior を PredictiveValueOverrideMaxWithBuffer に設定した場合に、予測値を増加させる比率。この比率で増加させた予測値が初期最大容量を超える場合は、増加後の値が予測タスクの最大値として使用されます。有効値：0～100。	50
ScalingRuleType	string	スケーリングルールのタイプ。有効な値は次のとおりです。 SimpleScalingRule: AdjustmentType および AdjustmentValue の値に基づいて ECS インスタンスの数を調整します。 TargetTrackingScalingRule: スケーリング対象となる ECS インスタンス数を計算し、事前定義されたメトリックの値を TargetValue の値に近づけて維持します。 StepScalingRule: 指定されたしきい値およびメトリックの値に基づいて、ステップ単位で ECS インスタンスをスケーリングします。 PredictiveScalingRule: 機械学習を使用してスケーリンググループの過去のモニタリングデータを分析し、メトリックの将来の値を予測します。さらに、Auto Scaling は定期タスクを作成して、スケーリンググループのインスタンス数の最小値および最大値を調整します。	SimpleScalingRule
AdjustmentValue	integer	スケーリングルールに基づいてスケーリングする必要のあるインスタンス数です。	1
ScaleInEvaluationCount	integer	スケールイン用に作成された監視タスクがしきい値条件を満たす必要がある連続回数。この回数に達するとアラートがトリガーされます。ターゲット追跡スケーリングルールが作成されると、監視タスクが自動的に作成され、そのターゲット追跡スケーリングルールに関連付けられます。	15
DisableScaleIn	boolean	スケールインを無効化するかどうかを示します。このパラメーターは、ScalingRuleType を TargetTrackingScalingRule に設定した場合にのみ有効です。有効値： true false	true
ScalingRuleName	string	スケーリングルールの名前。	scalingrule****
ScalingRuleId	string	スケーリングルールのID。	asr-bp1dvirgwkoowxk7****
Alarms	object
Alarm	array<object>	スケーリングルールに関連付けられた監視タスク。このパラメーターは、ShowAlarmRules を true に設定した場合にのみ返されます。それ以外の場合は、空のリストが返されます。
	array<object>	スケーリングルールに関連付けられたCloudMonitor 監視タスク。CloudMonitor 監視タスクは、ShowAlarmRulesパラメーターがtrueに設定されている場合にのみ返されます。それ以外の場合は、空のリストが返されます。
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	object
Dimension	array<object>	スケーリングルールに関連付けられた監視タスクのディメンション。
	object	スケーリングルールに関連付けられた監視タスクのディメンション情報。
DimensionKey	string	スケーリングルールに関連付けられた監視タスクのディメンションキー。有効な値は次のとおりです。 scaling_group: スケーリンググループの ID userId: Alibaba Cloud アカウント (root ユーザー) の ID	scaling_group
DimensionValue	string	スケーリングルールに関連付けられた監視タスクのディメンション値。	asg-bp18p2yfxow2dloq****
Period	integer	ターゲットトラッキングルールでメトリックデータを収集するためのエポック。	60
StepAdjustments	object
StepAdjustment	array<object>	ステップスケーリングルールのステップ調整内容。
	object	ステップ調整で指定された上限値。有効値：-9.999999E18～9.999999E18。
MetricIntervalUpperBound	number	ステップ調整でスケーリングされる ECS インスタンスの数。	5.0
ScalingAdjustment	integer	ステップ調整で指定される下限値。有効値の範囲は -9.999999E18 ～ 9.999999E18 です。	1
MetricIntervalLowerBound	number	監査	1.0
AlarmDimensions	object
AlarmDimension	array<object>	メトリックに関連付けられたディメンション情報。これはターゲットトラッキングルールに適用され、メトリックが追加のディメンション情報を必要とする場合に設定されます。たとえば、`LoadBalancerRealServerAverageQps` メトリックには `rulePool` ディメンションが必要です。
	object	メトリックに関連付けられたディメンション情報です。これはターゲットトラッキングルールに適用され、メトリックが追加のディメンション情報を必要とする場合に設定されます。たとえば、`LoadBalancerRealServerAverageQps` メトリックには `rulePool` ディメンションが必要です。
DimensionKey	string	メトリックに関連付けられたディメンションのキーです。	rulePool
DimensionValue	string	メトリックに関連付けられたディメンションの値です。	sgp-l1cbirz451yxu2****
MetricType	string	メトリックのタイプ。有効な値は次のとおりです。 system: CloudMonitor システムメトリックを使用します。 custom: CloudMonitor に報告されたカスタムメトリックを使用します。 hybrid: ハイブリッドクラウド監視メトリックを使用します。	system
HybridMonitorNamespace	string	ハイブリッドクラウド監視メトリックリポジトリのIDです。メトリックリポジトリの管理方法については、「メトリックリポジトリの管理」をご参照ください。	aliyun-test
HybridMetrics	object
HybridMetric	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	object
Dimension	array<object>	メトリックのディメンション。メトリックによってモニターされるリソースを指定するために使用されます。
	object
DimensionKey	string	メトリックのディメンションキー。	queue
DimensionValue	string	メトリックのディメンション値。	testQueue

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "ScalingRules": {
    "ScalingRule": [
      {
        "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": {
          "Alarm": [
            {
              "AlarmTaskId": "asg-bp18p2yfxow2dloq****_1f9458d1-70e1-4bee-8c7f-7a47695b****",
              "ComparisonOperator": ">=",
              "MetricName": "CpuUtilization",
              "EvaluationCount": 3,
              "AlarmTaskName": "alarmtask****",
              "MetricType": "system",
              "Threshold": 50,
              "Statistics": "Average",
              "Dimensions": {
                "Dimension": [
                  {
                    "DimensionKey": "scaling_group",
                    "DimensionValue": "asg-bp18p2yfxow2dloq****"
                  }
                ]
              },
              "Period": 60
            }
          ]
        },
        "StepAdjustments": {
          "StepAdjustment": [
            {
              "MetricIntervalUpperBound": 5,
              "ScalingAdjustment": 1,
              "MetricIntervalLowerBound": 1
            }
          ]
        },
        "AlarmDimensions": {
          "AlarmDimension": [
            {
              "DimensionKey": "rulePool",
              "DimensionValue": "sgp-l1cbirz451yxu2****"
            }
          ]
        },
        "MetricType": "system",
        "HybridMonitorNamespace": "aliyun-test",
        "HybridMetrics": {
          "HybridMetric": [
            {
              "Id": "a",
              "Expression": "(a+b)/2",
              "MetricName": "AliyunSmq_NumberOfMessagesVisible",
              "Statistic": "Average",
              "Dimensions": {
                "Dimension": [
                  {
                    "DimensionKey": "queue",
                    "DimensionValue": "testQueue"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

エラーコード

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

変更履歴

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