DescribeAlarms - 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:DescribeAlarms

get

*ScalingGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	イベントトリガータスクが存在するリージョンの ID。	cn-qingdao
ScalingGroupId	string	任意	イベントトリガータスクに関連付けられたスケーリンググループの ID。	asg-bp18p2yfxow2dloq****
AlarmTaskId	string	任意	イベントトリガータスクの ID。	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
State	string	任意	イベントトリガータスクの状態。有効な値: ALARM: アラート条件が満たされています。 OK: アラート条件が満たされていません。 INSUFFICIENT_DATA: アラート条件が満たされているかどうかを判断するためのデータが不足しています。	OK
IsEnable	boolean	任意	イベントトリガータスクが有効かどうかを指定します。有効な値: true: 有効。 false: 無効。	true
MetricType	string	任意	モニタリングメトリックのタイプ。有効な値: system: CloudMonitor システムメトリックを使用します。 custom: CloudMonitor に報告されたカスタムメトリックを使用します。	system
MetricName	string	任意	モニタリングメトリックの名前。	CpuUtilization
PageSize	integer	任意	1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。	10
PageNumber	integer	任意	返すページ番号。最小値: 1。デフォルト値: 1。	1

レスポンスフィールド

フィールド	型	説明	例
	object	イベントトリガータスクの情報。
PageSize	integer	1 ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	871C7C53-34A4-45AA-8C14-4B72FA6A****
PageNumber	integer	現在のページ番号。	1
TotalCount	integer	イベントトリガータスクの総数。	2
AlarmList	object
Alarm	array<object>	イベントトリガータスクのリスト。
	array<object>	イベントトリガータスクのリスト。
AlarmTaskId	string	監視タスクのID。	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
MetricName	string	メトリクス名。取り得る値は次のとおりです。 CpuUtilization: (ECS) CPU 使用率 (%)。 ConcurrentConnections: (ECS) ECS への同時接続数。 IntranetTx: (ECS) 内部ネットワークのアウトバウンドトラフィック (Kb/分)。 IntranetRx: (ECS) 内部ネットワークのインバウンドトラフィック (Kb/分)。 VpcInternetTx: (ECS) インターネットのアウトバウンドトラフィック (Kb/分)。 VpcInternetRx: (ECS) インターネットのインバウンドトラフィック (Kb/分)。 SystemDiskReadBps: (ECS) システムディスクの読み取りスループット (Byte/s)。 SystemDiskWriteBps: (ECS) システムディスクの書き込みスループット (Byte/s)。 SystemDiskReadOps: (ECS) システムディスクの読み取り IOPS (操作/s)。 SystemDiskWriteOps: (ECS) システムディスクの書き込み IOPS (操作/s)。 CpuUtilizationAgent: (Agent) CPU 使用率 (%)。 GpuUtilizationAgent: (Agent) GPU 使用率 (%)。 GpuMemoryFreeUtilizationAgent: (Agent) GPU メモリの空き率 (%)。 GpuMemoryUtilizationAgent: (Agent) GPU メモリ使用量 (%)。 MemoryUtilization: (Agent) メモリ使用量 (%)。 LoadAverage: (Agent) システムのロードアベレージ。 TcpConnection: (Agent) TCP 接続の合計数。 TcpConnection: (Agent) 確立済みの TCP 接続数。 PackagesNetOut: (Agent) 内部ネットワークインターフェースカードが 1 秒あたりに送信するパケット数。 PackagesNetIn: (Agent) 内部ネットワークインターフェースカードが 1 秒あたりに受信するパケット数。 PackagesNetOut: (Agent) 外部ネットワークインターフェースカードが 1 秒あたりに送信するパケット数。 PackagesNetIn: (Agent) 外部ネットワークインターフェースカードが 1 秒あたりに受信するパケット数。 EciPodCpuUtilization: CPU 使用率 (%)。 EciPodMemoryUtilization: メモリ使用量 (%)。 LoadBalancerRealServerAverageQps: (ALB) サーバーグループ内の各サーバーあたりの 1 秒あたりのクエリ数 (QPS) (操作/s)。詳細については、「システムモニタリング監視イベントによる監視タスク」をご参照ください。	CpuUtilization
EvaluationCount	integer	スケーリングルールを実行するトリガー条件として、しきい値の式が満たされる必要がある回数。たとえば、3 回連続した統計評価において、平均 CPU 使用率が 80% 以上である必要があります。	3
State	string	監視タスクのステータス。可能な値は次のとおりです。 ALARM：アラート条件が満たされたため、アラートがトリガーされました。 OK：正常。アラート条件は満たされていません。 INSUFFICIENT_DATA：アラート条件が満たされているかどうかを判断するためのデータが不十分です。	ALARM
Period	integer	メトリックデータをモニタリングする統計期間（秒単位）。有効な値は次のとおりです。 15 60 120 300 900 説明 ECS タイプのスケーリンググループのみ、15 秒の統計期間をサポートしています。	300
ScalingGroupId	string	監視タスクに関連付けられたスケーリンググループの ID。	asg-bp18p2yfxow2dloq****
ComparisonOperator	string	メトリック統計値としきい値との比較演算子。この演算子は、メトリック統計値がしきい値を満たす条件を指定します。取り得る値は次のとおりです。メトリック統計値がしきい値以上である場合。値：>=。メトリック統計値がしきい値以下である場合。値：<=。メトリック統計値がしきい値より大きい場合。値：>。メトリック統計値がしきい値より小さい場合。値：<。	>=
Effective	string	監視タスクの有効期間。	* * * * * ?
Description	string	監視タスクの説明。	Test alarm task.
MetricType	string	メトリクスタイプ。有効な値は次のとおりです。 system: CloudMonitor システムメトリックを使用します。 custom: CloudMonitor にレポートされたカスタムメトリックを使用します。	system
Name	string	監視タスクの名前。	TestAlarmTask
Threshold	number	メトリックのしきい値。しきい値式が指定された回数満たされると、スケーリングルールがトリガーされます。	80.0
Enable	boolean	監視タスクが有効かどうかを示します。有効な値は次のとおりです。 true：有効。 false：無効。	true
Statistics	string	メトリックデータの統計値を計算するメソッド。次の値が可能です： Average：平均値。 Minimum：最小値。 Maximum：最大値。	Average
Dimensions	object
Dimension	array<object>	メトリックに関連付けられたディメンション情報。
	object	メトリックに関連付けられたディメンション情報。
