CLI authentication

Available in Classic and VPC

This section describes how to set up the API authentication key.

Set API authentication key

An API authentication key must be set up first to use CLI.

Entering the ncloud configure command will allow the input of Access Key and Secret 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) []: 

Each API authentication key is saved as a configure file under the user environment home directory's .ncloud folder. If the API authentication key has been entered properly, then the command will be executed successfully. If the entered API authentication key is not valid, then the following message will be displayed.

./ncloud server getRegionList
Invalid consumerKey

If the authentication key value is valid, then the following result is displayed when running getZoneList.

./ncloud server getZoneList --regionNo 1

{
  "getZoneListResponse": {
    "zoneList": [
      {
        "zoneNo": "3",
        "zoneName": "KR-2",
        "zoneCode": "KR-2",
        "zoneDescription": "Pyeongchon zone",
        "regionNo": "1"
      },
      {
        "zoneNo": "2",
        "zoneName": "KR-1",
        "zoneCode": "KR-1",
        "zoneDescription": "Gasan zone",
        "regionNo": "1"
      }
    ],
    "requestId": "07a42c32-d1f9-430d-b658-1078f2f3bb81",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Profile setup

Use a profile to manage credentials for multiple accounts. If you do not specify the --profile option, the default (DEFAULT) credentials are used.

To add a profile, specify the --profile option with the ncloud configure command.

./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) []: 

Specify the profile to use with the --profile option when running the command.

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