本文へジャンプします。

ニフティクラウド APIリファレンス

利用可能なCLI API一覧

CLIリファレンスPDF版について

CLIリファレンスは本ページのほかに、PDFでもご覧いただけます。

サーバー

概要 API名
指定したサーバーの詳細情報を取得します。 nifty-describe-instance-attribute
指定したサーバーの情報を取得します。 nifty-describe-instances
指定したサーバーの詳細情報を更新します。 nifty-modify-instance-attribute
指定したサーバーを再起動します。 nifty-reboot-instances
サーバーを新規作成します。 nifty-run-instances
指定したサーバーを起動します。 nifty-start-instances
指定したサーバーを停止します。 nifty-stop-instances
指定したサーバーを削除します。 nifty-terminate-instances
指定したサーバーのコピーを作成します。 nifty-copy-instances
指定したサーバーの作成(コピーによる作成)をキャンセルします。 nifty-cancel-copy-instances
VMDKファイルをアップロードインターフェースへ送信します。 nifty-import-instance
インポート中エラーになったサーバーに対して、再インポート処理を実行します。 nifty-retry-import-instance
指定したサーバーに対して、ワンデイスナップショットを作成します。 nifty-create-instance-snapshot
作成済ワンデイスナップショットの情報を取得します。 nifty-describe-instance-snapshots
作成済ワンデイスナップショットを削除します。 nifty-delete-instance-snapshot
作成済ワンデイスナップショットに対するメモを更新します。 nifty-modify-instance-snapshot-attribute
作成済ワンデイスナップショットからのリストアを行います。 nifty-restore-instance-snapshot
指定したサーバーのネットワーク設定を変更します。 nifty-update-instance-network-interfaces

ディスク

指定したディスクをサーバーへ接続します。 nifty-attach-volume
ディスクを新規作成します。 nifty-create-volume
指定したディスクを削除します。 nifty-delete-volume
指定したディスクの情報を取得します。 nifty-describe-volumes
指定したディスクとサーバーの接続を解除します。 nifty-detach-volume
指定したディスクの詳細情報を更新します。 nifty-modify-volume-attribute

ネットワーク・セキュリティ

SSHキーを新規作成します。 nifty-add-keypair
SSHキーの情報を削除します。 nifty-delete-keypair
指定したSSHキーの情報を取得します。 nifty-describe-keypairs

OSイメージ

OSイメージの情報を取得します。 nifty-describe-images
指定したサーバーをイメージ化し、カスタマイズイメージとして保存します。 nifty-create-image
指定したカスタマイズイメージを削除します。 nifty-delete-image
指定したカスタマイズイメージの詳細情報を更新します。 nifty-modify-image-attribute

ロードバランサー

指定したロードバランサーのヘルスチェックの設定を変更します。 nifty-configure-healthcheck
ロードバランサーの定義を作成します。 nifty-create-lb
指定したロードバランサーのポート定義を削除します。 nifty-delete-lb
指定したロードバランサーから、指定したサーバーを解除します。 nifty-deregister-instances-from-lb
指定したロードバランサーに設定されている、サーバーのヘルスチェック結果を取得します。 nifty-describe-instance-health
指定したロードバランサーの情報を取得します。 nifty-describe-lbs
指定したロードバランサーにサーバーを追加します。 nifty-register-instances-with-lb
指定したロードバランサーにポートを追加します。 nifty-register-port-with-lb
指定したロードバランサーにアクセスフィルターを設定します。 nifty-set-filter-for-lb
指定したロードバランサーの定義を変更します。 nifty-update-lb
指定したロードバランサーのオプション定義を更新します。 nifty-update-lb-option
指定したロードバランサーへSSL証明書を取り付けます。 nifty-set-lb-listener-ssl-cert
指定したロードバランサーに設定されているSSL証明書を外します。 nifty-unset-lb-listener-ssl-cert
指定したセッション固定オプションを申し込んでいるロードバランサーのセッション情報を削除します。 nifty-clear-lb-session

ファイアウォール

指定したファイアウォールグループへ許可ルールを追加します。 nifty-authorize-security-group-ingress
ファイアウォールグループを新規作成します。 nifty-create-security-group
指定したファイアウォールグループを削除します。 nifty-delete-security-group
指定したファイアウォールグループから、指定したサーバーを解除します。 nifty-deregister-instances-from-security-group
指定したファイアウォールグループのログ情報を取得します。 nifty-describe-security-activities
指定したファイアウォールグループの設定情報を取得します。 nifty-describe-security-groups
指定したファイアウォールグループを、指定したサーバーへ適用します。 nifty-register-instances-with-security-group
指定したファイアウォールグループから許可ルールを削除します。 nifty-revoke-security-group-ingress
ファイアウォールグループの設定情報を更新します。 nifty-update-security-group
ファイアウォールのオプション情報を更新します。 nifty-update-security-group-option
ファイアウォールのオプション情報を取得します。 nifty-describe-security-group-option
指定したファイアウォールグループをルーターへ適用します。 nifty-register-routers-with-security-group
指定したファイアウォールグループからルーターをはずします。 nifty-deregister-routers-from-security-group
指定したファイアウォールグループをVPNゲートウェイへ適用します。 nifty-register-vpn-gateways-with-security-group
指定したファイアウォールグループからVPNゲートウェイをはずします。 nifty-deregister-vpn-gateways-from-security-group

