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

監視タスクを照会します。DescribeAlarms 操作を呼び出すことで、監視タスクの構成を確認し、モニタリングデータの変化をリアルタイムで把握できます。これにより、システムリソースに関する問題を早期にトラブルシューティングし、システムの安定性と信頼性を確保できます。

今すぐお試しください

この 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：データが不十分なため、Auto Scaling はアラート条件が満たされているかどうかを判断できません。	OK
IsEnable	boolean	任意	イベントトリガー型タスクを有効にするかどうかを指定します。有効値は次のとおりです。 true：イベントトリガー型タスクを有効にします。 false：イベントトリガー型タスクを無効にします。	true
MetricType	string	任意	メトリクスタイプです。有効値は次のとおりです。 system：CloudMonitor のシステムメトリック custom：CloudMonitor にレポートされるカスタムメトリック hybrid：ハイブリッドクラウド監視のメトリック	true
MetricName	string	任意	メトリック名です。	CpuUtilization
PageSize	integer	任意	1 ページあたりのエントリ数です。有効値：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	array<object>	イベントトリガー型の監視タスク。
	array<object>	イベントトリガー型の監視タスク。
AlarmTaskId	string	イベントトリガー型タスクの ID です。	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
MetricName	string	メトリック名です。有効値は次のとおりです。 CpuUtilization：ECS インスタンスの CPU 使用率。単位：%。 ConcurrentConnections：ECS インスタンスへの現在の接続数。 IntranetTx：内部ネットワークのアウトバウンドトラフィック。単位：KB/分。 IntranetRx：内部ネットワークのインバウンドトラフィック。単位：KB/分。 VpcInternetTx：VPC のアウトバウンドトラフィック。単位：KB/分。 VpcInternetRx：VPC のインバウンドトラフィック。単位：KB/分。 SystemDiskReadBps：システムディスクから 1 秒間に読み取られるバイト数。 SystemDiskWriteBps：システムディスクに 1 秒間に書き込まれるバイト数。 SystemDiskReadOps：システムディスクの読み取り IOPS。単位：回/秒。 SystemDiskWriteOps：システムディスクの書き込み IOPS。単位：回/秒。 CpuUtilizationAgent：CPU 使用率。単位：%。 GpuUtilizationAgent：GPU 使用率。単位：%。 GpuMemoryFreeUtilizationAgent：アイドル GPU メモリ使用率。単位：%。 GpuMemoryUtilizationAgent：GPU メモリ使用量。単位：%。 MemoryUtilization：メモリ使用量。単位：%。 LoadAverage：システムの平均負荷。 TcpConnection：TCP 接続の総数。 TcpConnection：確立された TCP 接続の数。 PackagesNetOut：内部 NIC によって送信されたパケット数。単位：回/秒。 PackagesNetIn：内部 NIC によって受信されたパケット数。単位：回/秒。 PackagesNetOut：パブリック NIC によって送信されたパケット数。単位：回/秒。 PackagesNetIn：パブリック NIC によって受信されたパケット数。単位：回/秒。 EciPodCpuUtilization：CPU 使用率。単位：%。 EciPodMemoryUtilization：メモリ使用量。単位：%。 LoadBalancerRealServerAverageQps：インスタンスの秒間クエリ数 (QPS)。詳細については、「システムモニタリングタイプの監視タスク」をご参照ください。	CpuUtilization
EvaluationCount	integer	しきい値に達した回数が連続して何回発生した場合にスケーリングルールを実行するかを示します。たとえば、このパラメーターを 3 に設定すると、平均 CPU 使用率が 80% 以上に達する状態が 3 回連続して発生した場合にスケーリングルールが実行されます。	3
State	string	監視タスクのステータスです。有効値は次のとおりです。 ALARM：アラート条件が満たされ、アラートがトリガーされました。 OK：アラート条件が満たされていません。 INSUFFICIENT_DATA：データが不十分なため、Auto Scaling はアラート条件が満たされているかどうかを判断できません。	ALARM
Period	integer	メトリックデータの統計期間です。単位：秒。有効値： 15 60 120 300 900 説明このパラメーターの値を 15 秒に設定できるのは、ECS タイプのスケーリンググループの場合のみです。	300
ScalingGroupId	string	監視タスクに関連付けられているスケーリンググループの ID です。	asg-bp18p2yfxow2dloq****
ComparisonOperator	string	メトリック値とメトリックのしきい値を比較するために使用される演算子です。メトリック値がしきい値以上の場合の有効値：>= メトリック値がしきい値以下の場合の有効値：<= メトリック値がしきい値より大きい場合の有効値：> メトリック値がしきい値より小さい場合の有効値：<	>=
Effective	string	監視タスクの有効期間です。	Test
Description	string	イベントトリガー型タスクの説明です。	Test alarm task.
MetricType	string	メトリックのタイプです。有効値は次のとおりです。 system：CloudMonitor のシステムメトリック custom：CloudMonitor にレポートされるカスタムメトリック hybrid：ハイブリッドクラウド監視のメトリック	system
Name	string	イベントトリガー型タスクの名前です。	TestAlarmTask
Threshold	number	メトリックのしきい値です。統計期間内に指定された回数だけしきい値に達した場合、スケーリングルールが実行されます。	80.0
Enable	boolean	監視タスク機能が有効になっているかどうかを示します。有効値： true false	true
Statistics	string	メトリックデータを集計する方法です。有効値： Average：平均値 Minimum：最小値 Maximum：最大値	Average
Dimensions	array<object>	メトリックのディメンションです。
	object	ディメンションの詳細です。
