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

イベントトリガータスクを作成します。バーストまたは予測不可能なトラフィックパターンを持つワークロードの場合、タスクを CloudMonitor メトリックに関連付けてスケーリンググループ内の ECS または ECI インスタンスの数を動的に調整し、インスタンスメトリックをリアル時間でモニターすることで、クラウドリソースをより適切に管理および保守できます。

操作説明

カスタム監視タイプ (MetricType=custom) のイベントトリガータスクを作成する場合は、まずカスタムメトリックデータを CloudMonitor にレポートする必要があります。詳細については、「カスタム監視イベントトリガータスク」を参照してください。
イベントトリガータスクを作成するときは、メトリック (MetricName) を指定し、ディメンション情報 (Dimensions.DimensionKey および Dimensions.DimensionValue) を設定して、スケーリンググループ内のメトリックデータの集約範囲を決定する必要があります。たとえば、user_id と scaling_group を指定して、特定のスケーリンググループ内の特定のユーザーに対するすべての ECS または ECI インスタンスのメトリックデータを集約できます。
- カスタム監視イベントトリガータスク (MetricType=custom) のメトリックは、カスタムメトリックに依存します。
- システム監視イベントトリガータスク (MetricType=system) でサポートされているメトリックの詳細については、「システム監視イベントトリガータスク」を参照してください。

説明

ディメンション情報では、user_id とスケーリンググループはシステムによって自動的に入力されますが、デバイスと state は手動で指定する必要があります。詳細については、Dimensions.DimensionKey パラメーターおよび Dimensions.DimensionValue パラメーターを参照してください。

今すぐお試しください

この 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:CreateAlarm

create

