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 | スケーリンググループを作成します | ビジネス要件とポリシーに基づいてインスタンスを追加または削除することで、計算能力を自動的に調整するスケーリンググループを作成します。 |
| ModifyScalingGroup | スケーリンググループを変更します。 | スケーリンググループの属性 (インスタンスの最大数、最小数、期待されるインスタンス数など) を変更します。現在のスケーリンググループの属性がビジネス要件を満たさなくなった場合、新しいスケーリンググループを作成する代わりにこの操作を呼び出して変更することで、時間とリソースを節約できます。 |
| EnableScalingGroup | EnableScalingGroup | スケーリンググループを有効にします。スケーリンググループが「無効」状態であり、起動テンプレートやスケーリング設定などのインスタンス構成ソースが含まれている場合、EnableScalingGroup API を呼び出すことでスケーリンググループを有効にできます。この操作により、Auto Scaling はビジネス要件に基づいて、スケーリンググループ内のコンピューティング能力 (インスタンス数) を動的に調整できます。 |
| DisableScalingGroup | DisableScalingGroup | スケーリンググループを無効化します。有効なスケーリンググループが一時的に不要な場合は、DisableScalingGroup API を呼び出して無効化できます。 |
| SetGroupDeletionProtection | SetGroupDeletionProtection | スケーリンググループの削除保護を設定します。スケーリンググループで削除保護を有効にすると、そのグループは削除できなくなります。削除保護を無効にすると、グループを直接削除できます。SetGroupDeletionProtection オペレーションを呼び出して、削除保護を有効または無効にできます。 |
| DeleteScalingGroup | DeleteScalingGroup | スケーリンググループを削除します。変化するビジネス要件を満たすために、ポリシーに基づいて特定タイプのインスタンスの自動的な追加または削除を有効にしたい場合、スケーリンググループを作成してコンピューティング能力を容易に管理できます。コンピューティング能力とは、コンピューティング機能を提供するインスタンスを指します。スケーリンググループが不要になった場合、DeleteScalingGroup API を呼び出してスケーリンググループを削除し、スケーリンググループのクォータを解放できます。 |
| DescribeScalingGroups | スケーリンググループを一覧表示します | スケーリンググループの詳細 (基本情報、インスタンス、スケーリング設定を含む) を照会します。 |
| DescribeScalingGroupDetail | 指定されたスケーリンググループの詳細を照会します | 指定されたスケーリンググループの基本情報、スケーリンググループ内のインスタンス、スケーリング設定などの詳細を照会します。Elastic Container Instance (ECI) スケーリンググループの場合、OutputFormat パラメーターが YAML にセットされていると、出力は Kubernetes Deployment YAML フォーマットで返されます。 |
| DescribeScalingInstances | スケーリンググループ内の ECS インスタンスを一覧表示します | 指定されたスケーリンググループ内の ECS インスタンスの詳細を照会します。詳細には、実行中のスポットインスタンスの総数、ECS インスタンスの総数、ウォームアップステータス、およびスケーリンググループ内の ECS インスタンスのライフサイクルステータスが含まれます。ヘルスステータス、ライフサイクルステータス、および作成タイプで ECS インスタンスをフィルターすることもできます。 |
| DescribeScalingActivities | スケーリングアクティビティを照会します | スケーリングアクティビティの詳細を照会し、スケジュールタスク、イベントトリガータスク、またはスケーリングルールの手動実行によってトリガーされたスケーリングアクティビティの結果を確認します。たとえば、スケーリングアクティビティの詳細ページのビューで、スケーリングアクティビティ後のステータス、原因、およびインスタンスの総数を確認できます。 |
| DescribeScalingActivityDetail | DescribeScalingActivityDetail | スケーリングアクティビティの詳細を照会します。 スケーリングアクティビティは、その ID を使用して照会できます。 スケーリングアクティビティの詳細には、スケーリングアクティビティのステータス、エラーコード、エラーメッセージが含まれます。 エラーメッセージに基づいて、効率的に問題をトラブルシューティングし、サービスのパフォーマンスを分析できます。 |
| AttachLoadBalancers | 1 つ以上のロードバランサーインスタンスを追加します | 1 つ以上のロードバランサーインスタンスをスケーリンググループに関連付けて、スケーリンググループ内のインスタンス間でトラフィックを分散し、サービス容量を向上させます。AttachLoadBalancers 操作を呼び出して、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 | 1 つ以上の RDS インスタンスをアタッチします | 1 つ以上の RDS インスタンスをスケーリンググループにアタッチします。スケーリンググループ内の RDS インスタンスの数は任意の時間に調整でき、柔軟性と可用性を向上できます。 |
| DetachDBInstances | DetachDBInstances | スケーリンググループから 1 つ以上の ApsaraDB RDS インスタンスをデタッチします。 スケーリンググループにアタッチされている ApsaraDB RDS インスタンスの数を減らす場合は、DetachDBInstances API を呼び出すことができます。 この操作により、スケーリンググループから ApsaraDB RDS インスタンスをデタッチし、リソース管理と割り当ての俊敏性と効率を大幅に向上させます。 |
| SuspendProcesses | SuspendProcesses | スケーリングプロセスを一時停止します。この操作では、特定のスケーリンググループ内の個別のスケーリングプロセスを選択的に一時停止できます。これにより、他のタスクを実行したり、スケーリング操作をより細かく管理したりできます。 |
| ResumeProcesses | スケーリンググループで一時停止されたプロセスを再開します | スケーリンググループで一時停止されたプロセスを再開し、スケーリンググループが機能ロジックに基づいて指定されたプロセスを実行するようにします。たとえば、ヘルスチェックプロセスを再開すると、スケーリンググループ内のインスタンスが異常と判断された場合に、そのインスタンスがスケーリンググループから自動的に削除されます。 |
| AttachVServerGroups | CLB インスタンスの vServer グループを追加します | Classic Load Balancer (CLB) インスタンスの 1 つ以上の vServer グループをスケーリンググループに追加します。スケーリンググループが CLB インスタンスに関連付けられると、スケーリンググループに追加されたインスタンスは CLB インスタンスのバックエンドサーバーとして自動的に追加され、CLB インスタンスによって転送されるアクセスリクエストを処理します。異なるリクエストを異なるバックエンドサーバーに転送する場合、またはドメイン名と URL に基づいてリクエストを転送する場合は、AttachVServerGroups API オペレーションを呼び出して CLB インスタンスの 1 つ以上の vServer グループを追加し、vServer グループを使用して異なるバックエンドサーバーを管理します。 |
| DetachVServerGroups | DetachVServerGroups | スケーリンググループから VServer グループをデタッチします。Auto Scaling は、ロードバランサーをスケーリンググループにアタッチして、サービスのパフォーマンスを向上させることができます。スケーリンググループに現在アタッチされているロードバランサーが、スケーリンググループ内のインスタンスにアクセス トラフィックを分散する必要がなくなった場合、DetachVServerGroups API を呼び出して、このロードバランサーの 1 つ以上の VServer グループをスケーリンググループからデタッチできます。 |
| AttachAlbServerGroups | 1 つ以上の ALB サーバーグループを追加します | 1 つ以上の Application Load Balancer (ALB) サーバーグループをスケーリンググループに追加します。この操作を使用すると、変動するワークロードをハンドルしてインスタンス数を動的に調整し、アプリケーションの高可用性を確保できます。ワークロードの変動時に自動的な弾力的スケーリングを有効にし、負荷に基づいてトラフィックを動的に分散することで、アプリケーションの安定性を向上させます。 |
| DetachAlbServerGroups | DetachAlbServerGroups | スケーリンググループから Application Load Balancer (ALB) サーバーグループをデタッチします。DetachAlbServerGroups API を呼び出す際、スケーリンググループ ID、ALB サーバーグループ ID、および対象の ALB サーバーグループ内の Elastic Compute Service (ECS) インスタンスが使用するポートを指定して、スケーリンググループから 1 つ以上の ALB サーバーグループをデタッチできます。 |
| AttachServerGroups | スケーリンググループにサーバーグループをアタッチします | 1 つ以上のサーバーグループをスケーリンググループにアタッチします。これは、変動するワークロードをハンドルし、アプリケーションの高可用性を確保するためにインスタンスを動的にスケーリングする必要があるシナリオに適用されます。サポートされるサーバーグループのタイプには、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 操作を呼び出して、スケーリンググループをあるリソースグループから別のリソースグループに移動できます。これにより、新しいリソースグループでスケーリンググループを集中的にモニターおよび管理でき、複数の Alibaba Cloud サービスにまたがるリソースを確認する必要がなくなります。 |
| ApplyScalingGroup | 設定ファイルを使用してスケーリンググループを管理します | 設定ファイルを使用してスケーリンググループを作成および管理します。 |
| DescribeElasticStrength | DescribeElasticStrength | スケーリンググループの設定は、スケールアウトを成功させるための鍵です。Auto Scaling は、伸縮性強度を使用してスケーリング設定の有効性を定量化することで、的を絞った最適化を支援します。 |
スケーリング設定
|
API |
タイトル |
説明 |
| CreateScalingConfiguration | ECS スケーリング設定を作成します | スケーリンググループの ECS スケーリング設定を作成します。 |
| DescribeScalingConfigurations | ECS タイプのスケーリング設定情報を照会します | インスタンスタイプやイメージを含む ECS タイプのスケーリング設定を照会し、スケールアウト時に使用される ECS インスタンステンプレートの詳細を取得します。 |
| ModifyScalingConfiguration | ECS タイプのスケーリング設定の変更 | 現在のスケーリング設定がビジネス要件を満たさない場合に、ECS タイプのスケーリング設定（スケールアウト用の ECS インスタンステンプレート）を変更します。 |
| DeleteScalingConfiguration | DeleteScalingConfiguration | Elastic Compute Service (ECS) インスタンス作成用のスケーリング設定を削除します。 |
| CreateEciScalingConfiguration | ECI スケーリング設定を作成します | Elastic Container Instance (ECI) スケーリング設定を作成します。Auto Scaling は、このスケーリング設定を ECI インスタンスのテンプレートとして使用し、スケールアウトアクティビティがトリガーされたときにビジネスニーズを満たすために ECI インスタンスを自動的に作成します。 |
| DescribeEciScalingConfigurations | ECI スケーリング設定を照会します | ECI スケーリング設定を照会します。DescribeEciScalingConfigurations を呼び出し、スケーリンググループ ID、スケーリング設定 ID、または名前などのパラメーターを指定できます。このクエリでは、インスタンスのプリエンプションポリシー、コンテナグループのインスタンスタイプ、コンテナイメージのプルポリシー、バックエンドサーバーとしての ECI インスタンスの重みなどの情報を取得します。 |
| DescribeEciScalingConfigurationDetail | ECI スケーリング構成の詳細を照会します | スケーリング構成 ID に基づいて、Elastic Container Instance (ECI) スケーリング構成の詳細を照会します。詳細には、一時ストレージサイズ、IPv6 アドレス数、および EIP 帯域幅が含まれます。出力は YAML フォーマットをサポートしています。 |
| ModifyEciScalingConfiguration | ECI スケーリング設定を変更します | スケーリング設定の ID や名前などのパラメーター、およびインスタンスの再起動ポリシー、プリエンプションポリシー、Elastic IP アドレス (EIP) 帯域幅などの Elastic Container Instance (ECI) 属性を指定して、スケーリング設定を変更します。 |
| ApplyEciScalingConfiguration | 設定ファイルを使用してスケーリング設定を管理します | 設定ファイルを使用して、Elastic Container Instance (ECI) スケーリング設定を作成または更新します。 |
| DeleteEciScalingConfiguration | DeleteEciScalingConfiguration | Elastic Container Instance タイプのスケーリング設定を削除します。スケーリンググループのスケーリング設定が非アクティブ状態で、そのスケーリング設定から作成された Elastic Container Instance がスケーリンググループに含まれていない場合、DeleteEciScalingConfiguration API を呼び出してスケーリング設定を削除し、スケーリング設定のクォータを解放できます。 |
| DescribePatternTypes | インスタンス属性に基づいてインスタンスタイプを照会します | vSwitch ID、vCPU 数、メモリサイズ、インスタンスファミリーレベル、最大値などのパラメーターに基づいてフィルタリングし、指定された要件を満たすインスタンスタイプを照会します。 |
| DescribeCandidateInstanceType | 候補となるインスタンスタイプのクエリ | 候補インスタンスタイプを一覧表示します。 |
スケーリングルール
|
API |
タイトル |
説明 |
| CreateScalingRule | スケーリングルールを作成します | スケーリングルールを作成します。スケーリングルールの目的はタイプによって決まり、スケーリングアクティビティのトリガーや、スケーリンググループの境界値のインテリジェントな設定に使用できます。ビジネス要件に応じて、さまざまなタイプのスケーリングルールを作成できます。たとえば、スケーリンググループの境界値のみを設定する必要がある場合は、予測スケーリングルールタイプを選択します。 |
| ModifyScalingRule | スケーリングルールを変更します | スケーリングルールの 1 つ以上の属性を変更します。既存のスケーリングルールが要件を満たさなくなった場合、新しいルールを作成する代わりにこの操作を呼び出して属性を変更できます。これにより、不要な繰り返し操作を回避し、時間とリソースを節約できます。 |
| DescribeScalingRules | スケーリングルールを照会します | スケーリングルール ID、スケーリングルール名、スケーリングルールの一意な識別子などのパラメーターを指定して、スケーリングルールとその詳細を照会します。詳細には、調整タイプ、インスタンスのウォームアップ時間、およびスケーリングルールに関連付けられたイベントトリガータスクが含まれます。 |
| DeleteScalingRule | DeleteScalingRule | スケーリングルールを削除します。 |
トリガータスク
|
API |
タイトル |
説明 |
| ExecuteScalingRule | ExecuteScalingRule | スケーリングルールを実行します。Elastic Compute Service (ECS) インスタンスまたはエラスティックコンテナインスタンスの数を調整するには、Auto Scaling にスケーリングルールを実行させます。ExecuteScalingRule API を呼び出して、簡易スケーリングルールまたはステップスケーリングルールを実行できます。ターゲット追跡スケーリングルールと予測スケーリングルールは、Auto Scaling によって自動的に実行されるため、明示的な実行呼び出しは不要です。 |
| ScaleWithAdjustment | ScaleWithAdjustment | ExecuteScalingRule API とは異なり、 ScaleWithAdjustment API を使用すると、事前にスケーリングルールを作成せずに、指定された調整ルールに基づいて弾力的スケーリングをトリガーできます。 |
| AttachInstances | スケーリンググループにインスタンスを手動で追加します | スケーリンググループにインスタンスを手動で追加します。スケーリンググループ外の Elastic Compute Service (ECS) インスタンス、Elastic Container Instance (ECI) インスタンス、またはホストインスタンスをスケーリンググループに追加して、サービスに投入します。また、スケーリンググループ内の節約モードになっている ECS インスタンスを実行中状態に再起動して、サービスに投入することもできます。 |
| RemoveInstances | スケーリンググループから 1 つ以上のインスタンスを削除します | スケーリンググループから不要な 1 つ以上のインスタンスを削除します。スケーリンググループが有効な状態にあり、スケーリングアクティビティが進行中でない場合に、RemoveInstances API オペレーションを呼び出してインスタンスを削除できます。 |
| DetachInstances | DetachInstances | スケーリンググループからインスタンスを削除します。有効なスケーリンググループで実行中のスケーリングアクティビティがない場合、 DetachInstances API を呼び出して、1 つ以上の Elastic Compute Service (ECS) インスタンス、エラスティックコンテナインスタンス、または Alibaba Cloud ホスト型のサードパーティーインスタンスをスケーリンググループから削除できます。 |
定期タスク
|
API |
タイトル |
説明 |
| CreateScheduledTask | 定期タスクを作成します | 定期タスクを作成します。定期タスクは、指定された時間に指定されたスケーリングルールを実行して、コンピューティングリソースを自動的にスケーリングし、ビジネス要件を満たし、コストをコントロールするための、事前にセットされたノードです。 |
| ModifyScheduledTask | ModifyScheduledTask | スケジュールされたタスクを変更します。既存のスケジュールされたタスクがビジネス要件を満たさない場合、ModifyScheduledTask API を呼び出して、実行するスケーリングルールやスケーリンググループの境界値などのパラメーター設定を調整できます。新しいスケジュールされたタスクを作成する必要はありません。この操作により、スケジュールされたタスクを柔軟に最適化できます。 |
| DescribeScheduledTasks | 定期タスク情報をクエリします | 定期タスクの詳細をクエリします。定期タスクは、指定された時間に指定されたスケーリングルールを実行してコンピュートリソースを自動的にスケーリングするプリセットタスクです。定期タスクの作成後、DescribeScheduledTasks 操作を呼び出して、トリガー時間、定期タスクの総数、定期タスクを実行するスケーリンググループの ID などのタスク詳細をクエリできます。 |
| DeleteScheduledTask | DeleteScheduledTask | スケジュールされたタスクを削除します。予測可能なパターンを持つワークロードに対して、ビジネス要件に合わせてスケジュールされたタスクを作成し、リソース使用率を最適化してコストを削減できます。これらのタスクは、ピーク時間を見越して十分なコンピューティングリソースを自動的にプロビジョニングし、オフピーク時間には未使用のリソースを効率的に解放することで、運用効率を合理化し、費用を削減します。スケジュールされたタスクが不要になった場合、DeleteScheduledTask API を呼び出して削除できます。 |
イベントトリガータスク
|
API |
タイトル |
説明 |
| CreateAlarm | イベントトリガータスクを作成します | イベントトリガータスクを作成します。バーストまたは予測不可能なトラフィックパターンを持つワークロードの場合、タスクを CloudMonitor メトリックに関連付けてスケーリンググループ内の ECS または ECI インスタンスの数を動的に調整し、インスタンスメトリックをリアル時間でモニターすることで、クラウドリソースをより適切に管理および保守できます。 |
| DescribeAlarms | DescribeAlarms | 監視タスクを照会します。DescribeAlarms 操作を呼び出すことで、監視タスクの構成を確認し、モニタリングデータの変化をリアルタイムで把握できます。これにより、システムリソースに関する問題を早期にトラブルシューティングし、システムの安定性と信頼性を確保できます。 |
| 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 | インスタンスリフレッシュタスクをキャンセルします | インスタンスリフレッシュタスクをキャンセルし、置き換えおよびスケールアウトされた新しいインスタンスを保持します。 |
| RollbackInstanceRefresh | インスタンスリフレッシュタスクをロールバックします | タスク実行中に希望する構成が要件を満たさない場合、インスタンスリフレッシュタスクをロールバックします。ロールバック中、システムはスケーリンググループのアクティブな構成を使用して新しいインスタンスを作成し、希望する構成に基づいて作成されたインスタンスを置き換えます。 |
| SuspendInstanceRefresh | SuspendInstanceRefresh | インスタンスの更新タスクを一時停止します。進行中のインスタンスの更新タスクの設定に問題があると思われるものの、ロールバックするかどうか確信が持てない場合は、SuspendInstanceRefresh API を呼び出してタスクを一時停止できます。 |
| ResumeInstanceRefresh | ResumeInstanceRefresh | インスタンス更新タスクを再開します。 |
ライフサイクルフック
|
API |
タイトル |
説明 |
| CreateLifecycleHook | スケーリンググループのライフサイクルフックを 1 つ以上作成します | 指定された Auto Scaling グループに対してライフサイクルフックを 1 つ以上作成します。ライフサイクルフックは、起動前や終了前など、インスタンスのライフサイクルにおける重大な段階でトリガーされます。これにより、通知の送信や自動化スクリプトの実行といったカスタム操作を実行できます。この特徴により、よりきめ細かなコントロールが可能になります。スケーリングアクティビティがインスタンスに影響を与える前後で、認証、設定、またはデータのバックアップを実行でき、アプリケーションデプロイの柔軟性と信頼性が向上します。 |
| ModifyLifecycleHook | ライフサイクルフックを変更します | ライフサイクルフックを変更します。ライフサイクルフック ID または名前、およびスケーリンググループ ID を指定することで、適用されるスケーリングアクティビティのタイプ、スケーリングアクティビティの待機時間、および待機状態終了後の後続操作を変更できます。 |
| DescribeLifecycleHooks | ライフサイクルフックの詳細を照会します | ライフサイクルフック ID またはスケーリンググループ ID を指定して、ライフサイクルフックの詳細を照会します。返されるフォーマットには、待機状態の終了後の次の操作、ライフサイクルフックに関連付けられたスケーリングアクティビティのタイプ、通知の受信者の識別子、および一時停止の待機時間が含まれます。 |
| RecordLifecycleActionHeartbeat | ライフサイクルフックがトリガーされた後の ECS インスタンスの保留期間を延長します | スケーリンググループでライフサイクルフックがトリガーされた後に保留状態になった ECS インスタンスの保留期間を延長します。保留中の ECS インスタンスのデフォルトの待機時間がカスタム操作に対して不十分な場合、この操作を呼び出して、ライフサイクルフック ID、スケーリングアクティビティの待機状態トークン、および新しい待機時間を指定することで保留期間を延長します。 |
| DescribeLifecycleActions | DescribeLifecycleActions | ライフサイクルフックのアクションを照会します。DescribeLifecycleActions API を呼び出す際に、`ScalingActivityId`、`NextToken`、`MaxResults` などのパラメーターを指定して、ライフサイクルフックのアクションステータスや ID などの詳細を照会できます。また、この API を呼び出して、ライフサイクルフックが適用される Elastic Compute Service (ECS) インスタンスの ID を照会することもできます。 |
| CompleteLifecycleAction | スケーリングアクティビティの待機状態を事前に終了します | スケーリンググループにライフサイクルフックが設定されている場合、次の操作を実行するために、スケーリングアクティビティの待機状態を事前に終了します。 |
| DeleteLifecycleHook | DeleteLifecycleHook | ライフサイクルフックを削除します。ライフサイクルフックが不要になった場合は、DeleteLifecycleHook API を呼び出して削除し、ライフサイクルフックのクォータを解放できます。 |
イベント通知
|
API |
タイトル |
説明 |
| CreateNotificationConfiguration | Auto Scaling イベントおよびリソース変更の通知構成を作成します | Auto Scaling イベントおよびリソース変更の通知構成を作成し、スケーリンググループの動向をトラックし、Auto Scaling イベントの管理の自動化を支援します。 |
| 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 | 診断レポートを作成します | 診断レポートを作成します。 |
| 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 | ECS インスタンスのディストリビューションをリバランスします | 在庫不足などの理由によりゾーン間のインスタンス数が不均衡になった場合、マルチゾーン スケーリンググループにおける ECS インスタンスのディストリビューションをリバランスします。 |
| SetInstanceHealth | スケーリンググループ内の ECS インスタンスのヘルスステータスを設定します | スケーリンググループ内の Elastic Compute サービス (ECS) インスタンスまたは Elastic Container Instance (ECI) のヘルスステータスをセットします。自動ヘルスチェックでは、ECS インスタンスまたは ECI インスタンスのヘルスステータスを正確に検出できない場合があります。ヘルスステータスを手動でセットすると、障害が発生したインスタンスを迅速に特定して対処でき、実際のビジネスおよび運用保守の要件をより適切に満たせます。 |
| SetInstancesProtection | スケーリンググループ内の ECS インスタンスの保護を有効または無効にします | スケーリンググループ内の 1 つ以上の ECS インスタンスの保護ステータスを設定または解除します。ECS インスタンスの保護特徴が有効になると、スケーリンググループの自動スケールイン時にそのインスタンスは終了またはリリースされません。このインスタンスは、コンソールから手動で削除するか、RemoveInstances 操作を呼び出すことによってのみ削除できます。 |
リージョン
|
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 | スケーリンググループ内のインスタンスの属性を変更します | スケーリンググループ内の ECS インスタンスの属性を変更します。現在、スケーリンググループに手動で追加されたインスタンスのライフサイクル管理属性のみを変更できます。 |
| DescribeAlertConfiguration | DescribeAlertConfiguration | テキストメッセージ、内部メッセージ、または E メール通知をトリガーするスケーリングアクティビティのステータスを照会します。DescribeAlertConfiguration API を呼び出すには、照会対象のスケーリンググループ ID とリージョン ID を指定する必要があります。スケーリングアクティビティのステータスには、成功、失敗、拒否があります。 |
| ModifyAlertConfiguration | ModifyAlertConfiguration | テキストメッセージまたはメール通知の対象となるスケーリングアクティビティのステータスを設定します。 |
| DescribeInstanceCreateAndDeleteStatistics | DescribeInstanceCreateAndDeleteStatistics | インスタンスの作成と削除に関する統計です。 |
| QueryPredictiveValue | 予測値を照会します | スケーリンググループ内の予測インスタンス数を照会します。 |
| QueryHistoricalMetric | QueryHistoricalMetric | 予測スケーリングルールを使用するスケーリンググループの過去のモニタリングデータを照会します。 |
| QueryPredictiveTaskInfo | QueryPredictiveTaskInfo | 予測タスクの情報を照会します。 |
| QueryPredictiveMetric | 予測モニタリングデータを照会します | 予測モニタリングデータを照会します。 |
| DeleteDiagnoseReport | DeleteDiagnoseReport | スケーリンググループの健康診断レポートを削除します。 |
| DescribeScalingActivityStatistics | DescribeScalingActivityStatistics | 指定した期間内における、さまざまな状態のスケーリングアクティビティの分布を取得します。 |