API 標準および多言語対応の SDK
本製品 (Ess/2022-02-22) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
スケーリンググループ
|
API |
タイトル |
説明 |
| CreateScalingGroup | CreateScalingGroup | `CreateScalingGroup` API を呼び出してスケーリンググループを作成します。このグループは、ビジネス要件とスケーリングポリシーに基づいて、指定されたタイプのインスタンスをスケールインまたはスケールアウトすることで、計算能力 (インスタンス数) を自動的に調整します。 |
| ModifyScalingGroup | ModifyScalingGroup | スケーリンググループを変更します。変化するビジネス要件を満たすために、ポリシー に基づいて特定のタイプ の インスタンス を自動的に追加または削除する機能を有効化したい場合は、スケーリンググループ を変更することで、コンピューティングパワー を簡単に調整できます。コンピューティングパワー とは、コンピューティング能力を提供する インスタンス を指します。スケーリンググループ がビジネス要件を満たせない場合、ModifyScalingGroup API を呼び出して、最大インスタンス数、最小インスタンス数、期待インスタンス数などの スケーリンググループ 属性を変更できます。これにより、スケーリンググループ を繰り返し作成および設定する必要がなくなり、多くの時間と リソースコスト を節約できます。 |
| EnableScalingGroup | EnableScalingGroup | スケーリンググループを有効にします。スケーリンググループが「無効」状態であり、起動テンプレートやスケーリング設定などのインスタンス構成ソースが含まれている場合、EnableScalingGroup API を呼び出すことでスケーリンググループを有効にできます。この操作により、Auto Scaling はビジネス要件に基づいて、スケーリンググループ内のコンピューティング能力 (インスタンス数) を動的に調整できます。 |
| DisableScalingGroup | DisableScalingGroup | スケーリンググループを無効化します。有効なスケーリンググループが一時的に不要な場合は、DisableScalingGroup API を呼び出して無効化できます。 |
| SetGroupDeletionProtection | SetGroupDeletionProtection | スケーリンググループの削除保護を設定します。スケーリンググループで削除保護を有効にすると、そのグループは削除できなくなります。削除保護を無効にすると、グループを直接削除できます。SetGroupDeletionProtection オペレーションを呼び出して、削除保護を有効または無効にできます。 |
| DeleteScalingGroup | DeleteScalingGroup | スケーリンググループを削除します。変化するビジネス要件を満たすために、ポリシーに基づいて特定タイプのインスタンスの自動的な追加または削除を有効にしたい場合、スケーリンググループを作成してコンピューティング能力を容易に管理できます。コンピューティング能力とは、コンピューティング機能を提供するインスタンスを指します。スケーリンググループが不要になった場合、DeleteScalingGroup API を呼び出してスケーリンググループを削除し、スケーリンググループのクォータを解放できます。 |
| DescribeScalingGroups | DescribeScalingGroups | スケーリンググループの基本情報、インスタンス、スケーリング設定などの情報をクエリします。 |
| DescribeScalingGroupDetail | DescribeScalingGroupDetail | スケーリンググループをクエリします。DescribeScalingGroupDetail 操作を呼び出すことで、スケーリンググループの基本情報、インスタンス、およびスケーリング設定を取得できます。Elastic Container Instance タイプのスケーリンググループで OutputFormat を YAML に設定した場合、出力は YAML フォーマットの Kubernetes Deployment ファイルになります。 |
| DescribeScalingInstances | スケーリンググループ内の ECS インスタンスを照会します | スケーリンググループ ID を指定して、スケーリンググループ内の ECS インスタンスのリストと詳細を照会します。実行中のスポットインスタンスの合計数、ECS インスタンスの合計数、ECS インスタンスのウォームアップ状態、現在のスケーリンググループにおけるライフサイクル状態などが含まれます。ヘルスチェックステータス、ライフサイクル状態、または作成タイプで ECS インスタンスをフィルターすることもできます。 |
| DescribeScalingActivities | DescribeScalingActivities | スケーリングアクティビティを照会します。 DescribeScalingActivities API を呼び出して、スケジュールされたタスク、イベントトリガーのタスク、またはスケーリングルールの手動実行によってトリガーされたスケーリングアクティビティの結果を照会できます。たとえば、スケーリングアクティビティのステータスと原因を照会できます。また、スケーリングアクティビティの完了後のインスタンス総数も照会できます。 |
| DescribeScalingActivityDetail | DescribeScalingActivityDetail | スケーリングアクティビティの詳細を照会します。 スケーリングアクティビティは、その ID を使用して照会できます。 スケーリングアクティビティの詳細には、スケーリングアクティビティのステータス、エラーコード、エラーメッセージが含まれます。 エラーメッセージに基づいて、効率的に問題をトラブルシューティングし、サービスのパフォーマンスを分析できます。 |
| AttachLoadBalancers | AttachLoadBalancers | ロードバランサーをスケーリンググループにアタッチします。Auto Scaling は、スケーリンググループへのロードバランサーのアタッチに対応しています。ロードバランサーは、スケーリンググループ内のインスタンスにアクセストラフィックを分散させ、スケーリンググループのサービスパフォーマンスを効果的に向上させます。AttachLoadBalancers API を呼び出して、1つ以上のロードバランサーをスケーリンググループにアタッチできます。 |
| DetachLoadBalancers | DetachLoadBalancers | スケーリンググループから Classic Load Balancer (CLB、旧称 Server Load Balancer (SLB)) インスタンスをデタッチします。現在の CLB インスタンスがビジネス要件を満たさなくなった場合、DetachLoadBalancers API を呼び出して、スケーリンググループからインスタンスをデタッチできます。この API を呼び出す際、`ScalingGroupId`、`LoadBalancers`、および `ForceDetach` を使用して、デタッチする 1 つ以上の CLB インスタンスを指定できます。また、この API を非同期で呼び出すかどうか、およびバックエンドサーバーとして機能する Elastic Compute Service (ECS) インスタンスを CLB インスタンスのバックエンドサーバーグループから削除するかどうかを指定できます。この API を呼び出して、スケーリンググループからデタッチできるのは CLB インスタンスのみです。 |
| AttachDBInstances | AttachDBInstances | 1 つ以上の ApsaraDB RDS インスタンスをスケーリンググループにアタッチします。 |
| DetachDBInstances | DetachDBInstances | スケーリンググループから 1 つ以上の ApsaraDB RDS インスタンスをデタッチします。 スケーリンググループにアタッチされている ApsaraDB RDS インスタンスの数を減らす場合は、DetachDBInstances API を呼び出すことができます。 この操作により、スケーリンググループから ApsaraDB RDS インスタンスをデタッチし、リソース管理と割り当ての俊敏性と効率を大幅に向上させます。 |
| SuspendProcesses | SuspendProcesses | スケーリングプロセスを一時停止します。この操作では、特定のスケーリンググループ内の個別のスケーリングプロセスを選択的に一時停止できます。これにより、他のタスクを実行したり、スケーリング操作をより細かく管理したりできます。 |
| ResumeProcesses | ResumeProcesses | スケーリンググループで中断されたプロセスを再開します。この操作により、Auto Scaling は事前に定義されたルールとロジックに従ってこれらのプロセスの実行を続行します。例えば、スケーリンググループでヘルスチェックプロセスを再開すると、Auto Scaling は非正常と判断されたインスタンスを自動的に検出し、スケーリンググループから削除します。 |
| AttachVServerGroups | AttachVServerGroups | vServer グループをスケーリンググループにアタッチします。Classic Load Balancer (CLB) インスタンスがスケーリンググループにアタッチされると、スケーリンググループ内のインスタンスは自動的に CLB インスタンスのバックエンドサーバーとして追加されます。これらのサーバーは、CLB インスタンスから転送されるリクエストを処理し、受信トラフィックの処理を効率化します。さまざまなアクセスリクエストを個別のバックエンドサーバーに振り分けたり、ドメイン名や URL に基づいてリクエストを分散したりする場合は、AttachVServerGroups オペレーションを呼び出すことができます。このオペレーションにより、複数の vServer グループを追加でき、ルーティング設定に合わせたさまざまなバックエンドサーバー構成を効率的に管理できます。 |
| DetachVServerGroups | DetachVServerGroups | スケーリンググループから VServer グループをデタッチします。Auto Scaling は、ロードバランサーをスケーリンググループにアタッチして、サービスのパフォーマンスを向上させることができます。スケーリンググループに現在アタッチされているロードバランサーが、スケーリンググループ内のインスタンスにアクセス トラフィックを分散する必要がなくなった場合、DetachVServerGroups API を呼び出して、このロードバランサーの 1 つ以上の VServer グループをスケーリンググループからデタッチできます。 |
| AttachAlbServerGroups | AttachAlbServerGroups | Application Load Balancer (ALB) のサーバーグループをスケーリンググループにアタッチします。ビジネスのワークロードの変化に応じてインスタンス数をシームレスに調整する場合や、アプリケーションの継続的な可用性を維持する場合は、 AttachAlbServerGroups API を呼び出します。ALB のサーバーグループをスケーリンググループにアタッチすることで、Auto Scaling (ESS) はビジネス要件に合わせてコンピューティングキャパシティを自動的に調整できます。さらに、現在のワークロードパターンに基づいて受信リクエストを動的に割り当てることで、トラフィックルーティングを最適化し、アプリケーションの安定性とパフォーマンスを大幅に向上させます。 |
| DetachAlbServerGroups | DetachAlbServerGroups | スケーリンググループから Application Load Balancer (ALB) サーバーグループをデタッチします。DetachAlbServerGroups API を呼び出す際、スケーリンググループ ID、ALB サーバーグループ ID、および対象の ALB サーバーグループ内の Elastic Compute Service (ECS) インスタンスが使用するポートを指定して、スケーリンググループから 1 つ以上の ALB サーバーグループをデタッチできます。 |
| AttachServerGroups | AttachServerGroups | サーバーグループをスケーリンググループにアタッチします。ビジネスワークロードの変更に応じてインスタンス数をシームレスに調整したり、アプリケーションの可用性を維持したりするには、AttachServerGroups API を呼び出します。この操作では、Application Load Balancer (ALB)、Network Load Balancer (NLB)、または Gateway Load Balancer (GWLB) のサーバーグループをスケーリンググループにアタッチすることにより、Auto Scaling がビジネスニーズに合わせてコンピューティング能力を自動的に調整できるようになります。さらに、現在のワークロードパターンに基づいて着信リクエストを動的に割り当てることでトラフィックルーティングを最適化し、アプリケーションの安定性とパフォーマンスを大幅に向上させます。 |
| DetachServerGroups | DetachServerGroups | スケーリンググループから 1 つ以上の SLB サーバーグループを削除します。サポートされているサーバーグループのタイプには、Application Load Balancer (ALB)、Network Load Balancer (NLB)、Gateway Load Balancer (GWLB) があり、SLB ポリシーを動的に調整し、システムの高可用性の向上に役立ちます。 |
| ChangeResourceGroup | ChangeResourceGroup | リソースグループを変更します。リソースグループは、スケーリンググループなどのクラウド リソースを特定の目的、権限、または所有権に基づいて分類および管理するための機能です。多数のプロジェクトとユーザーを管理する大規模で多面的な組織では、この機能は階層的な管理アプローチを採用することで、管理タスクを簡素化し、リソース割り当てと監視の効果を向上させます。ChangeResourceGroup API を呼び出すことで、スケーリンググループをあるリソースグループから別のリソースグループに移動でき、新しいグループにおいて効率的な監視と管理が可能になります。この操作により、反復的で時間のかかるクロスサービスでのリソース クエリが不要になり、運用効率が向上します。 |
| ApplyScalingGroup | ApplyScalingGroup | 設定ファイルを使用してスケーリンググループを作成および管理します。ApplyScalingGroup 操作を呼び出すことで、設定ファイルを用いて効率的にスケーリンググループの作成および管理が可能です。 |
| DescribeElasticStrength | DescribeElasticStrength | スケーリンググループの設定は、スケールアウトを成功させるための鍵です。Auto Scaling は、伸縮性強度を使用してスケーリング設定の有効性を定量化することで、的を絞った最適化を支援します。 |
スケーリング設定
|
API |
タイトル |
説明 |
| CreateScalingConfiguration | ECS タイプのスケーリング設定を作成します | スケーリンググループ ID、インスタンスタイプ、インスタンスイメージなどの情報を指定して、スケーリンググループの ECS タイプのスケーリング設定を作成します。 |
| DescribeScalingConfigurations | ECS タイプのスケーリング設定を照会します | ECS タイプのスケーリング設定に関する情報（インスタンスタイプやイメージなど）を照会します。これにより、弾力的なスケールアウトに使用される ECS インスタンステンプレートを事前に確認できます。 |
| ModifyScalingConfiguration | ECS タイプのスケーリング設定を変更します | 現在のスケーリング設定がビジネス要件を満たさない場合、ModifyScalingConfiguration 操作を呼び出して ECS タイプのスケーリング設定（スケールアウト用の ECS インスタンステンプレート）を変更します。 |
| DeleteScalingConfiguration | DeleteScalingConfiguration | Elastic Compute Service (ECS) インスタンス作成用のスケーリング設定を削除します。 |
| CreateEciScalingConfiguration | CreateEciScalingConfiguration | Elastic Container Instance タイプのスケーリング設定を作成します。Auto Scaling は、スケールアウトイベント時にビジネス要件を満たすために、このスケーリング設定をテンプレートとして使用して Elastic Container Instance を作成します。 |
| DescribeEciScalingConfigurations | DescribeEciScalingConfigurations | Elastic Container Instance タイプのスケーリング設定をクエリします。DescribeEciScalingConfigurations 操作を呼び出す際に、ScalingGroupId、ScalingConfigurationIds、または ScalingConfigurationNames を指定して、目的のスケーリング設定の詳細（各 Elastic Container Instance のインスタンス入札ポリシー、インスタンスタイプ、イメージプルポリシー、負荷分散の重みなど）を取得できます。これにより、Elastic Container Instance を作成するための適切なテンプレートを選択したり、Elastic Container Instance の自動スケーリングポリシーを変更する前に既存のスケーリング設定を参照したりできます。 |
| DescribeEciScalingConfigurationDetail | DescribeEciScalingConfigurationDetail | スケーリング設定の詳細をクエリします。スケーリング設定 ID を指定して、一時記憶領域のサイズ、IPv6 アドレス数、EIP の帯域幅などの詳細情報を取得できます。スケーリング設定の詳細は YAML ファイルとして取得可能です。 |
| ModifyEciScalingConfiguration | ModifyEciScalingConfiguration | Elastic Container Instance (ECI) タイプのスケーリング設定を変更します。ModifyEciScalingConfiguration 操作を呼び出す際、変更対象のスケーリング設定の ID、名前、インスタンスプロパティを指定できます。インスタンス再起動ポリシー、インスタンス入札ポリシー、および EIP 帯域幅を変更できます。 |
| ApplyEciScalingConfiguration | ApplyEciScalingConfiguration | Elastic Container Instance (ECI) タイプのスケーリング設定を適用します。設定ファイルを使用して ECI タイプのスケーリング設定を作成および管理する場合は、ApplyEciScalingConfiguration API を呼び出すことができます。 |
| DeleteEciScalingConfiguration | DeleteEciScalingConfiguration | Elastic Container Instance タイプのスケーリング設定を削除します。スケーリンググループのスケーリング設定が非アクティブ状態で、そのスケーリング設定から作成された Elastic Container Instance がスケーリンググループに含まれていない場合、DeleteEciScalingConfiguration API を呼び出してスケーリング設定を削除し、スケーリング設定のクォータを解放できます。 |
| DescribePatternTypes | DescribePatternTypes | インスタンスタイプを照会します。DescribePatternTypes オペレーションを呼び出す際、vSwitch ID、vCPU 数、メモリサイズ、インスタンスファミリー、上限価格などの属性を指定して、ビジネス要件を満たすインスタンスタイプを絞り込むことができます。 |
| DescribeCandidateInstanceType | 候補となるインスタンスタイプのクエリ | 候補インスタンスタイプを一覧表示します。 |
スケーリングルール
|
API |
タイトル |
説明 |
| CreateScalingRule | スケーリングルールを作成する | スケーリングルールの機能はタイプによって決まります。タイプは、スケーリングアクティビティのトリガー、またはスケーリンググループの境界値のインテリジェントな設定に使用できます。ビジネス要件に応じて、CreateScalingRule API を呼び出し、さまざまなタイプのスケーリングルールを作成できます。たとえば、スケーリンググループの境界値の設定のみが必要な場合は、予測ルールを選択することを推奨します。 |
| ModifyScalingRule | ModifyScalingRule | スケーリングルールを変更します。既存のスケーリングルールがビジネス要件を満たさない場合、新しいルールを作成せずに、ModifyScalingRule API を呼び出してスケーリングルールを変更できます。これにより、ワークフローを効率化し、冗長な手順を回避することで、運用効率の向上とコストの最適化に貢献します。 |
| DescribeScalingRules | DescribeScalingRules | スケーリングルールを照会します。このオペレーションを呼び出す際に、スケーリングルールの ID、名前、または Alibaba Cloud リソースネーム (ARN) を指定して、対象のスケーリングルールの調整方法、インスタンスのウォームアップ期間、および関連付けられたイベントトリガーのタスクなどの詳細を照会できます。 |
| DeleteScalingRule | DeleteScalingRule | スケーリングルールを削除します。 |
トリガータスク
|
API |
タイトル |
説明 |
| ExecuteScalingRule | ExecuteScalingRule | スケーリングルールを実行します。Elastic Compute Service (ECS) インスタンスまたはエラスティックコンテナインスタンスの数を調整するには、Auto Scaling にスケーリングルールを実行させます。ExecuteScalingRule API を呼び出して、簡易スケーリングルールまたはステップスケーリングルールを実行できます。ターゲット追跡スケーリングルールと予測スケーリングルールは、Auto Scaling によって自動的に実行されるため、明示的な実行呼び出しは不要です。 |
| ScaleWithAdjustment | ScaleWithAdjustment | ExecuteScalingRule API とは異なり、 ScaleWithAdjustment API を使用すると、事前にスケーリングルールを作成せずに、指定された調整ルールに基づいて弾力的スケーリングをトリガーできます。 |
| AttachInstances | AttachInstances | インスタンスをスケーリンググループに追加してサービスを提供するか、エコノミーモードで停止している Elastic Compute Service (ECS) インスタンスを再起動してサービスを再開します。AttachInstances API を呼び出すと、ECS インスタンス、Elastic Container Instance、または Alibaba Cloud が管理するサードパーティインスタンスをスケーリンググループに追加してサービスを提供できます。また、この API を呼び出して、スケーリンググループ内のエコノミーモードで停止している ECS インスタンスを再起動し、サービスを提供することもできます。 |
| RemoveInstances | RemoveInstances | スケーリンググループが有効で、進行中のスケーリングアクティビティがない場合は、RemoveInstances API を呼び出して、1 つ以上のインスタンスをグループから削除できます。 |
| DetachInstances | DetachInstances | スケーリンググループからインスタンスを削除します。有効なスケーリンググループで実行中のスケーリングアクティビティがない場合、 DetachInstances API を呼び出して、1 つ以上の Elastic Compute Service (ECS) インスタンス、エラスティックコンテナインスタンス、または Alibaba Cloud ホスト型のサードパーティーインスタンスをスケーリンググループから削除できます。 |
定期タスク
|
API |
タイトル |
説明 |
| CreateScheduledTask | CreateScheduledTask | スケジュールされたタスクを作成します。スケジュールされたタスクはスケーリングタスクの一種で、指定した時点で特定のスケーリングルールを自動的に実行できます。CreateScheduledTask API を呼び出してスケジュールされたタスクを作成し、コンピューティングリソースの自動スケーリングを実装できます。これにより、ビジネス継続性を確保し、リソースコストを最小限に抑えます。 |
| ModifyScheduledTask | ModifyScheduledTask | スケジュールされたタスクを変更します。既存のスケジュールされたタスクがビジネス要件を満たさない場合、ModifyScheduledTask API を呼び出して、実行するスケーリングルールやスケーリンググループの境界値などのパラメーター設定を調整できます。新しいスケジュールされたタスクを作成する必要はありません。この操作により、スケジュールされたタスクを柔軟に最適化できます。 |
| DescribeScheduledTasks | DescribeScheduledTasks | スケジュールされたタスクを照会します。スケジュールされたタスクとは、指定された時点でスケーリングルールの自動実行をトリガーする、事前定義されたタスクです。これにより、ビジネスニーズを最小限のコストで満たすために、コンピューティングリソースが自動的にスケーリングされます。スケジュールされたタスクを作成した後、 DescribeScheduledTasks API を呼び出して、実行時点やスケーリンググループ ID などのタスクの詳細を照会できます。また、この API を呼び出して、既存のスケジュールされたタスクの総数を照会することもできます。 |
| DeleteScheduledTask | DeleteScheduledTask | スケジュールされたタスクを削除します。予測可能なパターンを持つワークロードに対して、ビジネス要件に合わせてスケジュールされたタスクを作成し、リソース使用率を最適化してコストを削減できます。これらのタスクは、ピーク時間を見越して十分なコンピューティングリソースを自動的にプロビジョニングし、オフピーク時間には未使用のリソースを効率的に解放することで、運用効率を合理化し、費用を削減します。スケジュールされたタスクが不要になった場合、DeleteScheduledTask API を呼び出して削除できます。 |
イベントトリガータスク
|
API |
タイトル |
説明 |
| CreateAlarm | CreateAlarm | 監視タスクを作成します。ビジネスで予期しないトラフィックの急増が発生する場合や、特定のパターンがない場合は、CreateAlarm 操作を呼び出して監視タスクを作成し、CloudMonitor メトリックをそのタスクに関連付けることができます。これにより、スケーリンググループ内の Elastic Compute Service (ECS) インスタンスまたはエラスティックコンテナインスタンスの数を動的に調整し、リアルタイムのメトリックデータを常に把握することで、クラウドリソースの管理とメンテナンスが容易になります。 |
| DescribeAlarms | DescribeAlarms | 監視タスクを照会します。DescribeAlarms 操作を呼び出すことで、監視タスクの構成を確認し、モニタリングデータの変化をリアルタイムで把握できます。これにより、システムリソースに関する問題を早期にトラブルシューティングし、システムの安定性と信頼性を確保できます。 |
| ModifyAlarm | ModifyAlarm | イベントトリガータスクの変更 |
| EnableAlarm | EnableAlarm | イベントトリガータスクを有効にします。 ビジネスパターンが予測不可能であるか、予期しないトラフィックスパイクが発生しやすい場合、CloudMonitor のメトリクスを関連付けてイベントトリガータスクを作成することで、ワークロードの変動を効果的に監視できます。 イベントトリガータスクで指定されたアラート基準が満たされると、Auto Scaling は速やかにアラートを発行し、これらのタスク内で事前に定義されたスケーリングルールを実行します。 このプロセスは、タスクの事前に定義された有効時間枠内に実行され、スケーリンググループ内の Elastic Compute Service (ECS) インスタンスまたは弾性コンテナインスタンスが自動的に増減します。 最終的に、このメカニズムはリアルタイムのワークロード需要に基づき、リソースを動的に最適化します。 無効状態のイベントトリガータスクを再利用したい場合は、EnableAlarm API を呼び出して有効にできます。 |
| DisableAlarm | DisableAlarm | イベントトリガーのタスクを無効にします。 ビジネスパターンが予測不可能であったり、予期しないトラフィックスパイクが発生しやすかったりする場合、CloudMonitor のメトリクスを関連付けてイベントトリガーのタスクを作成することで、ビジネスワークロードの変動を効果的に監視できます。 イベントトリガーのタスクで指定されたアラート基準が満たされると、Auto Scaling は速やかにアラートを発行し、タスク内で事前定義されたスケーリングルールを実行します。 このプロセスは、タスクに事前定義された有効時間枠内に実行され、スケーリンググループ内の Elastic Compute Service (ECS) インスタンスまたは elastic container instances を自動的に増減させます。 最終的に、このメカニズムは、リアルタイムのワークロード需要に基づいてリソースを動的に最適化します。 現在イベントトリガーのタスクが不要な場合は、DisableAlarm API を呼び出して無効にすることができます。 |
| DeleteAlarm | DeleteAlarm | イベントトリガータスクを削除します。 ビジネスパターンが予測不能であるか、予期せぬトラフィックスパイクが発生しやすい場合、CloudMonitor のメトリクスを関連付けてイベントトリガータスクを作成し、ビジネスワークロードの変動を効果的に監視できます。 イベントトリガータスクで指定されたアラート基準が満たされると、Auto Scaling は速やかにアラートを発行し、タスク内で事前定義されたスケーリングルールを実行します。 このプロセスは、タスクに事前定義された有効期間内で行われ、スケーリンググループ内の Elastic Compute Service (ECS) インスタンスまたは弾性コンテナインスタンスの自動的な増減を促進します。 最終的に、このメカニズムは、リアルタイムのワークロード需要に基づいたリソースの動的な最適化を実現します。 イベントトリガータスクが不要になった場合は、DeleteAlarm オペレーションを呼び出して削除できます。 |
インスタンスリフレッシュ
|
API |
タイトル |
説明 |
| DescribeInstanceRefreshes | インスタンスリフレッシュタスクの照会。 | スケーリンググループ内のインスタンスリフレッシュタスクの基本情報および進捗状況を照会します。 |
| StartInstanceRefresh | インスタンスリフレッシュタスクを開始します。 | スケーリンググループに新しいスケーリング設定を適用する場合、またはスケーリンググループ内のインスタンスのイメージを更新する場合に、スケーリンググループ内のインスタンスをリフレッシュします。 |
| CancelInstanceRefresh | CancelInstanceRefresh | インスタンス更新タスクをキャンセルします。インスタンス更新タスクの実行によって設定がすでに更新されているインスタンスは、タスクをキャンセルした後もそのまま維持されることに注意してください。 |
| RollbackInstanceRefresh | RollbackInstanceRefresh | インスタンスリフレッシュタスクをロールバックします。インスタンスリフレッシュタスクがビジネス要件を満たせない場合、RollbackInstanceRefresh API を呼び出すことができます。インスタンスリフレッシュタスクをロールバックすると、Auto Scaling はアクティブなスケーリング設定に基づいて新しいインスタンスを作成し、タスクの実行により更新されたインスタンスを置き換えます。 |
| SuspendInstanceRefresh | SuspendInstanceRefresh | インスタンスの更新タスクを一時停止します。進行中のインスタンスの更新タスクの設定に問題があると思われるものの、ロールバックするかどうか確信が持てない場合は、SuspendInstanceRefresh API を呼び出してタスクを一時停止できます。 |
| ResumeInstanceRefresh | ResumeInstanceRefresh | インスタンス更新タスクを再開します。 |
ライフサイクルフック
|
API |
タイトル |
説明 |
| CreateLifecycleHook | CreateLifecycleHook | スケーリンググループに 1 つ以上のライフサイクルフックを作成します。ライフサイクルフックを使用すると、インスタンスのライフサイクルにおける重要な段階 (インスタンスの起動や終了など) で、通知の送信やスクリプト実行の自動化などのカスタムアクションを実行できます。ライフサイクルフック機能を実装することで、インスタンスをより細かく制御および管理できるようになります。たとえば、ライフサイクルフックが有効になっているときに、インスタンスの設定を検証したり、カスタムタスクを設定したり、データをバックアップしたりすることで、アプリケーションデプロイの柔軟性と信頼性を向上させることができます。 |
| ModifyLifecycleHook | ModifyLifecycleHook | ライフサイクルフックを変更します。既存のライフサイクルフックがビジネス要件を満たさなくなった場合、ModifyLifecycleHook API を呼び出して、ライフサイクルフックのスケーリングイベント、タイムアウト期間、デフォルトアクションなどの情報を変更できます。ライフサイクルフックを変更する前に、ID、名前、またはスケーリンググループでライフサイクルフックを特定できます。 |
| DescribeLifecycleHooks | DescribeLifecycleHooks | ライフサイクルフックをクエリします。この操作では、ライフサイクルフック ID またはスケーリンググループ ID を指定して、目的のライフサイクルフックの詳細をクエリできます。たとえば、ライフサイクルフックがタイムアウトした後のデフォルトアクション、ライフサイクルフックに対応するスケーリングアクティビティ、通知の受信者の Alibaba Cloud Resource Name (ARN)、ライフサイクルフックの有効期間などです。 |
| RecordLifecycleActionHeartbeat | RecordLifecycleActionHeartbeat | Elastic Compute Service (ECS) インスタンスが待機状態であるタイムウィンドウを延長します。現在のタイムウィンドウが、ECS インスタンス上でカスタム操作を完了するのに十分でない場合は、RecordLifecycleActionHeartbeat API を呼び出してタイムウィンドウを延長できます。この API を呼び出す際、lifecycleHookId、lifecycleActionToken、および heartbeatTimeout を指定して、対象の ECS インスタンスのタイムウィンドウを延長できます。 |
| DescribeLifecycleActions | DescribeLifecycleActions | ライフサイクルフックのアクションを照会します。DescribeLifecycleActions API を呼び出す際に、`ScalingActivityId`、`NextToken`、`MaxResults` などのパラメーターを指定して、ライフサイクルフックのアクションステータスや ID などの詳細を照会できます。また、この API を呼び出して、ライフサイクルフックが適用される Elastic Compute Service (ECS) インスタンスの ID を照会することもできます。 |
| CompleteLifecycleAction | CompleteLifecycleAction | ライフサイクルフックのタイムアウト期間を前倒しで終了します。スケーリンググループにライフサイクルフックを作成している場合、ビジネス要件に基づいて CompleteLifecycleAction API を呼び出し、ライフサイクルフックのタイムアウト期間を前倒しで終了できます。 |
| DeleteLifecycleHook | DeleteLifecycleHook | ライフサイクルフックを削除します。ライフサイクルフックが不要になった場合は、DeleteLifecycleHook API を呼び出して削除し、ライフサイクルフックのクォータを解放できます。 |
イベント通知
|
API |
タイトル |
説明 |
| CreateNotificationConfiguration | CreateNotificationConfiguration | 通知ルールを作成します。CreateNotificationConfiguration API を呼び出して通知ルールを作成し、スケーリングイベントやリソースの変更に関する通知を受け取ることができます。これにより、スケーリンググループの動的なステータスをリアルタイムで把握し、スケーリングイベントの管理をさらに自動化できます。 |
| ModifyNotificationConfiguration | ModifyNotificationConfiguration | イベント通知ルールを変更します。イベント通知ルールは、指定した種類のイベントが発生した場合に、CloudMonitor、Message Service (MNS) のトピック、または MNS キューに通知を自動的に送信できます。これにより、スケーリンググループの動向をいち早く把握でき、さらにリソース管理を自動化できます。既存のイベント通知ルールがビジネス要件を満たさない場合は、新しいルールを作成することなく、ModifyNotificationConfiguration API を呼び出してイベント通知ルールを変更できます。この API を呼び出してイベント通知ルールの通知方法を変更することはできない点にご注意ください。 |
| DescribeNotificationConfigurations | DescribeNotificationConfigurations | DescribeNotificationConfiguration API を呼び出して、スケーリングイベントまたはリソースの変更に関する通知設定 (通知タイプや通知方法など) を照会できます。 |
| DeleteNotificationConfiguration | DeleteNotificationConfiguration | イベント通知機能は、Auto Scaling からの通知を CloudMonitor や Message Service (MNS) のトピックやキューなどの指定されたエンドポイントに自動的に転送するため、効率的な問題の特定とイベント管理が容易になります。 イベント通知ルールが不要になった場合、DeleteNotificationConfiguration API を呼び出して削除できます。 |
| DescribeNotificationTypes | DescribeNotificationTypes | 通知タイプを照会します。DescribeNotificationTypes API を呼び出して、スケーリンググループ内で発生したスケーリングイベントまたはリソースの変更に関する通知のタイプを照会できます。通知は、スケールアウトイベントの成功、スケールインイベントの成功、スケジュールタスクの有効期限切れ、スケールアウトイベントの部分的な成功などのシナリオでトリガーされます。 |
ヘルス診断
|
API |
タイトル |
説明 |
| CreateDiagnoseReport | CreateDiagnoseReport | 診断レポートを作成します。 |
| DescribeDiagnoseReports | DescribeDiagnoseReports | 診断レポートの取得 |
| DescribeScalingGroupDiagnoseDetails | DescribeScalingGroupDiagnoseDetails | DescribeScalingGroupDiagnoseDetails |
インスタンス
|
API |
タイトル |
説明 |
| EnterStandby | EnterStandby | Elastic Compute Service (ECS) インスタンスをスタンバイ状態にします。 |
| ExitStandby | ExitStandby | インスタンスをスタンバイ状態から解除します。スケーリンググループでスケールイン イベントがトリガーされた場合、Auto Scaling は、スタンバイ状態にある Elastic Compute Service (ECS) インスタンスまたは Elastic Container Instance をスケーリンググループから除去しません。スタンバイ状態のインスタンスをサービスに復帰させたい場合は、ExitStandby API を呼び出してインスタンスをスタンバイ状態から解除し、InService 状態に移行できます。 |
| RebalanceInstances | RebalanceInstances | 複数のゾーンにまたがる Elastic Compute Service (ECS) インスタンスをリバランスします。ECS インスタンスが複数のゾーンにまたがって不均等に分散している場合、RebalanceInstances API を呼び出すことで、ゾーン間のインスタンスをリバランスできます。 |
| SetInstanceHealth | SetInstanceHealth | インスタンスの正常性を設定します。自動ヘルスチェックシステムでは、Elastic Compute Service (ECS) インスタンスまたは elastic container instances (ECI) の正確なヘルスステータスを十分に判断できない場合があります。この問題を解決するために、SetInstanceHealth API を呼び出して、問題のあるインスタンスを迅速に特定して解決できます。この API は、実際のビジネス要件により正確に適合し、運用保守の課題に効率的に対処するように設計されています。 |
| SetInstancesProtection | SetInstancesProtection | Elastic Compute Service (ECS) インスタンスを保護状態に設定するか、保護状態から解除します。ECS インスタンスを保護状態に設定すると、スケールイン イベントがトリガーされても、その ECS インスタンスは停止、またはスケーリンググループから削除されません。この場合、Auto Scaling コンソールで手動で ECS インスタンスを削除するか、RemoveInstances API を呼び出して削除できます。 |
リージョン
|
API |
タイトル |
説明 |
| DescribeRegions | DescribeRegions | リージョンを照会します。Auto Scaling をアクティブ化する前に、DescribeRegions API を呼び出して、Auto Scaling が正式にリリースされているリージョンを照会できます。この事前ステップにより、Auto Scaling をアクティブ化するための最適なリージョンとアベイラビリティーゾーンの両方を戦略的に選択でき、選択した地理的エリア内で最高のアクセス速度と運用効率を確保します。 |
タグ
|
API |
タイトル |
説明 |
| TagResources | TagResources | タグを作成して追加します。TagResources API を呼び出すことで、Auto Scaling リソースにタグを統一的に作成およびアタッチし、リソース管理を効率化できます。この機能により、タグに基づいてリソースを分類し、リソースの割り当てと利用の全体的な効率を向上させることができます。 |
| ListTagResources | ListTagResources | タグを照会します。ListTagResources API を呼び出すことで、Auto Scaling リソースに追加されたタグを照会し、リソース使用率を明確にし、効率的なリソース管理を促進します。この API は、リソース分類と権限管理プロセスの自動化を支援します。 |
| UntagResources | UntagResources | Auto Scaling リソースから複数のタグを同時に削除します。この操作は、リソース管理業務を効率化し、システム効率を向上させ、潜在的なセキュリティの脆弱性を軽減します。特定のリソースからタグが削除され、他のリソースに再度追加されない場合、システムは未使用のタグを自動的に削除します。 |
| ListTagKeys | ListTagKeys | Auto Scaling リソースに追加されたタグキーを照会します。タグキーを照会すると、Auto Scaling リソースの分類、識別、および監視が容易になり、リソース管理の柔軟性と利便性が向上します。 |
| ListTagValues | ListTagValues | Auto Scaling (ESS) リソースに関連付けられたタグ値を照会します。これにより、リソースへの理解を深め、ESS リソースをより効率的に分類および管理できます。 |
その他
|
API |
タイトル |
説明 |
| VerifyUser | VerifyUser | Auto Scaling (ESS) がアクティブ化されているかどうかを検証します。この操作は、ビジネスワークロードの変化や受信トラフィックの変動に応じて、システムがリソースプロビジョニングを自動的に調整することを保証します。このオートスケーリング機能により、システム全体のパフォーマンスが向上し、高可用性を確保し、動的な需要に対応するための柔軟性が向上します。 |
| VerifyAuthentication | VerifyAuthentication | 指定した Alibaba Cloud アカウントが AliyunServiceRoleForAutoScaling サービスリンクロールを引き受けているかどうかを確認します。Elastic Compute Service (ECS) インスタンスとエラスティックコンテナインスタンスを操作するには、アカウントがこのサービスリンクロールを引き受けている必要があります。 |
| DescribeLimitation | DescribeLimitation | リソースクォータを照会する操作です。 たとえば、DescribeLimitation API を呼び出すことで、スケーリンググループに作成できるスケジュールされたタスクの最大数、スケーリンググループにアタッチできるロードバランサーの最大数、スケーリンググループに追加できるインスタンスの最大数、スケーリンググループに作成できるスケーリング設定の最大数を照会できます。 |
| ModifyInstanceAttribute | ModifyInstanceAttribute | 1 つまたは複数の Elastic Compute Service (ECS) インスタンスの属性を変更します。この API を呼び出すことで、スケーリンググループ内の ECS インスタンスの属性を変更できます。スケーリンググループに手動で追加されたインスタンスのホスティング属性のみを変更できます。 |
| DescribeAlertConfiguration | DescribeAlertConfiguration | テキストメッセージ、内部メッセージ、または E メール通知をトリガーするスケーリングアクティビティのステータスを照会します。DescribeAlertConfiguration API を呼び出すには、照会対象のスケーリンググループ ID とリージョン ID を指定する必要があります。スケーリングアクティビティのステータスには、成功、失敗、拒否があります。 |
| ModifyAlertConfiguration | ModifyAlertConfiguration | テキストメッセージまたはメール通知の対象となるスケーリングアクティビティのステータスを設定します。 |
| DescribeInstanceCreateAndDeleteStatistics | DescribeInstanceCreateAndDeleteStatistics | インスタンスの作成と削除に関する統計です。 |
| QueryPredictiveValue | QueryPredictiveValue | スケーリンググループで予測されるインスタンス数を照会します。 |
| QueryHistoricalMetric | QueryHistoricalMetric | 予測スケーリングルールを使用するスケーリンググループの過去のモニタリングデータを照会します。 |
| QueryPredictiveTaskInfo | QueryPredictiveTaskInfo | 予測タスクの情報を照会します。 |
| QueryPredictiveMetric | QueryPredictiveMetric | 予測モニタリングデータを照会します。 |
| DeleteDiagnoseReport | DeleteDiagnoseReport | スケーリンググループの健康診断レポートを削除します。 |
| DescribeScalingActivityStatistics | DescribeScalingActivityStatistics | 指定した期間内における、さまざまな状態のスケーリングアクティビティの分布を取得します。 |