すべてのプロダクト
Search
ドキュメントセンター

Apsara File Storage NAS:CLI統合の例

最終更新日:Sep 29, 2024

Alibaba Cloudコマンドラインインターフェイス (CLI) は、APIに基づいて開発された汎用のコマンドラインツールです。 Alibaba Cloud CLIを使用して、Apsara 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アカウントには、すべてのAPI操作を呼び出す権限があります。 Alibaba Cloudアカウントを使用して操作を実行することは、リスクの高い操作です。 RAM (Resource Access Management) ユーザーとしてAPI操作を呼び出すか、ルーチンのO&Mを実行することを推奨します。 AliyunNASFullAccessポリシーをRAMユーザーにアタッチする必要があります。

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

  1. RAMユーザーを作成し、ビジネス要件に基づいてAlibaba Cloudサービスを管理する権限を付与します。 詳細については、「RAMユーザーの作成」および「RAMユーザーへの権限付与」をご参照ください。

  2. RAMユーザーのAccessKeyペアを作成し、その後のID資格情報の設定のためにAccessKey IDAccessKey secretを記録します。 詳細については、「AccessKeyペアの作成」をご参照ください。

  3. リージョンIDを指定します。 Alibaba Cloud CLIは、指定されたリージョンでAPI操作を呼び出します。 使用可能なリージョンの詳細については、「エンドポイント」をご参照ください。

  4. RAMユーザーのAccessKeyペアを使用して、AkProfileという名前の設定ファイルでID資格情報を設定します。 詳細については、「設定例」をご参照ください。

CLIコマンドの生成

  1. [OpenAPIポータル]にログインして[ネットワーク接続ストレージ] をクリックします。

  2. APIデバッグページの左側の検索ボックスで、呼び出すAPI操作を検索します。 API操作の [パラメーター] タブで、API参照に基づいてパラメーターを指定します。 [パラメーター] タブの右側にある [CLIの例] タブをクリックして、指定したパラメーターを含む生成されたサンプルコマンドを表示します。

    image

    • [コマンドの実行] アイコンをクリックしてCloud Shellを起動し、Cloud Shellでコマンドをデバッグします。

    • [コピー] アイコンをクリックして、サンプルコマンドをクリップボードにコピーします。 サンプルコマンドを実行するには、サンプルコマンドをシェルツールに貼り付けることができます。

      • CLIコマンドをコピーしてローカルシェルに貼り付けるときは、パラメーターの形式に注意してください。 Alibaba Cloud CLIのパラメーター形式の詳細については、「パラメーター形式」をご参照ください。

      • デフォルトでは、OpenAPI Explorerで生成されるサンプルコマンドに -- regionオプションが追加されます。 コマンドをシェルツールにコピーすると、Alibaba Cloud CLIはデフォルトの資格情報設定と環境変数設定のリージョン情報を無視し、指定されたリージョンで優先的にコマンドを実行します。 このオプションは、ビジネス要件に基づいて削除または保持できます。

Alibaba Cloud CLIを使用したNAS API操作の呼び出し

構文

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

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

コマンドオプション

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

  • -- profile <profileName>: -- profileオプションとそのパラメーターprofileNameを使用して設定プロファイルを指定すると、Alibaba Cloud CLIはデフォルトのID資格情報と環境変数の設定を無視し、指定した設定を使用してコマンドを実行します。

  • -- help: -- helpオプションを指定して、コマンドに関するヘルプ情報を取得できます。 詳細については、「ヘルプコマンドの使用」をご参照ください。

説明

次の例では、コマンドはWindowsのコマンドプロンプトで実行されます。 コマンドのパラメータ形式は、他のオペレーティングシステムによって異なります。 Alibaba Cloud CLIのパラメーター形式の詳細については、「パラメーター形式」をご参照ください。

  • 例1: Alibaba Cloud CLIを使用してNASのCreateFileSystem操作を呼び出し、従量課金制の汎用容量ネットワークファイルシステム (NFS) ファイルシステムを作成します。

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

      aliyun nas CreateFileSystem --FileSystemType standard --ChargeType PayAsYouGo --StorageType Capacity --ProtocolType NFS
    2. コマンド出力を表示します。

      {
              "FileSystemId": "6a2464****",
              "RequestId": "3879AB9C-1DED-5A49-A015-350138B23BF0"
      }
  • 例2: Alibaba Cloud CLIを使用してNASのCreateAccessGroup操作を呼び出し、vpc_testという名前の権限グループを作成します。

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

      aliyun nas CreateAccessGroup --AccessGroupName vpc_test --AccessGroupType Vpc
    2. コマンド出力を表示します。

      {
              "AccessGroupName": "vpc_test",
              "RequestId": "95CB3005-C251-5E11-A949-29CB2C7A9C54"
      }
説明

NASのAPI操作を呼び出した後にエラーが返された場合は、返されたエラーコードに基づいて、リクエストパラメーターとその値が有効かどうかを確認する必要があります。

OpenAPIの問題診断ページで返されたリクエストIDまたはSDKエラー情報に基づいて、セルフサービス診断を実行することもできます。。