Server Code の設置

Server Code を Kii Cloud に設置するには以下のコマンドを実行します。

node bin/kii-servercode.js deploy-file \
  --file ../demo.js \
  --site jp \
  --app-id <your_app_id> \
  --app-key <your_app_key> \
  --client-id <your_client_id> \
  --client-secret <your_client_secret> \
  --environment-version <engine_version> \
  --hook-config <hook_file> \
  --set-current

指定可能なオプションは次のとおりです。

  • --file：設置する Server Code
  • --site：サーバーの設置場所（jp）
  • --app-id：AppID
  • --app-key：任意の値
  • --client-id：ClientID
  • --client-secret：ClientSecret

  • --environment-version： Server Code を実行する際に使用する JavaScript エンジンのバージョンを指定します（JavaScript エンジンの詳細は JavaScript エンジン を参照してください）。<engine_version> には 16 を設定することを推奨します。省略時はデフォルトの JavaScript エンジンが使用されますが、省略は非推奨であることがコンソールに出力されます。

    値 バージョン 備考
    6 Node.js 6.X デフォルト値
    16 Node.js 16.X 推奨値 (今後こちらがデフォルト値になる予定)

  • --token：（省略可）管理者トークン。ClientID と ClientSecret の代わりとして利用可能です。

  • --hook-config：（省略可）Server Hook 設定ファイル（設定ファイルの書き方は Server Hook 設定ファイル を参照してください）。手動実行だけで使用する場合は省略可能です。

  • --http-proxy： （省略可）使用する HTTP プロクシ（例：https://my.proxy:8080 ）。ファイアウォールの内側など直接 Kii Cloud API にアクセスできない場合に利用します。

  • --set-current：（省略可）設置する Server Code を実行対象バージョンとして有効化します。省略した場合は設置する Server Code は有効化されず、現在の実行対象バージョンが有効なまま維持されます（バージョン管理の詳細は Server Code のバージョン管理 を参照してください）。

必ず開発者ポータルで取得した値を --site、--app-id、--app-key、--client-id および -- client-secret に設定するようにしてください（取得方法については コマンド実行に必要なパラメーター を参照してください）。また ClientID と ClientSecret を指定する代わりに、アプリ管理者トークンを --token オプションで指定することもできます（アプリ開発者トークンの取得方法は アプリ管理者向け機能 を参照してください）。

Server Code が正しく設置されると、Kii Cloud は以下のようにこのコードに割り当てられたバージョンを返します。

6 Feb 18:08:37 - Deploying file...
6 Feb 18:08:39 - File deployed as version gulsdf6ful8jvf8uq6fe7vjy6
6 Feb 18:08:39 - Deploying hook config...
6 Feb 18:08:39 - Hook Config deployed at version gulsdf6ful8jvf8uq6fe7vjy6
6 Feb 18:08:39 - Setting current version to gulsdf6ful8jvf8uq6fe7vjy6...
6 Feb 18:08:40 - Current version set to gulsdf6ful8jvf8uq6fe7vjy6

--set-current オプションを省略すると、現在設置済みのバージョンを有効化したまま新たな Server Code を設置できます。たとえばイベント企画用の Server Code を有効化せずにあらかじめ設置しておき、イベント開催当日にこのバージョンを有効化するといった利用ができます。Server Code のバージョンの機能概要は Server Code の管理機能 を、操作コマンドの詳細は Server Code のバージョン一覧 や Server Code のバージョンを有効化 をご覧ください。

過去にサポートされていた --no-set-cuurent オプションは廃止されました。

--set-current オプションがエラーになる場合は、コマンドラインツールを最新版に更新してください。