CLI統合の例 - CloudMonitor - Alibaba Cloud ドキュメントセンター

Alibaba Cloudコマンドラインインターフェイス (CLI) は、APIに基づいて開発された汎用のコマンドラインツールです。 Alibaba Cloud CLIを使用して、CloudMonitorの自動管理とメンテナンスを実装できます。このトピックでは、Alibaba Cloud CLIを使用してCloudMonitor API操作を呼び出す方法について説明します。

始める前に

Alibaba Cloud CLIに慣れてください。詳細については、「Alibaba Cloud CLI の概要」をご参照ください。

Alibaba Cloud CLIのインストール

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIをインストールする必要があります。 Alibaba Cloud CLIは、Windows、Linux、およびmacOSオペレーティングシステムにインストールできます。デバイスのオペレーティングシステムに基づいて、Alibaba Cloud CLIのインストールパッケージを選択します。詳細については、以下のトピックをご参照ください。

Windows: WindowsにAlibaba Cloud CLIをインストール
Linux: LinuxにAlibaba Cloud CLIをインストール
macOS: macOSにAlibaba Cloud CLIをインストール

Alibaba Cloudが提供するCloud Shellを使用して、Alibaba Cloud CLIで実行するコマンドをデバッグすることもできます。 Cloud Shellの詳細については、Cloud Shellとは

Alibaba Cloud CLI の設定

重要

Alibaba Cloudアカウントには、すべてのAlibaba CloudサービスのAPIを管理およびアクセスする権限があります。 Alibaba Cloudアカウントを使用してAPI操作を呼び出すと、セキュリティリスクが発生する可能性があります。 RAM (Resource Access Management) ユーザーを作成して使用し、API操作を呼び出したり、通常のO&M操作を実行したりすることを推奨します。 AliyunCloudMonitorFullAccessポリシーをRAMユーザーにアタッチする必要があります。

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIでID資格情報やリージョンIDなどの資格情報を設定する必要があります。 Alibaba Cloud CLIは、さまざまなタイプのID資格情報をサポートしています。詳細については、「資格情報の種類」をご参照ください。この例では、AccessKey資格情報が使用されます。以下の手順を実行します。

RAMユーザーを作成し、ビジネス要件に基づいてAlibaba Cloudサービスを管理する権限を付与します。詳細については、「RAMユーザーの作成」および「RAMユーザーへの権限付与」をご参照ください。
RAMユーザーのAccessKeyペアを作成し、その後のID資格情報の設定のためにAccessKey IDとAccessKey secretを記録します。詳細については、「AccessKeyペアの作成」をご参照ください。
リージョンIDを指定します。 Alibaba Cloud CLIは、指定されたリージョンでAPI操作を呼び出します。使用可能なリージョンの詳細については、「エンドポイント」をご参照ください。
説明
Alibaba Cloud CLIを使用する場合、-- regionオプションを使用して、呼び出しを開始するリージョンを指定できます。このオプションを指定すると、Alibaba Cloud CLIはデフォルトの資格情報設定と環境変数設定のリージョン情報を無視します。詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。
RAMユーザーのAccessKeyペアを使用して、AkProfileという名前の設定ファイルでID資格情報を設定します。詳細については、「設定例」をご参照ください。

CLIコマンドの生成

にログインします。 OpenAPIポータルをクリックし、Cloud Monitorをクリックします。
APIデバッグページの左側の検索ボックスで、呼び出すAPI操作を検索します。 API操作の [パラメーター] タブで、API参照に基づいてパラメーターを指定します。 [パラメーター] タブの右側にある [CLIの例] タブをクリックして、指定したパラメーターを含む生成されたサンプルコマンドを表示します。
- [コマンドの実行] アイコンをクリックしてCloud Shellを起動し、Cloud Shellでコマンドをデバッグします。
- [コピー] アイコンをクリックして、サンプルコマンドをクリップボードにコピーします。サンプルコマンドを実行するには、サンプルコマンドをシェルツールに貼り付けることができます。
  - CLIコマンドをコピーしてローカルシェルに貼り付けるときは、パラメーターの形式に注意してください。 Alibaba Cloud CLIのパラメーター形式の詳細については、「パラメーター形式」をご参照ください。
  - デフォルトでは、OpenAPI Explorerは、生成されたCLIコマンドに -- regionオプションを追加します。コマンドをシェルツールにコピーすると、Alibaba Cloud CLIはデフォルトの資格情報設定と環境変数設定のリージョン情報を無視し、オプションで指定されたリージョンでコマンドを優先的に実行します。ビジネス要件に基づいてオプションを削除または保持できます。

サービスのAPI操作の呼び出し

構文

Alibaba Cloud CLIでは、次の構文を使用してコマンドを実行できます。詳細は、「構文」をご参照ください。

aliyun <command> <subcommand> [options and parameters]

コマンドオプション

Alibaba Cloud CLIを使用する場合、コマンドオプションを指定して、コマンドの動作を変更したり、コマンドの拡張機能を実装したりできます。次のコマンドオプションがよく使用されます。

-- profile <profileName>: -- profileオプションとprofileNameパラメーターを使用して、構成プロファイルを指定できます。有効な構成プロファイルを指定すると、Alibaba Cloud CLIはデフォルトの認証情報設定と環境変数設定の情報を無視し、指定した設定を優先的に使用してコマンドを実行します。
-- help: -- helpオプションを指定して、コマンドに関するヘルプ情報を取得できます。詳細については、「ヘルプコマンドの使用」をご参照ください。

詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。

例

例1: 次のサンプルコードでは、-- helpオプションを使用して、Alibaba Cloud CLIでサポートされているCloud Monitor API操作のリストを取得する方法について説明します。また、関数別の操作の一覧で呼び出すことができるAPI操作を表示することもできます。

以下のコマンドを実行します。
```
aliyun cms --help
```
コマンド出力を表示します。

例2: 次のサンプルコードは、Alibaba Cloud CLIを使用してCloud MonitorのCreateMonitorGroup操作を呼び出し、ECS_groupという名前のアプリケーショングループを作成する方法を説明しています。

以下のコマンドを実行します。

aliyun cms CreateMonitorGroup -- GroupName ECS_Group -- ContactGroups ECS_Alert_Group

コマンド出力を表示します。
```
{
    "Code": 200,
    "GroupId": 238918447,
    "RequestId": "6512EB11-5BF6-5504-A1Ad-B4451E2E15D2",
    "Success": true
}
```
説明
CloudMonitorのAPI操作を呼び出した後にエラーが返された場合は、返されたエラーコードに基づいてリクエストパラメーターと値が有効かどうかを確認する必要があります。
返されたリクエストIDまたはSDKエラー情報に基づいて、セルフサービス診断を実行することもできます。 OpenAPIの問題診断ページ。