CLIの認証

Prev Next

Classic/VPC環境で利用できます。

API認証キーを設定する方法を説明します。

API認証キーの設定

CLIを使用するには、まず API認証キーを設定する必要があります。

参考

API認証キーの詳細は、APIガイドをご参照ください。

ncloud configureコマンドを入力すると、Access KeySecret Keyを入力できるようになります。

./ncloud configure
set [DEFAULT]'s configuration.
Ncloud Access Key ID []: <access-key>
Ncloud Secret Access Key []: <secret-key>
Ncloud API URL (default:https://ncloud.apigw.ntruss.com) []: 

各 API認証キーは、ユーザー環境ホームディレクトリの.ncloudフォルダに Configureファイルの形式で保存されます。API認証キーを問題なく入力すると、コマンドが正常に実行されます。入力した API認証キーが有効でない場合、次のようなメッセージが表示されます。

./ncloud server getRegionList
Invalid consumerKey

認証キーが有効な場合、Zoneリスト出力を実行すると次のような結果が表示されます。

./ncloud server getZoneList --regionNo 1
{
  "getZoneListResponse": {
    "zoneList": [
      {
        "zoneNo": "3",
        "zoneName": "KR-2",
        "zoneCode": "KR-2",
        "zoneDescription": "坪村ゾーン",
        "regionNo": "1"
      },
      {
        "zoneNo": "2",
        "zoneName": "KR-1",
        "zoneCode": "KR-1",
        "zoneDescription": "加山ゾーン",
        "regionNo": "1"
      }
    ],
    "requestId": "07a42c32-d1f9-430d-b658-1078f2f3bb81",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

プロファイルの設定

複数のアカウントの認証情報を管理するには、プロファイルを使用します。--profileオプションを指定しない場合、デフォルト(DEFAULT)の認証情報が使用されます。

プロファイルを追加するには、ncloud configureコマンドに--profileオプションを指定します。

./ncloud configure --profile <profile-name>
set [<profile-name>]'s configuration.
Ncloud Access Key ID []: <access-key>
Ncloud Secret Access Key []: <secret-key>
Ncloud API URL (default:https://ncloud.apigw.ntruss.com) []: 

コマンドを実行する際、--profileオプションで使用するプロファイルを指定します。

./ncloud server getZoneList --regionNo 1 --profile <profile-name>