DimensionKey	string	メトリックに関連付けられたディメンションのキー。次の値が可能です： user_id：お客様のアカウントID。 scaling_group：監視対象のスケーリンググループ。 device：ネットワークインターフェースカードデバイスのタイプ。 state：TCP 接続のステータス。	device
DimensionValue	string	メトリックに関連付けられたディメンションの情報値。有効な値はディメンションキーによって異なります。 `user_id`: システムによって自動的に塗りつぶされます。 `scaling_group`: システムによって自動的に塗りつぶされます。 `device` の可能な値: eth0: クラシックネットワークインスタンスの場合、eth0 は内部ネットワークインターフェースカードを表します。VPC タイプのインスタンスの場合、eth0 のみが存在します。 eth1: クラシックネットワークインスタンスの場合、eth1 は外部ネットワークインターフェースカードを表します。 `state` の可能な値: TCP_TOTAL: TCP 接続数の合計を示します。 ESTABLISHED: 確立済みの TCP 接続数を示します。	eth0
AlarmActions	object
AlarmAction	array	監視タスクに関連付けられたスケーリングルールのUUIDのリスト。
	string	監視タスクに関連付けられたスケーリングルールのUUIDのリスト。	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp163l21e07uh**
Expressions	object
Expression	array<object>	マルチメトリックアラートルールに関する情報。
	object	マルチメトリックアラートルールに関する情報。
