Alibaba Cloud CLI を使用した Auto Scaling の管理 - Auto Scaling

Alibaba Cloud コマンドラインインターフェイス (CLI) を使用すると、ターミナルから直接 Auto Scaling の API オペレーションを呼び出せます。これにより、リソース管理のスクリプト化および自動化が容易になります。本ページでは、設定手順を説明し、DescribeScalingActivities を用いた実行例を紹介します。

前提条件

開始する前に、以下の条件を満たしていることを確認してください。

Alibaba Cloud アカウント
必要な権限を持つ RAM ユーザー（ステップ 2 で作成）

ステップ 1：Alibaba Cloud CLI のインストール

以下のいずれかの方法を選択してください。

オプション A：Cloud Shell を使用（インストール不要）

Cloud Shell には Alibaba Cloud CLI がプリインストール済みであり、ご利用の認証情報で自動的に構成されています。Cloud Shell を使用すると、CLI コマンドを即座に実行したり、ローカル環境で実行する前にコマンドをテストしたりできます。

詳細については、「Cloud Shell とは」をご参照ください。

オプション B：ローカルにインストール

Alibaba Cloud CLI をローカルマシンにインストールします。ご利用のオペレーティングシステムに対応するガイドを選択してください。

ステップ 2：Alibaba Cloud CLI の構成

重要

Alibaba Cloud アカウント (root ユーザー) はすべてのサービスに対して完全なアクセス権限を持ちます。セキュリティリスクを低減するため、RAM ユーザーを作成し、必要最小限の権限のみを付与したうえで、そのユーザーの認証情報を用いて API オペレーションを呼び出してください。Auto Scaling のポリシーに関する詳細は、「Auto Scaling のシステムポリシー」および「Auto Scaling のカスタムポリシー」をご参照ください。

API 呼び出しを行う前に、認証情報とリージョンを構成してください。Alibaba Cloud CLI では複数の認証情報タイプがサポートされています。以下に示す手順では、自動化用途で最も一般的な方法である、RAM ユーザーの AccessKey ペアを用いた認証方式を採用します。

RAM ユーザーを作成し、AccessKey ペアを生成します。「RAM ユーザーの作成」および「AccessKey ペアの作成」をご参照ください。
RAM ユーザーに AliyunESSReadOnlyAccess ポリシーをアタッチします。これにより、Auto Scaling に対する読み取り専用アクセス権限が付与されます。「RAM ユーザーへの権限付与」をご参照ください。
Auto Scaling リソースが配置されているリージョン ID を特定します。対応リージョンの一覧については、「エンドポイント」をご参照ください。
説明
各コマンドで特定のリージョンを指定するには、--region オプションを使用します。このオプションは、デフォルトの認証情報構成および環境変数による設定の両方をオーバーライドします。「API 呼び出しのコマンドラインオプション」をご参照ください。
RAM ユーザーの AccessKey ペアを用いて、AkProfile という名前の AccessKey 認証情報プロファイルを構成します。「構成例」をご参照ください。

STS 一時認証情報などの他の認証情報タイプについては、「認証情報の種類」をご参照ください。

ステップ 3：CLI コマンドの生成

OpenAPI Explorer を使用すると、任意の Auto Scaling API オペレーションに対応する実行可能な CLI コマンドを自動生成できます。

OpenAPI Explorer で DescribeScalingActivities ページを開きます。
パラメーター タブでパラメーターを入力します。その後、CLI の例 タブをクリックして、生成されたコマンドを確認します。
コマンドをコピーまたは実行します。
- をクリックしてコマンドをクリップボードにコピーします。その後、ローカルシェルに貼り付けて実行するか、自動化スクリプトに追加してください。
- をクリックして Cloud Shell を開き、ブラウザ上で直接コマンドを実行します。
説明
ローカルでコマンドを実行する場合、入力パラメーター値が Alibaba Cloud CLI が期待するフォーマットと一致していることを確認してください。「パラメーターのフォーマット」をご参照ください。デフォルトで、OpenAPI Explorer は生成されたコマンドに --region を含めます。ご使用の構成に応じて、このオプションを保持または削除してください。