*スケーリンググループ。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	スケーリンググループのリージョン ID。	cn-hangzhou
Name	string	任意	イベントトリガータスクの名前。	TestAlarmTask
Description	string	任意	イベントトリガータスクの説明。	Test alarm task.
ScalingGroupId	string	必須	イベントトリガータスクに関連付けられているスケーリンググループの ID。	asg-bp18p2yfxow2dloq****
MetricName	string	任意	メトリックの名前。有効な値は、イベントトリガータスクの監視タイプによって異なります。イベントトリガータスクがカスタム監視タイプ (MetricType=custom) の場合、有効な値はカスタムメトリックです。イベントトリガータスクがシステム監視タイプ (MetricType=system) の場合、有効な値は次のとおりです。 CpuUtilization: ECS インスタンスの CPU 使用率 (%)。 ConcurrentConnections: ECS インスタンスへの同時接続数。 IntranetTx: ECS インスタンスのアウトバウンド内部ネットワークトラフィック (Kb/min)。 IntranetRx: ECS インスタンスのインバウンド内部ネットワークトラフィック (Kb/min)。 VpcInternetTx: ECS インスタンスのアウトバウンドインターネットトラフィック (Kb/min)。 VpcInternetRx: ECS インスタンスのインバウンドインターネットトラフィック (Kb/min)。 SystemDiskReadBps: システムクラウドディスクの読み取り BPS (Byte/s)。 SystemDiskWriteBps: システムクラウドディスクの書き込み BPS (Byte/s)。 SystemDiskReadOps: システムクラウドディスクの読み取り IOPS (operations/s)。 SystemDiskWriteOps: システムクラウドディスクの書き込み IOPS (operations/s)。 CpuUtilizationAgent: エージェントによってモニターされる CPU 使用率 (%)。 GpuUtilizationAgent: エージェントによってモニターされる GPU 使用率 (%)。 GpuMemoryFreeUtilizationAgent: エージェントによってモニターされるアイドル GPU メモリの割合 (%)。 GpuMemoryUtilizationAgent: エージェントによってモニターされる GPU メモリ使用率 (%)。 MemoryUtilization: エージェントによってモニターされるメモリ使用率 (%)。 LoadAverage: エージェントによってモニターされる平均システムロード。 TcpConnection: エージェントによってモニターされる TCP 接続の総数。 TcpConnection: エージェントによってモニターされる確立された TCP 接続数。 PackagesNetOut: エージェントによってモニターされる内部 NIC によって每秒送信されるパケット数 (packets/s)。 PackagesNetIn: エージェントによってモニターされる内部 NIC によって每秒受信されるパケット数 (packets/s)。 PackagesNetOut: エージェントによってモニターされるパブリック NIC によって每秒送信されるパケット数 (packets/s)。 PackagesNetIn: エージェントによってモニターされるパブリック NIC によって每秒受信されるパケット数 (packets/s)。 EciPodCpuUtilization: CPU 使用率 (%)。 EciPodMemoryUtilization: メモリ使用率 (%)。 LoadBalancerRealServerAverageQps: ALB サーバーグループ内のバックエンドサーバーあたりの平均 QPS (queries/s)。詳細については、「システム監視イベントトリガータスク」を参照してください。	CpuUtilization
MetricType	string	任意	メトリックのタイプ。有効な値: system: CloudMonitor のシステムメトリックを使用します。 custom: CloudMonitor にレポートされたカスタムメトリックを使用します。	system
Period	integer	任意	監視メトリクスデータを集約するためのエポック。単位: 秒。有効な値: 15 60 120 300 900 説明 15 秒の統計期間をサポートするのは、ECS インスタンスタイプのスケーリンググループのみです。デフォルト値: 300。	300
Statistics	string	任意	メトリックデータを集約するためのメソッド。有効な値: Average: 平均値。 Minimum: 最小値。 Maximum: 最大値。デフォルト値: Average。	Average
Threshold	number	任意	監視メトリクスのしきい値。監視しきい値の式が指定された回数満たされると、スケーリングルールの実行がトリガーされます。	80.0
ComparisonOperator	string	任意	集約されたメトリック値をしきい値と比較するために使用される比較演算子。この演算子は、しきい値が満たされる条件を指定します。有効な値: 説明 =: 集約されたメトリック値がしきい値以上。 <=: 集約されたメトリック値がしきい値以下。説明 : 集約されたメトリック値がしきい値より大きい。 <: 集約されたメトリック値がしきい値より小さい。デフォルト値: >=。	>=
EvaluationCount	integer	任意	スケーリングルールをトリガーするためにしきい値の式を満たす必要がある回数。たとえば、このパラメーターが 3 にセットされている場合、平均 CPU 使用率が 3 回連続して 80% 以上になると、スケーリングルールがトリガーされます。デフォルト値: 3。	3
GroupId	integer	任意	カスタムメトリックが属する CloudMonitor アプリケーショングループの ID。このパラメーターは、メトリクスタイプが custom の場合にのみ必須です。	4055401
Effective	string	任意	イベントトリガータスクの有効期間を指定します。デフォルトでは、タスクは常に効果があります。このパラメーターは cron 式のフォーマットに従います。デフォルトのフォーマットは `X X X X X ?` で、次のように説明されます。 X: フィールドのプレースホルダーで、秒、分、時、日、月のシーケンスで表します。X は特定の値、または論理的な意味を持つ特殊文字にすることができます。X の有効な値の詳細については、「cron 式」を参照してください。 ?: 値が指定されていないことを示します。説明このパラメーターの指定値は、デフォルトで協定世界時 (UTC)+8 時間ゾーンになります。cron 式の前に時間ゾーン情報 `TZ=+yy` を追加して時間ゾーンを指定できます。y は時間ゾーンオフセットを表します。たとえば、`TZ=+00 * * 1-2 * * ?` は、イベントトリガータスクが協定世界時 (UTC)+0 時間ゾーンで毎日 01:00 から 02:59 の間に効果があることを示します。例とその意味: `* * * * * ?`: 常に効果がある。 `* * 17-18 * * ?`: 協定世界時 (UTC)+8 時間ゾーンで毎日 17:00 から 18:59 の間に効果がある。 `TZ=+00 * * 1-2 * * ?`: 協定世界時 (UTC)+0 時間ゾーンで毎日 01:00 から 02:59 の間に効果がある。	TZ=+00 * * 1-2 * * ?
AlarmActions	array	任意	イベントトリガータスクに関連付けられているスケーリングルールの一意の識別子のリスト。
	string	任意	イベントトリガータスクに関連付けられているスケーリングルールの一意の識別子のリスト。	ari:acs:ess:cn-hangzhou:1406926**:scalingrule/asr-bp163l21e07uhn**
