API 標準および多言語対応の SDK
本製品 (Ess/2014-08-28) の 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 | スケーリンググループを作成します | ビジネスの変化とポリシーに基づいて、指定されたタイプのインスタンス数を増減することで計算能力を自動的に調整するスケーリンググループを作成します。 |
| DeleteScalingGroup | スケーリンググループの削除 | スケーリンググループを削除します。 |
| ModifyScalingGroup | スケーリンググループを変更します | スケーリンググループを変更します。 |
| EnableScalingGroup | スケーリンググループを有効にします | スケーリンググループを有効にします。 |
| DisableScalingGroup | スケーリンググループを無効にします | スケーリンググループを無効にします。 |
| SetGroupDeletionProtection | スケーリンググループの削除保護を有効または無効にします | スケーリンググループの削除保護を有効または無効にします。 |
| AttachLoadBalancers | 1 つ以上の負荷分散インスタンスを追加します | 1 つ以上の負荷分散インスタンスを追加します。 |
| DetachLoadBalancers | 1 つ以上の負荷分散インスタンスを削除します | 1 つ以上の負荷分散インスタンスを削除します。 |
| DetachDBInstances | 1 つ以上の RDS インスタンスを削除します | 1 つ以上の ApsaraDB RDS インスタンスを削除します。 |
| AttachDBInstances | 1 つ以上の ApsaraDB RDS インスタンスを追加します | 1 つ以上の ApsaraDB RDS インスタンスを追加します。 |
| AttachVServerGroups | AttachVServerGroups | 1 つ以上の vServer グループを Server Load Balancer (SLB) インスタンスに追加します。 |
| DetachVServerGroups | DetachVServerGroups | 1 つ以上の仮想サーバーグループを削除します。 |
| DescribeScalingGroups | スケーリンググループを照会します | スケーリンググループを照会します。 |
| DescribeScalingInstances | スケーリンググループ内のインスタンスの照会 | スケーリンググループ内のECSインスタンス、ECIインスタンス、またはマネージドインスタンスのリストを照会し、インスタンスに関する情報を返します。 |
| DescribeScalingActivities | スケーリングアクティビティの照会 | スケーリングアクティビティを照会します。 |
| DescribeScalingActivityDetail | スケーリングアクティビティの詳細を照会します | スケーリングアクティビティの詳細を照会します。 |
| DescribeLimitation | リソースクォータの上限を照会します | リソースクォータの上限を照会します。 |
| DescribeElasticStrength | スケーリンググループの弾力性強度を照会します | スケーリンググループ構成の有効性は、スケールアウトオペレーションの成功レートを大きく左右します。Auto Scaling は弾力性強度を使用してスケーリング設定の有効性を記述し、構成品質を定量化して、スケーリング設定の最適化を支援します。 |
| VerifyAuthentication | Auto Scaling が ECS リソースを操作する権限が付与されているかどうかを確認します | Auto Scaling が ECS リソースを操作する権限が付与されているかどうかを確認します。 |
| SuspendProcesses | スケーリンググループ内の指定されたスケーリングプロセスを一時停止します | スケーリンググループ内の指定されたスケーリングプロセスを一時停止します。 |
| ResumeProcesses | スケーリンググループで一時停止中のスケーリングプロセスを再開します | スケーリンググループで一時停止中のスケーリングプロセスを再開します。 |
| VerifyUser | Auto Scaling が有効化されているかどうかを確認します | Auto Scaling が有効化されているかどうかを確認します。 |
スケーリング設定
|
API |
タイトル |
説明 |
| CreateScalingConfiguration | スケーリング設定を作成します | スケーリング設定を作成します。 |
| DeleteScalingConfiguration | スケーリング構成を削除します | スケーリング構成を削除します。 |
| ModifyScalingConfiguration | ModifyScalingConfiguration | スケーリング設定を変更します。 |
| DescribeScalingConfigurations | スケーリング設定情報の照会 | スケーリング設定の情報を照会します。 |
| DeactivateScalingConfiguration | 指定されたスケーリング設定を無効にします | 指定されたスケーリング設定を無効にします。 |
スケーリングルール
|
API |
タイトル |
説明 |
| CreateScalingRule | CreateScalingRule | スケーリングルールを作成します。 |
| DeleteScalingRule | スケーリングルールを削除します | スケーリングルールを削除します。 |
| ModifyScalingRule | スケーリングルールを変更します | スケーリングルールを変更します。 |
| DescribeScalingRules | スケーリングルールの照会 | スケーリンググループ内のスケーリングルールを照会し、スケーリングルールに関する情報を返します。 |
トリガータスク
|
API |
タイトル |
説明 |
| AttachInstances | スケーリンググループにECSインスタンスを手動で追加 | スケーリンググループにECSインスタンスを手動で追加します。 |
| DetachInstances | スケーリンググループから1つ以上のECSインスタンスを削除 | スケーリンググループから1つ以上のECSインスタンスを削除します。 |
| ExecuteScalingRule | スケーリングルールを実行します | スケーリングルールを実行します。 |
| RemoveInstances | スケーリンググループから1つ以上のECSインスタンスを削除 | スケーリンググループから1つ以上のECSインスタンスを削除します。 |
定期タスク
|
API |
タイトル |
説明 |
| CreateScheduledTask | 定期タスクを作成します | 定期タスクを作成します。 |
| DeleteScheduledTask | 定期タスクを削除します | 定期タスクを削除します。 |
| ModifyScheduledTask | 定時タスクの変更 | 定時タスクの情報を変更します。 |
| DescribeScheduledTasks | スケジュールされたタスク情報を照会します | スケジュールされたタスクの情報を照会します。 |
ライフサイクルフック
|
API |
タイトル |
説明 |
| CreateLifecycleHook | スケーリンググループに 1 つ以上のライフサイクルフックを作成します | スケーリンググループに 1 つ以上のライフサイクルフックを作成します。 |
| DeleteLifecycleHook | ライフサイクルフックを削除します | ライフサイクルフックを削除します。 |
| ModifyLifecycleHook | ライフサイクルフックを変更します | ライフサイクルフックの情報を変更します。 |
| DescribeLifecycleActions | ライフサイクルトークンを照会します | スケーリングアクティビティ ID とステータスによってライフサイクルトークンを照会します。 |
| DescribeLifecycleHooks | DescribeLifecycleHooks | ライフサイクルフックを照会します。 |
| RecordLifecycleActionHeartbeat | ライフサイクルフックがトリガーされた後の待機時間を延長します | ライフサイクルフックがトリガーされた後に一時停止中の ECS インスタンスの待機時間を延長します。 |
| CompleteLifecycleAction | スケーリングアクティビティの待機状態をスケジュールより前に完了します | スケーリングアクティビティの待機状態をスケジュールより前に完了します。 |
イベント通知
|
API |
タイトル |
説明 |
| CreateNotificationConfiguration | Auto Scaling イベントおよびリソース変更通知を作成します | Auto Scaling のスケーリングイベントおよびリソース変更通知を作成します。 |
| DeleteNotificationConfiguration | Auto Scaling のスケーリングイベントおよびリソース変更通知を削除します | Auto Scaling のスケーリングイベントおよびリソース変更通知を削除します。 |
| ModifyNotificationConfiguration | Auto Scaling イベントおよびリソース変更の通知を変更します | Auto Scaling イベントおよびリソース変更の通知を変更します。 |
| DescribeNotificationConfigurations | オート スケーリング イベントおよびリソース変更通知を照会します | 作成したオート スケーリング イベントおよびリソース変更通知を照会します。 |
| DescribeNotificationTypes | Auto Scaling イベントおよびリソース変更通知のタイプを照会します | Auto Scaling イベントおよびリソース変更通知のタイプを照会します。 |
インスタンス
|
API |
タイトル |
説明 |
| SetInstancesProtection | スケーリンググループ内の ECS インスタンスの保護を開始または停止します | スケーリンググループ内の 1 つ以上の ECS インスタンスの保護を開始または停止します。 |
| SetInstanceHealth | スケーリンググループ内の ECS インスタンスのヘルスステータスを設定します | スケーリンググループ内の ECS インスタンスのヘルスステータスを設定します。 |
| EnterStandby | スケーリンググループ内の ECS インスタンスをスタンバイ状態に設定します | スケーリンググループ内の ECS インスタンスをスタンバイ状態に設定します。 |
| ExitStandby | スタンバイインスタンスを実行中の状態に移行 | スケーリンググループ内のスタンバイ状態のECSインスタンスを実行中の状態に移行します。 |
| RebalanceInstances | ECS インスタンスのディストリビューションをリバランスします | マルチゾーンスケーリンググループ内のゾーン間で ECS インスタンスのディストリビューションをリバランスします。 |
リージョン
|
API |
タイトル |
説明 |
| DescribeRegions | Auto Scaling が利用可能なリージョンを照会します | Auto Scaling が利用可能なリージョンを照会します。 |
タグ
|
API |
タイトル |
説明 |
| ListTagResources | ListTagResources | 1 つ以上の弾力的スケーリングリソースに付与されたラベルを照会します。 |
| ListTagKeys | Auto Scalingリソースのタグキーの照会 | Auto Scalingリソースのタグキーのリストを照会します。 |
| ListTagValues | タグキーによる Auto Scaling リソースのタグ値を照会します | Auto Scaling リソースのタグキーに対応するタグ値を照会します。 |
| TagResources | TagResources | 指定されたAuto Scalingリソースのリストにタグを作成してバインドします。 |
| UntagResources | 指定された Auto Scaling リソースからタグをバインド解除します | タグがバインド解除された後、そのタグが他のリソースにバインドされていない場合、タグは自動的に削除されます。 |
アラート
|
API |
タイトル |
説明 |
| CreateAlarm | イベントトリガータスクを作成します | イベントトリガータスクを作成します。 |
| DeleteAlarm | イベントトリガータスクの削除 | イベントトリガータスクを削除します。 |
| DisableAlarm | イベントトリガータスクを無効にします | イベントトリガータスクを無効にします。 |
| EnableAlarm | イベントトリガータスクを有効にします | イベントトリガータスクを有効にします。 |
| ModifyAlarm | ModifyAlarm | イベントトリガータスクを変更します。 |
| DescribeAlarms | イベントトリガータスク情報の照会 | イベントトリガータスクの情報を照会します。 |
その他
|
API |
タイトル |
説明 |
| AttachAlbServerGroups | 1 つ以上の ALB サーバーグループを追加します | 1 つ以上の Application Load Balancer (ALB) サーバーグループをスケーリンググループに追加します。 |
| CreateEciScalingConfiguration | スケーリング設定の作成 | Elastic Container Instance（ECI）タイプのスケーリング設定を作成します。 |
| DeleteEciScalingConfiguration | スケーリング設定を削除します | Elastic Container Instance (ECI) タイプのスケーリング設定を削除します。 |
| DescribeEciScalingConfigurations | スケーリング設定情報のクエリ | ECIタイプのスケーリング設定をクエリします。 |
| DetachAlbServerGroups | 1つ以上のALBサーバーグループの削除 | スケーリンググループから1つ以上のApplication Load Balancer（ALB）サーバーグループを削除します。 |
| ModifyEciScalingConfiguration | スケーリング設定を変更します | Elastic Container Instance（ECI）タイプのスケーリング設定を変更します。 |
| ScaleWithAdjustment | 指定された調整ルールに基づいて弾力的スケーリングをトリガーします | 指定された調整ルールに基づいて弾力的スケーリングをトリガーします。 |
| ChangeResourceGroup | スケーリンググループのリソースグループを変更します | スケーリンググループをリソースとしてリソースグループに追加します。 |
| AttachServerGroups | 1 つ以上の負荷分散サーバーグループを追加します | 1 つ以上の負荷分散サーバーグループをスケーリンググループに追加します。サポートされるサーバーグループタイプには、Application Load Balancer (ALB) および Network Load Balancer (NLB) が含まれます。 |
| DetachServerGroups | 1 つ以上のロードバランシングサーバーグループを削除します | スケーリンググループから 1 つ以上のロードバランシングサーバーグループを削除します。サポートされるサーバーグループタイプには、Application Load Balancer (ALB) および Network Load Balancer (NLB) が含まれます。 |
| ModifyInstanceAttribute | スケーリンググループ内の ECS インスタンスの部分的な情報を変更します | スケーリンググループ内の ECS インスタンスの部分的な情報を変更します。現在、スケーリンググループに手動で追加されたインスタンスのライフサイクル管理プロパティのみを変更済みにでき、Auto Scaling がスケーリンググループ内の ECS インスタンスをより柔軟に管理できるようにします。 |
| DescribePatternTypes | DescribePatternTypes | インスタンス属性ベースのメソッドを使用してスケーリング設定を構成する際に、DescribePatternTypes API を呼び出して、vCPU コア数、メモリサイズ、インスタンスファミリーレベル、最大許容価格などの指定されたインスタンス属性に基づいて、条件に合うインスタンスタイプをフィルターします。 |
| ApplyScalingGroup | ApplyScalingGroup | 設定ファイルを使用して ECI ベースのスケーリンググループを作成および管理します。ApplyScalingGroup 操作を呼び出してこの特徴を実装できます。 |
| ModifyAlertConfiguration | ModifyAlertConfiguration | スケーリングアクティビティが成功、失敗、または拒否された場合、Auto Scaling は SMS またはメールで通知を送信できます。通知を受信した後、関連するイベントをハンドルする必要があります。ModifyAlertConfiguration 操作を呼び出して、スケーリンググループで SMS およびメール通知を送信するスケーリングアクティビティのステータスを設定できます。これにより、スケーリングアクティビティの変更を把握し、迅速に対応してスケーリング効率を向上させることができます。 |
| DescribeAlertConfiguration | DescribeAlertConfiguration | スケーリングアクティビティが成功、失敗、または拒否された場合、Auto Scaling は SMS またはメールで通知を送信できます。通知を受信した後、関連するイベントをハンドルする必要があります。DescribeAlertConfiguration 操作を呼び出して、スケーリンググループで SMS およびメール通知が送信されるスケーリングアクティビティのステータスをクエリできます。これにより、スケーリングアクティビティの変更を把握し、迅速に対応してスケーリング効率を向上させることができます。 |
| SuspendInstanceRefresh | SuspendInstanceRefresh | 実行中のインスタンスリフレッシュタスクを一時停止します。構成に問題がある可能性があるがロールバックが必要かどうか不明な場合、この操作を呼び出してインスタンスリフレッシュタスクを一時停止し、構成が正しいかどうかを確認できます。 |
| ResumeInstanceRefresh | ResumeInstanceRefresh | 一時停止状態のインスタンスリフレッシュタスクを再開します。 |
| CancelInstanceRefresh | CancelInstanceRefresh | インスタンスリフレッシュタスクをキャンセルします。スケールアウト中にすでに置き換えられた、または追加されたインスタンスは保持されます。 |
| DescribeInstanceRefreshes | DescribeInstanceRefreshes | スケーリンググループのインスタンスリフレッシュタスクを照会します。各タスクの基本情報と進捗状況を含みます。 |
| RollbackInstanceRefresh | インスタンスリフレッシュタスクをロールバックします | 実行中のインスタンスリフレッシュタスクをロールバックします。インスタンスリフレッシュタスクの実行中に、目的の構成が要件を満たさなくなった場合、この操作を呼び出してタスクをロールバックできます。ロールバック中、システムはスケーリンググループの現在アクティブな構成に基づいて新しいインスタンスを作成し、目的の構成に基づいて作成されたインスタンスを置き換えます。 |
| StartInstanceRefresh | StartInstanceRefresh | スケーリンググループ内のインスタンスに新しいスケーリング設定を適用したり、使用するイメージを更新したりする必要がある場合に、スケーリンググループ内のインスタンスをリフレッシュします。 |