DimensionKey	string	メトリックのディメンションキーです。有効値： user_id：ご利用の Alibaba Cloud アカウントの ID scaling_group：監視タスクによってモニタリングされるスケーリンググループ device：NIC タイプ state：TCP 接続のステータス	device
DimensionValue	string	メトリックのディメンション値です。DimensionValue の値は DimensionKey の値に基づいて異なります。 DimensionKey を `user_id` に設定した場合、システムが DimensionValue の値を指定します。 DimensionKey を `scaling_group` に設定した場合、システムが DimensionValue の値を指定します。 DimensionKey を `device` に設定した場合、DimensionValue を eth0 または eth1 に設定できます。クラシックネットワークタイプのインスタンスの場合、eth0 は内部 NIC を示します。VPC 内の各インスタンスには eth0 NIC が 1 つしか存在しません。クラシックネットワークタイプのインスタンスの場合、eth1 はパブリック NIC を示します。 DimensionKey を `state` に設定した場合、DimensionValue を TCP_TOTAL または ESTABLISHED に設定できます。 TCP_TOTAL は TCP 接続の総数を示します。 ESTABLISHED は確立された TCP 接続の数を示します。	eth0
AlarmActions	array	監視タスクに関連付けられているスケーリングルールの一意な識別子です。
	string	監視タスクに関連付けられているスケーリングルールの一意な識別子です。	ari:acs:ess:cn-hangzhou:1406926474**:scalingrule/asr-bp163l21e07uh**
Expressions	array<object>	マルチメトリックアラートルールのアラート条件です。
	object	マルチメトリックアラートルールで指定された式です。