Dimensions	array<object>	任意	メトリックに関連付けられているディメンション情報。
	object	任意	メトリックに関連付けられているディメンション情報。
DimensionKey	string	任意	メトリックに関連付けられているディメンション情報のキー。有効な値は、イベントトリガータスクの監視タイプによって異なります。イベントトリガータスクがカスタム監視タイプ (MetricType=custom) の場合、有効な値に制限はなく、ユーザーが指定できます。イベントトリガータスクがシステム監視タイプ (MetricType=system) の場合、有効な値は次のとおりです。 user_id: アカウントの ID。 scaling_group: モニター対象のスケーリンググループ。 device: ネットワークインターフェースコントローラー (NIC) デバイスのタイプ。 state: TCP 接続の状態。 rulePool: QPS 監視メトリクスに指定された ALB サーバーグループのルールプール。	device
DimensionValue	string	任意	メトリックに関連付けられているディメンション情報の値。有効な値は Dimensions.DimensionKey によって異なります。 Dimensions.DimensionKey が custom の場合、つまりイベントトリガータスクがカスタム監視タイプ (MetricType=custom) の場合、有効な値に制限はなく、ユーザーが指定できます。 Dimensions.DimensionKey がシステム指定の有効値内にある場合、つまりイベントトリガータスクがシステム監視タイプ (MetricType=system) の場合、有効な値は次のとおりです。 user_id: システムによって自動的に入力されます。 scaling_group: システムによって自動的に入力されます。 device: eth0: クラシックネットワークインスタンスの場合、eth0 は内部 NIC を表します。VPC 接続インスタンスの場合、eth0 NIC のみが存在します。 eth1: クラシックネットワークインスタンスの場合、eth1 はパブリック NIC を表します。 state: TCP_TOTAL: TCP 接続の総数。 ESTABLISHED: 確立された TCP 接続数。 rulePool: ALB サーバーグループのルール ID。例: sgp-xxxxx。	eth0
Expressions	array<object>	任意	複数メトリックのアラートルールに関する情報。
	object	任意	複数メトリックのアラートルールに関する情報。