ステップ 4：Auto Scaling API の呼び出し

説明

Alibaba Cloud CLI には、以前の Auto Scaling API バージョンが含まれています。現在のバージョン (2022-02-22) を使用するには、コマンドで常に --force と --version 2022-02-22 を渡してください。OpenAPI Explorer は、コマンドを生成する際にこれらのオプションを自動的に追加します。詳細については、「機能ごとの操作リスト」をご参照ください。

以下の例では、DescribeScalingActivities を呼び出して、スケーリングアクティビティの詳細を取得します。「DescribeScalingActivities」で、全パラメーターのリファレンスをご確認ください。

コマンドを実行します。

aliyun ess DescribeScalingActivities --RegionId 'cn-hangzhou' --ScalingGroupId 'asg-bp18p2yfxow2dloq****' --version 2022-02-22 --method POST --force

正常な応答の例を以下に示します。

{
  "RequestId": "CC107349-57B7-4405-B1BF-9BF5AF7F****",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "ScalingActivities": [
    {
      "Progress": 100,
      "ScalingInstanceNumber": 1,
      "AttachedCapacity": "0",
      "TotalCapacity": "2",
      "ScalingGroupId": "asg-bp18p2yfxow2dloq****",
      "AutoCreatedCapacity": "2",
      "EndTime": "2020-09-10T09:54Z",
      "StartTime": "2020-09-10T09:54Z",
      "Description": "ECS インスタンス \"1\" 台を追加",
      "StatusCode": "Successful",
      "Cause": "ユーザーがスケーリングルール \"asr-bp12tcnol686y1ik****\" の実行を要求し、合計容量を \"1\" から \"2\" へ変更しました。",
      "ScalingActivityId": "asa-bp161xudmuxdzofe****",
      "StatusMessage": "\"1\" 台の ECS インスタンスが追加されました",
      "CreatedCapacity": 1,
      "DestroyedCapacity": 1,
      "StartedCapacity": 1,
      "StoppedCapacity": 1,
      "CreatedInstances": [
        "[\"i-abc1\",\"i-abc2\"]"
      ],
      "DestroyedInstances": [
        "[\n      \"i-abc1\",\n      \"i-abc2\"\n]"
      ],
      "StartedInstances": [
        "[\n      \"i-abc1\",\n      \"i-abc2\"\n]"
      ],
      "StoppedInstances": [
        "[\n      \"i-abc1\",\n      \"i-abc2\"\n]"
      ],
      "ErrorCode": "OperationDenied.NoStock",
      "ErrorMessage": "指定された ECS リソースは、このリージョンで在庫切れです。しばらくしてから再度お試しください。",
      "Detail": "\"新しい ECS インスタンス \"i-j6c8ilerw, i-j6c8iler4mx\" が作成されました。\"",
      "TriggerSourceType": "Api",
      "TriggerSourceId": "2346366580*****",
      "LifecycleHookContext": {
        "DisableLifecycleHook": false,
        "IgnoredLifecycleHookIds": [
          "ash-bp14zolna43z266bq***\n"
        ]
      },
      "ActivityMetadata": "{\"goatscaler.io/managed\":\"true\"}",
      "InstanceRefreshTaskId": "ir-asdf12adsxg*****"
    }
  ]
}

応答でエラーが返された場合は、入力パラメーターと値がエラーコードの説明と一致していることを確認してください。リクエスト ID またはエラー情報を使用したセルフサービス診断については、「OpenAPI の問題診断」をご参照ください。

次のステップ

利用可能なすべての Auto Scaling API オペレーションを参照する: 機能別の操作一覧
Alibaba Cloud CLI の機能について学ぶ：「Alibaba Cloud CLI とは」