SSL証明書

SSL証明書の新規作成または更新を行います。 nifty-create-ssl-certificate
指定したSSL証明書を削除します。 nifty-delete-ssl-certificate
指定したSSL証明書の情報を取得します。 nifty-describe-ssl-certificates
指定したSSL証明書の詳細情報を取得します。1回のリクエストで、1つのSSL証明書の1つの詳細情報を取得できます。 nifty-describe-ssl-certificate-attribute
指定したSSL証明書をダウンロードします。1回のリクエストで、SSL証明書のキー・CA・証明書のいずれかを取得できます。 nifty-download-ssl-certificate
指定したSSL証明書の詳細情報を更新します。1回のリクエストで、1つのSSL証明書の1つの詳細情報を更新できます。 nifty-modify-ssl-certificate-attribute
SSL証明書を管理する申請法人情報を登録または更新します。実行すると、利用規約の確認が求められます。 nifty-register-corporate-information-for-certificate
指定したSSL証明書をアップロードします。1回のリクエストで、SSL証明書のキー・CA・証明書の1セットをアップロードできます。 nifty-upload-ssl-certificate

利用状況

ユーザーのリソース情報を取得します。 nifty-describe-resources
ニフティクラウドの稼働状況を取得します。 nifty-describe-service-status
ユーザーの利用明細情報を取得します。 nifty-describe-usage
ユーザーの操作ログを取得します。 nifty-describe-user-activities

アップロード

アップロード処理が実行されます。 nifty-resume-import
アップロード中のタスク情報を返却します。 nifty-describe-uploads
サーバーインポートの処理をキャンセルします。 nifty-cancel-upload

付替IPアドレス

付替IPアドレスを割り当てます。 nifty-allocate-address
指定したサーバーへ付替IPアドレスを追加します。 nifty-associate-address
付替IPアドレスの基本情報を更新します。 nifty-modify-address-attribute
付替IPアドレス情報を取得します。 nifty-describe-addresses
サーバーから付替IPアドレスを解除します。 nifty-disassociate-address
付替IPアドレスを解放します。 nifty-release-address

プライベートLAN

指定されたプライベートLANの情報を取得します。 nifty-describe-privatelans
プライベートLANを新規作成します。 nifty-create-privatelan
指定したプライベートLANを削除します。 nifty-delete-privatelan
プライベートLANの基本情報の変更を行います。 nifty-modify-privatelan-attribute

ルーター

ルーターを新規作成します。 nifty-create-router
指定したルーターを削除します。 nifty-delete-router
指定したルーターの情報の取得します。 nifty-describe-routers
指定したルーターの詳細情報を更新します。 nifty-modify-router-attribute
指定したルーターを再起動します。 nifty-reboot-routers
指定したルーターを最新バージョンに入れ替えます。 nifty-replace-router-latest-version
指定したルーターを、旧バージョン(バックアップ状態)に差し戻します。 nifty-restore-router-previous-version
ルーターのバックアップ状態を解除します。 nifty-release-router-backup-state
指定したルーターのネットワークの割り当てを変更します。 nifty-update-router-network-interfaces

ルーター/ルートテーブル

ルーターに設定するルートテーブルを新規作成します。 nifty-create-route-table
ルーターに設定するルートテーブルの削除を行います。 nifty-delete-route-table
指定したルートテーブルの情報を取得します。 nifty-describe-route-tables
指定したルーターへルートテーブルを設定する。 nifty-associate-route-table
ルーターに設定されたルートテーブルを解除する。 nifty-disassociate-route-table
ルーターに設定されたルートテーブルを解除し、指定したルートテーブルに入れ替える。 nifty-replace-route-table-association
ルートテーブルに適用するルート情報を作成する。 nifty-create-route
ルートテーブルに適用されたルート情報を削除する。 nifty-delete-route
ルートテーブルに登録されたルート情報を、指定したルート情報に入れ替える。 nifty-replace-route

ルーター/NATテーブル

ルーターに設定するNATテーブルを新規作成します。 nifty-create-nat-table
指定したNATテーブルの情報を取得します。 nifty-describe-nat-tables
ルーターに設定するNATテーブルの削除を行います。 nifty-delete-nat-table
指定したルーターへNATテーブルを設定する。 nifty-associate-nat-table
ルーターに設定されたNATテーブルを解除する。 nifty-disassociate-nat-table
ルーターに設定されたルートNATテーブルを解除し、指定したNATテーブルに入れ替える。 nifty-replace-nat-table-association
NATテーブルに適用するNATルール情報を作成する。 nifty-create-nat-rule
NATテーブルに適用されたNATルール情報を削除する。 nifty-delete-nat-rule
NATテーブルに登録されたNATルールを、指定したNATルールに入れ替える。 nifty-replace-nat-rule