MetricName	string	任意	複数メトリックのアラートルールの監視メトリクスの名前。有効な値は、イベントトリガータスクの監視タイプによって異なります。イベントトリガータスクがカスタム監視タイプ (MetricType=custom) の場合、有効な値はカスタムメトリックです。イベントトリガータスクがシステム監視タイプ (MetricType=system) の場合、有効な値は次のとおりです。 CpuUtilization: ECS インスタンスの CPU 使用率 (%)。 ConcurrentConnections: ECS インスタンスへの同時接続数。 IntranetTx: ECS インスタンスのアウトバウンド内部ネットワークトラフィック (Kb/min)。 IntranetRx: ECS インスタンスのインバウンド内部ネットワークトラフィック (Kb/min)。 VpcInternetTx: ECS インスタンスのアウトバウンドインターネットトラフィック (Kb/min)。 VpcInternetRx: ECS インスタンスのインバウンドインターネットトラフィック (Kb/min)。 SystemDiskReadBps: システムクラウドディスクの読み取り BPS (Byte/s)。 SystemDiskWriteBps: システムクラウドディスクの書き込み BPS (Byte/s)。 SystemDiskReadOps: システムクラウドディスクの読み取り IOPS (operations/s)。 SystemDiskWriteOps: システムクラウドディスクの書き込み IOPS (operations/s)。 CpuUtilizationAgent: エージェントによってモニターされる CPU 使用率 (%)。 GpuUtilizationAgent: エージェントによってモニターされる GPU 使用率 (%)。 GpuMemoryFreeUtilizationAgent: エージェントによってモニターされるアイドル GPU メモリの割合 (%)。 GpuMemoryUtilizationAgent: エージェントによってモニターされる GPU メモリ使用率 (%)。 MemoryUtilization: エージェントによってモニターされるメモリ使用率 (%)。 LoadAverage: エージェントによってモニターされる平均システムロード。 TcpConnection: エージェントによってモニターされる TCP 接続の総数。 TcpConnection: エージェントによってモニターされる確立された TCP 接続数。 PackagesNetOut: エージェントによってモニターされる内部ネットワークインターフェースコントローラー (NIC) によって每秒送信されるパケット数 (packets/s)。 PackagesNetIn: エージェントによってモニターされる内部ネットワークインターフェースコントローラー (NIC) によって每秒受信されるパケット数 (packets/s)。 PackagesNetOut: エージェントによってモニターされるパブリックネットワークインターフェースコントローラー (NIC) によって每秒送信されるパケット数 (packets/s)。 PackagesNetIn: エージェントによってモニターされるパブリックネットワークインターフェースコントローラー (NIC) によって每秒受信されるパケット数 (packets/s)。 EciPodCpuUtilization: CPU 使用率 (%)。 EciPodMemoryUtilization: メモリ使用率 (%)。 LoadBalancerRealServerAverageQps: ALB サーバーグループ内のバックエンドサーバーあたりの平均 QPS (queries/s)。詳細については、「システム監視イベントトリガータスク」を参照してください。	CpuUtilization
ComparisonOperator	string	任意	複数メトリックのアラートルールで、集約されたメトリック値をしきい値と比較するために使用される比較演算子。この演算子は、しきい値が満たされる条件を指定します。有効な値: 説明 =: 集約されたメトリック値がしきい値以上。 <=: 集約されたメトリック値がしきい値以下。説明 : 集約されたメトリック値がしきい値より大きい。 <: 集約されたメトリック値がしきい値より小さい。デフォルト値: >=。	>=
Period	integer	任意	複数メトリックのアラートルールで監視メトリクスデータを集約するためのエポック。単位: 秒。有効な値: 15 60 120 300 900 説明 15 秒の統計期間をサポートするのは、ECS インスタンスタイプのスケーリンググループのみです。デフォルト値: 300。	900
Statistics	string	任意	複数メトリックのアラートルールでメトリックデータを集約するためのメソッド。有効な値: Average: 平均値。 Minimum: 最小値。 Maximum: 最大値。デフォルト値: Average。	Average
Threshold	number	任意	複数メトリックのアラートルールにおける監視メトリクスのしきい値。監視しきい値の式が指定された回数満たされると、スケーリングルールの実行がトリガーされます。	40.0
ExpressionsLogicOperator	string	任意	複数のメトリックアラート条件間の論理演算子。有効な値: `&&`: すべての監視メトリクスがアラート条件を満たした場合にのみアラートがトリガーされます。つまり、複数メトリックのアラートルール内のすべての式が `true` と評価された場合にのみアラートがトリガーされます。 `\|\|`: いずれかのメトリックがアラート条件を満たした場合にアラートがトリガーされます。デフォルト値: `&&`。	&&

レスポンスフィールド

フィールド	型	説明	例
	object	イベントトリガータスクを作成するための応答パラメーター。
AlarmTaskId	string	イベントトリガータスクの ID。	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

例

成功レスポンス

JSONJSON

{
  "AlarmTaskId": "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

エラーコード

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

変更履歴

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