Alibaba Cloud Command Line Interface (CLI) は、API に基づいて開発された汎用コマンドラインツールです。 Alibaba Cloud CLI を使用すると、シェルツールを使用して File Storage NAS (NAS) と対話し、NAS リソースを管理できます。 このトピックでは、Alibaba Cloud CLI を使用して NAS の 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 のインストールパッケージを選択してください。 詳細については、次のトピックをご参照ください。
また、Alibaba Cloud が提供する Cloud Shell を使用して、Alibaba Cloud CLI で実行したいコマンドをデバッグすることもできます。 Cloud Shell の詳細については、「Cloud Shell とは」をご参照ください。
Alibaba Cloud CLI の設定
Alibaba Cloud アカウント (root ユーザー) は、すべての API オペレーションを呼び出す権限を持っています。 Alibaba Cloud アカウント (root ユーザー) を使用した操作は高リスク操作です。 API オペレーションの呼び出しや日常の O&M は、Resource Access Management (RAM) ユーザーとして実行することを推奨します。 RAM ユーザーには、AliyunNASFullAccess ポリシーをアタッチする必要があります。
Alibaba Cloud CLI を使用する前に、Alibaba Cloud CLI で認証情報やリージョン ID などのクレデンシャル情報を設定する必要があります。 Alibaba Cloud CLI は、さまざまな認証情報をサポートしています。 詳細については、「認証情報の種類」をご参照ください。 この例では、AccessKey 認証情報を使用します。 次のステップを実行します。
RAM ユーザーを作成し、ビジネス要件に基づいて Alibaba Cloud サービスを管理する権限を付与します。 詳細については、「RAM ユーザーの作成」および「RAM ユーザーの権限管理」をご参照ください。
RAM ユーザーの AccessKey ペアを作成し、その後の認証情報の設定のために
AccessKey IDとAccessKey Secretを記録します。 詳細については、「AccessKey の作成」をご参照ください。-
リージョン ID を指定します。 Alibaba Cloud CLI は、指定されたリージョンで API オペレーションを呼び出します。 利用可能なリージョンの詳細については、「エンドポイント」をご参照ください。
RAM ユーザーの AccessKey ペアを使用して、
AkProfileという名前の設定ファイルで認証情報を設定します。 詳細については、「認証情報の設定と管理」をご参照ください。
CLI コマンドの生成
-
OpenAPI Portal にログインします。
-
API デバッグページでは、左側の [検索ボックス] で使用したい API を検索できます。 [パラメーター設定] セクションで、API ドキュメントに従ってパラメーターを入力し、[パラメーター設定] の右側にある [CLI の例] タブをクリックして、パラメーター付きのコマンド例を生成します。
-
[コマンドの実行] をクリックして Cloud Shell を開き、コマンドを迅速にデバッグします。
-
[コピー] をクリックしてコマンド例をクリップボードにコピーします。 その後、ローカルのシェルツールに貼り付けて実行できます。
CLI コマンドをローカルシェルにコピーして貼り付ける際は、パラメーターフォーマットに注意してください。 Alibaba Cloud CLI のパラメーターフォーマットの詳細については、「コマンドパラメーターについて」をご参照ください。
デフォルトでは、OpenAPI Explorer で生成されるサンプルコマンドには
--regionオプションが追加されます。 コマンドをシェルツールにコピーすると、Alibaba Cloud CLI はデフォルトの認証情報設定と環境変数設定のリージョン情報を無視し、指定されたリージョンでコマンドを優先的に実行します。 ビジネス要件に応じて、このオプションを削除または保持できます。
-
Alibaba Cloud CLI を使用した NAS API オペレーションの呼び出し
構文
Alibaba Cloud CLI では、次の構文を使用してコマンドを実行できます。 詳細については、「OpenAPI Explorer を使用した CLI コマンドの生成と実行」をご参照ください。
aliyun <command> <subcommand> [options and parameters]
コマンドオプション
Alibaba Cloud CLI を使用する場合、コマンドオプションを指定してコマンドの動作を変更したり、コマンドの拡張機能を利用したりできます。 よく使用されるコマンドオプションは次のとおりです。
--profile<profileName>:--profileオプションとそのパラメーターprofileNameを使用して設定プロファイルを指定すると、Alibaba Cloud CLI はデフォルトの認証情報と環境変数の設定を無視し、指定した設定を使用してコマンドを実行します。--help:--helpオプションを指定すると、コマンドのヘルプ情報を取得できます。 詳細については、「ヘルプコマンドの使用」をご参照ください。
例
次の例では、コマンドは Windows のコマンドプロンプトで実行されます。 コマンドのパラメーターフォーマットは、他のオペレーティングシステムでは異なります。 Alibaba Cloud CLI のパラメーターフォーマットの詳細については、「コマンドパラメーターについて」をご参照ください。
例 1:Alibaba Cloud CLI を使用して NAS の
CreateFileSystemオペレーションを呼び出し、従量課金の汎用容量型ネットワークファイルシステム (NFS) ファイルシステムを作成します。次のコマンドを実行します。
aliyun nas CreateFileSystem --FileSystemType standard --ChargeType PayAsYouGo --StorageType Capacity --ProtocolType NFSコマンドの出力を表示します。
{ "FileSystemId": "6a2464****", "RequestId": "3879AB9C-1DED-5A49-A015-350138B23BF0" }
例 2:Alibaba Cloud CLI を使用して NAS の
CreateAccessGroupオペレーションを呼び出し、vpc_testという名前の権限グループを作成します。次のコマンドを実行します。
aliyun nas CreateAccessGroup --AccessGroupName vpc_test --AccessGroupType Vpcコマンドの出力を表示します。
{ "AccessGroupName": "vpc_test", "RequestId": "95CB3005-C251-5E11-A949-29CB2C7A9C54" }
NAS の API オペレーションを呼び出した後にエラーが返された場合は、返されたエラーコードに基づいて、リクエストパラメーターとその値が有効かどうかを確認する必要があります。
また、応答から得られた RequestID または SDK エラーメッセージを OpenAPI Diagnostic Platform で使用して、問題を診断することもできます。