MetricName	string	マルチメトリックアラートルールで指定されたメトリックの名前です。有効値： CpuUtilization：ECS インスタンスの CPU 使用率。単位：%。 ConcurrentConnections：ECS インスタンスへの現在の接続数。 IntranetTx：内部ネットワークのアウトバウンドトラフィック。単位：KB/分。 IntranetRx：内部ネットワークのインバウンドトラフィック。単位：KB/分。 VpcInternetTx：VPC のアウトバウンドトラフィック。単位：KB/分。 VpcInternetRx：VPC のインバウンドトラフィック。単位：KB/分。 SystemDiskReadBps：システムディスクから 1 秒間に読み取られるバイト数。 SystemDiskWriteBps：システムディスクに 1 秒間に書き込まれるバイト数。 SystemDiskReadOps：システムディスクの読み取り IOPS。単位：回/秒。 SystemDiskWriteOps：システムディスクの書き込み IOPS。単位：回/秒。 CpuUtilizationAgent：CPU 使用率。単位：%。 GpuUtilizationAgent：GPU 使用率。単位：%。 GpuMemoryFreeUtilizationAgent：アイドル GPU メモリ使用率。単位：%。 GpuMemoryUtilizationAgent：GPU メモリ使用量。単位：%。 MemoryUtilization：メモリ使用量。単位：%。 LoadAverage：システムの平均負荷。 TcpConnection：TCP 接続の総数。 TcpConnection：確立された TCP 接続の数。 PackagesNetOut：内部 NIC によって送信されたパケット数。単位：回/秒。 PackagesNetIn：内部 NIC によって受信されたパケット数。単位：回/秒。 PackagesNetOut：パブリック NIC によって送信されたパケット数。単位：回/秒。 PackagesNetIn：パブリック NIC によって受信されたパケット数。単位：回/秒。 EciPodCpuUtilization：CPU 使用率。単位：%。 EciPodMemoryUtilization：メモリ使用量。単位：%。 LoadBalancerRealServerAverageQps：インスタンスの QPS。詳細については、「システムモニタリングタイプの監視タスク」をご参照ください。	CpuUtilization
ComparisonOperator	string	メトリック値としきい値を比較するために使用される演算子です。メトリック値がしきい値以上の場合の有効値：>= メトリック値がしきい値以下の場合の有効値：<= メトリック値がしきい値より大きい場合の有効値：> メトリック値がしきい値より小さい場合の有効値：<	>=
Period	integer	マルチメトリックアラートルールにおけるメトリックデータの統計期間です。単位：秒。有効値： 15 60 120 300 900 説明スケーリンググループが ECS タイプであり、そのスケーリンググループに関連付けられた監視タスクが CloudMonitor メトリックをモニタリングしている場合、Period を 15 に設定できます。通常、CloudMonitor メトリックの名前には Agent が含まれています。	900
Statistics	string	マルチメトリックアラートルールにおけるメトリックの統計を集計する方法です。有効値： Average：平均値 Minimum：最小値 Maximum：最大値	Average
Threshold	number	メトリック値のしきい値です。指定された期間内に指定された回数だけしきい値に達した場合、スケーリングルールが実行されます。	40.0
ExpressionsLogicOperator	string	マルチメトリックアラートルールで指定されたトリガー条件間の関係です。有効値： `&&`：マルチメトリックアラートルール内のすべてのメトリックがそれぞれのトリガー条件を満たした場合にのみアラートがトリガーされます。この場合、マルチメトリックアラートルールで指定されたすべてのトリガー条件の結果が `true` である場合にのみアラートがトリガーされます。 `\|\|`：マルチメトリックアラートルール内のいずれか 1 つのメトリックがそのトリガー条件を満たした場合にアラートがトリガーされます。	&&
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
PromQL	string	ハイブリッドクラウド監視の 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": [
    {
      "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": [
        {
          "DimensionKey": "device",
          "DimensionValue": "eth0"
        }
      ],
      "AlarmActions": [
        "ari:acs:ess:cn-hangzhou:1406926474****:scalingrule/asr-bp163l21e07uh****"
      ],
      "Expressions": [
        {
          "MetricName": "CpuUtilization",
          "ComparisonOperator": ">=",
          "Period": 900,
          "Statistics": "Average",
          "Threshold": 40
        }
      ],
      "ExpressionsLogicOperator": "&&",
      "HybridMonitorNamespace": "aliyun-test",
      "HybridMetrics": [
        {
          "Id": "a",
          "Expression": "(a+b)/2",
          "MetricName": "AliyunSmq_NumberOfMessagesVisible",
          "Statistic": "Average",
          "Dimensions": [
            {
              "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)"
    }
  ]
}

エラーコード

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

変更履歴

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