ルーター/DHCP

ルーターに設定されたプライベートLANに対して、DHCP機能を有効化します。 nifty-enable-dhcp
ルーターに設定されたプライベートLANに対して、DHCP機能を無効化します。 nifty-disable-dhcp
DHCPオプションの設定情報を新規作成します。 nifty-create-dhcp-options
DHCPオプションの設定情報を削除します。 nifty-delete-dhcp-options
DHCPオプションの設定情報を取得します。 nifty-describe-dhcp-options
ルーターに登録されたDHCPオプションを解除し、指定したDHCPオプションに入れ替えます。 nifty-replace-dhcp-option
DHCPでのIP払い出し状態を表示します。 nifty-describe-dhcp-status
DHCPコンフィグを新規作成します。 nifty-create-dhcp-config
指定したDHCPコンフィグを削除します。 nifty-delete-dhcp-config
DHCPコンフィグ情報を取得します。 nifty-describe-dhcp-configs
DHCPコンフィグの入れ替えを行います。 nifty-replace-dhcp-config
指定したDHCPコンフィグに、手動割り当てIPアドレスの設定を追加します。 nifty-create-dhcp-static-mapping
指定したDHCPコンフィグから、手動割り当てIPアドレスの設定を削除します。 nifty-delete-dhcp-static-mapping
指定したDHCPコンフィグに、自動割り当てIPアドレスの設定を追加します。 nifty-create-dhcp-ip-address-pool
指定したDHCPコンフィグから、自動割り当てIPアドレスの設定を削除します。 nifty-delete-dhcp-ip-address-pool

ルーター/Webプロキシ

指定したルーターに対してWebプロキシを新規作成します。 nifty-create-web-proxy
ルーターに設定されたWebプロキシを削除します。 nifty-delete-web-proxy
ルーターに設定されているWebプロキシの設定情報を取得します。 nifty-describe-web-proxies
ルーターに設定されたWebプロキシの詳細情報を更新します。 nifty-modify-web-proxy-attribute

VPNゲートウェイ

VPNゲートウェイを新規作成します。 nifty-create-vpn-gateway
指定されたVPNゲートウェイを削除します。 nifty-delete-vpn-gateway
指定したVPNゲートウェイの情報を取得します。 nifty-describe-vpn-gateways
VPNゲートウェイで接続されているVPNゲートウェイの接続ログ情報を取得します。 nifty-describe-vpn-gateway-activities
指定されたVPNゲートウェイの詳細情報を更新します。 nifty-modify-vpn-gateway-attribute
指定したVPNゲートウェイを再起動します。 nifty-reboot-vpn-gateways
VPNゲートウェイのバックアップ状態を解除します。 nifty-release-vpn-gateway-backup-state
指定したVPNゲートウェイを、旧バージョン(バックアップ状態)に差し戻します。 nifty-restore-vpn-gateway-previous-version
指定したVPNゲートウェイを最新バージョンに入れ替えます。 nifty-replace-vpn-gateway-latest-version
VPNゲートウェイのネットワーク設定変更をします。 nifty-update-vpn-gateway-network-interfaces
VPNゲートウェイへのルートテーブル設定入れ替えを行う。 nifty-replace-route-table-association-with-vpn-gateway
指定したVPNゲートウェイへルートテーブル設定する。 nifty-associate-route-table-with-vpn-gateway
VPNゲートウェイに設定されたルートテーブルを解除する。 nifty-disassociate-route-table-from-vpn-gateway

カスタマーゲートウェイ

カスタマーゲートウェイを新規作成します。 nifty-create-customer-gateway
指定したカスタマーゲートウェイの情報を取得します。 nifty-describe-customer-gateways
指定されたカスタマーゲートウェイを削除します。 nifty-delete-customer-gateway
指定されたカスタマーゲートウェイの詳細情報を更新します。 nifty-modify-customer-gateway-attribute

VPNコネクション

VPNコネクションを新規作成します。 nifty-create-vpn-connection
指定されたVPNコネクションを削除します。 nifty-delete-vpn-connection
指定されたVPNコネクションの情報を取得します。 nifty-describe-vpn-connections

その他

利用可能なゾーンの情報を取得します。 nifty-describe-availability-zones
利用可能なリージョンの情報を取得します。 nifty-describe-regions
指定した機能を、指定したユーザーに共有します。 nifty-associate-users
指定した機能から、指定したユーザーの共有を解除します。 nifty-dissociate-users
指定した機能の共有ユーザー情報を取得します。 nifty-describe-associated-users
サーバー、ロードバランサーおよびディスクパーティションの稼働状況を表示したチャートのデータを取得します。 nifty-describe-performance-chart

付録

「パラメーターエラー」および「コマンドラインツール」のエラーコードを解説します。 APIエラーコード表
「認証方式」「環境変数」について解説します。 CLI認証方式と環境変数
「共通オプション」について解説します。 共通オプション

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

推奨画面サイズ 1024×768 以上