MetricName	string	マルチメトリックアラートルールのメトリック名。有効な値は以下のとおりです。 CpuUtilization: (ECS) CPU 使用率 (%)。 ConcurrentConnections: (ECS) ECS への同時接続数。 IntranetTx: (ECS) 内部ネットワークのアウトバウンドトラフィック (Kb/分)。 IntranetRx: (ECS) 内部ネットワークのインバウンドトラフィック (Kb/分)。 VpcInternetTx: (ECS) インターネットのアウトバウンドトラフィック (Kb/分)。 VpcInternetRx: (ECS) インターネットのインバウンドトラフィック (Kb/分)。 SystemDiskReadBps: (ECS) システムディスクの読み取りスループット (Byte/s)。 SystemDiskWriteBps: (ECS) システムディスクの書き込みスループット (Byte/s)。 SystemDiskReadOps: (ECS) システムディスクの読み取り IOPS (1 秒あたりの操作回数)。 SystemDiskWriteOps: (ECS) システムディスクの書き込み IOPS (1 秒あたりの操作回数)。 CpuUtilizationAgent: (Agent) CPU 使用率 (%)。 GpuUtilizationAgent: (Agent) GPU 使用率 (%)。 GpuMemoryFreeUtilizationAgent: (Agent) GPU メモリの空きレート (%)。 GpuMemoryUtilizationAgent: (Agent) GPU メモリ使用量 (%)。 MemoryUtilization: (Agent) メモリ使用量 (%)。 LoadAverage: (Agent) システムの平均負荷。 TcpConnection: (Agent) TCP 接続の合計数。 TcpConnection: (Agent) 確立済みの TCP 接続数。 PackagesNetOut: (Agent) 内部ネットワークインターフェースカードが 1 秒あたりに送信するパケット数。 PackagesNetIn: (Agent) 内部ネットワークインターフェースカードが 1 秒あたりに受信するパケット数。 PackagesNetOut: (Agent) 外部ネットワークインターフェースカードが 1 秒あたりに送信するパケット数。 PackagesNetIn: (Agent) 外部ネットワークインターフェースカードが 1 秒あたりに受信するパケット数。 EciPodCpuUtilization: CPU 使用率 (%)。 EciPodMemoryUtilization: メモリ使用量 (%)。 LoadBalancerRealServerAverageQps: (ALB) サーバーグループ内の各サーバーあたりの 1 秒あたりクエリ数 (QPS)。詳細については、「システムモニタリング監視タスク」をご参照ください。	CpuUtilization
ComparisonOperator	string	マルチメトリックアラートルールで、メトリック統計値としきい値を比較するために使用される比較演算子です。この演算子は、ルールがトリガーされる条件を定義します。有効な値は次のとおりです。メトリック統計値がしきい値以上である場合。値：>= メトリック統計値がしきい値以下である場合。値：<= メトリック統計値がしきい値より大きい場合。値：> メトリック統計値がしきい値より小さい場合。値：< デフォルト値：>=	>=
Period	integer	マルチメトリックアラートルールにおけるモニタリングメトリックデータの統計期間（秒単位）。有効な値は次のとおりです。 15 60 120 300 900 説明 ECS タイプのスケーリンググループのみが、15 秒の統計期間をサポートします。	900
Statistics	string	マルチメトリックアラートルールでモニタリングメトリックデータの統計を計算するために使用されるメソッドです。有効な値は次のとおりです。 Average：平均値 Minimum：最小値 Maximum：最大値	Average
Threshold	number	複数メトリックのアラートルールにおけるメトリックのしきい値。しきい値式が指定された回数満たされると、スケーリングルールがトリガーされます。	40.0
ExpressionsLogicOperator	string	複数のメトリックに基づくアラート条件間の論理関係。可能な値は次のとおりです。 `&&`：すべてのメトリックがそれぞれのアラート条件を満たした場合にのみ、アラートがトリガーされます。つまり、マルチメトリックアラートルール内のすべての式が `true` と評価された場合にのみ、アラートがトリガーされます。 `\|\|`：いずれか1つのメトリックがそのアラート条件を満たした場合にアラートがトリガーされます。	&&
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
PromQL	string	ハイブリッドクラウド監視用の Prometheus クエリ言語 (PromQL) の文。	(avg(last_over_time(AliyunMnsnew_ActiveMessages{region='cn-hangzhou',userId='123456**',queue='testQueue'}[900s])) by (userId))/(avg(last_over_time(AliyunEss_RunningInstanceCount{instanceId='asg-bp1**'}[900s])) by (userId) != 0)

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "871C7C53-34A4-45AA-8C14-4B72FA6A****",
  "PageNumber": 1,
  "TotalCount": 2,
  "AlarmList": {
    "Alarm": [
      {
        "AlarmTaskId": "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
        "MetricName": "CpuUtilization",
        "EvaluationCount": 3,
        "State": "ALARM",
        "Period": 300,
        "ScalingGroupId": "asg-bp18p2yfxow2dloq****",
        "ComparisonOperator": ">=",
        "Effective": "* * * * * ?",
        "Description": "Test alarm task.",
        "MetricType": "system",
        "Name": "TestAlarmTask",
        "Threshold": 80,
        "Enable": true,
        "Statistics": "Average",
        "Dimensions": {
          "Dimension": [
            {
              "DimensionKey": "device",
              "DimensionValue": "eth0"
            }
          ]
        },
        "AlarmActions": {
          "AlarmAction": [
            "ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh****"
          ]
        },
        "Expressions": {
          "Expression": [
            {
              "MetricName": "CpuUtilization",
              "ComparisonOperator": ">=",
              "Period": 900,
              "Statistics": "Average",
              "Threshold": 40
            }
          ]
        },
        "ExpressionsLogicOperator": "&&",
        "HybridMonitorNamespace": "aliyun-test",
        "HybridMetrics": {
          "HybridMetric": [
            {
              "Id": "a",
              "Expression": "(a+b)/2",
              "MetricName": "AliyunSmq_NumberOfMessagesVisible",
              "Statistic": "Average",
              "Dimensions": {
                "Dimension": [
                  {
                    "DimensionKey": "queue",
                    "DimensionValue": "testQueue"
                  }
                ]
              }
            }
          ]
        },
        "PromQL": "(avg(last_over_time(AliyunMnsnew_ActiveMessages{region='cn-hangzhou',userId='123456****',queue='testQueue'}[900s])) by (userId))/(avg(last_over_time(AliyunEss_RunningInstanceCount{instanceId='asg-bp1****'}[900s])) by (userId) != 0)"
      }
    ]
  }
}

エラーコード

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

変更履歴

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