本文へジャンプします。

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

利用可能なREST API一覧

サーバー

概要 API名
指定したサーバーの詳細情報を取得します。1回のリクエストで、1つのサーバーの詳細情報を取得できます。 DescribeInstanceAttribute
指定したサーバーの情報を取得します。1回のリクエストで、複数のサーバー情報を取得できます。 DescribeInstances
指定したサーバーの詳細情報を更新します。 ModifyInstanceAttribute
指定したサーバーを再起動します。 RebootInstances
サーバーを新規作成します。 RunInstances
指定したサーバーを起動します。 StartInstances
指定したサーバーを停止します。 StopInstances
指定したサーバーを削除します。 TerminateInstances
指定したサーバーのコピーを作成します。 CopyInstances
指定したサーバーの作成(コピーによる作成)をキャンセルします。 CancelCopyInstances
指定したOVFファイルの情報に基づいて、サーバーインポートを予約します。 ImportInstance
指定したサーバーに対して、ワンデイスナップショットを作成します。 NiftyCreateInstanceSnapshot
作成済ワンデイスナップショットに対するメモを更新します。 NiftyModifyInstanceSnapshotAttribute
作成済ワンデイスナップショットの情報を取得します。 NiftyDescribeInstanceSnapshots
作成済ワンデイスナップショットを削除します。 NiftyDeleteInstanceSnapshot
作成済ワンデイスナップショットからのリストアを行います。 NiftyRestoreInstanceSnapshot
VMインポートエラーとなったVMに対して、再インポート処理を実行します。 NiftyRetryImportInstance
指定したサーバーのネットワーク設定を変更します。 NiftyUpdateInstanceNetworkInterfaces

ディスク

概要 API名
指定したディスクをサーバーへ接続します。 AttachVolume
ディスクを新規作成します。 CreateVolume
指定したディスクを削除します。 DeleteVolume
指定したディスクの情報を取得します。 DescribeVolumes
指定したディスクとサーバーの接続を解除します。 DetachVolume
指定したディスクの詳細情報を更新します。 ModifyVolumeAttribute

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

概要 API名
SSHキーを新規作成します。 CreateKeyPair
SSHキーの情報を削除します。 DeleteKeyPair
指定したSSHキーの情報を取得します。 DescribeKeyPairs
指定したSSHキーの情報を更新します。 NiftyModifyKeyPairAttribute
指定したSSH公開鍵をアップロードして登録します。 ImportKeyPair

OSイメージ

概要 API名
OSイメージの情報を取得します。 DescribeImages
指定したサーバーをイメージ化し、カスタマイズイメージとして保存します。 CreateImage
指定したカスタマイズイメージを削除します。 DeleteImage
指定したカスタマイズイメージの詳細情報を更新します。 ModifyImageAttribute
指定したカスタマイズイメージの詳細情報を更新します。 NiftyAssociateImage

ロードバランサー

概要 API名
指定したロードバランサーのヘルスチェックの設定を変更します。 ConfigureHealthCheck
ロードバランサーの定義を作成します。1回のリクエストで、1つのポート定義を作成できます。 CreateLoadBalancer
指定したロードバランサーのポート定義を削除します。 DeleteLoadBalancer
指定したロードバランサーから、指定したサーバーを解除します。 DeregisterInstancesFromLoadBalancer
指定したロードバランサーに設定されている、サーバーのヘルスチェック結果を取得します。 DescribeInstanceHealth
指定したロードバランサーの情報を取得します。 DescribeLoadBalancers
指定したロードバランサーにサーバーを追加します。 RegisterInstancesWithLoadBalancer
指定したロードバランサーにポートを追加します。 RegisterPortWithLoadBalancer
指定したロードバランサーにアクセスフィルターを設定します。 SetFilterForLoadBalancer
指定したロードバランサーの定義を変更します。 UpdateLoadBalancer
指定したロードバランサーのオプション設定を更新します。 UpdateLoadBalancerOption
指定したロードバランサーに対してSSL証明書を取り付けます。 SetLoadBalancerListenerSSLCertificate
指定したロードバランサーに設定されているSSL証明書を外します。 UnsetLoadBalancerListenerSSLCertificate
指定したセッション固定オプションを申し込んでいるロードバランサーのセッション情報を削除します。 ClearLoadBalancerSession

マルチロードバランサー

概要 API名
指定したマルチロードバランサーのヘルスチェックの設定を変更します。 NiftyConfigureElasticLoadBalancerHealthCheck
マルチロードバランサーを作成します。 NiftyCreateElasticLoadBalancer
指定したマルチロードバランサーのポートを削除します。 NiftyDeleteElasticLoadBalancer
指定したマルチロードバランサーから、指定したサーバーを解除します。 NiftyDeregisterInstancesFromElasticLoadBalancer
指定したマルチロードバランサーに設定されている、サーバーのヘルスチェック結果を取得します。 NiftyDescribeInstanceElasticLoadBalancerHealth
指定したマルチロードバランサーの情報を取得します。 NiftyDescribeElasticLoadBalancers
指定したマルチロードバランサーの詳細情報を更新します。 NiftyModifyElasticLoadBalancerAttributes
指定したマルチロードバランサーにサーバーを追加します。 NiftyRegisterInstancesWithElasticLoadBalancer
指定したマルチロードバランサーにポートを追加します。 NiftyRegisterPortWithElasticLoadBalancer
指定したマルチロードバランサーの設定を変更します。 NiftyUpdateElasticLoadBalancer
指定したマルチロードバランサーを最新バージョンに入れ替えます。 NiftyReplaceElasticLoadBalancerLatestVersion
指定したマルチロードバランサーに対してSSL証明書を入れ替えます。 NiftyReplaceElasticLoadBalancerListenerSSLCertificate

ファイアウォール

概要 API名
指定したファイアウォールグループへ許可ルールを追加します。 AuthorizeSecurityGroupIngress
ファイアウォールグループを新規作成します。 CreateSecurityGroup
指定したファイアウォールグループを削除します。 DeleteSecurityGroup
指定したファイアウォールグループから、指定したサーバーをはずします。 DeregisterInstancesFromSecurityGroup
指定したファイアウォールグループのログ情報を取得します。 DescribeSecurityActivities
指定したファイアウォールグループの設定情報を取得します。 DescribeSecurityGroups
指定したファイアウォールグループを、指定したサーバーへ適用します。 RegisterInstancesWithSecurityGroup
指定したファイアウォールグループから許可ルールを削除します。 RevokeSecurityGroupIngress
ファイアウォールグループの設定情報を更新します。 UpdateSecurityGroup
ファイアウォールのオプション情報を更新します。 UpdateSecurityGroupOption
ファイアウォールのオプション利用情報を取得します。 DescribeSecurityGroupOption
指定したファイアウォールグループを、ルーターへ適用します。 NiftyRegisterRoutersWithSecurityGroup
指定したファイアウォールグループからルーターをはずします。 NiftyDeregisterRoutersFromSecurityGroup
指定したファイアウォールグループをVPNゲートウェイへ適用します。 NiftyRegisterVpnGatewaysWithSecurityGroup
指定したファイアウォールグループからVPNゲートウェイをはずします。 NiftyDeregisterVpnGatewaysFromSecurityGroup

SSL証明書

概要 API名
SSL証明書の新規作成または更新を行います。 CreateSslCertificate
指定したSSL証明書を削除します。 DeleteSslCertificate
指定したSSL証明書の情報を取得します。 DescribeSslCertificates
指定したSSL証明書の詳細情報を取得します。1回のリクエストで、1つのSSL証明書の1つの詳細情報を取得できます。 DescribeSslCertificateAttribute
指定したSSL証明書をダウンロードします。1回のリクエストで、SSL証明書のキー・CA・証明書のいずれかを取得できます。 DownloadSslCertificate
指定したSSL証明書の詳細情報を更新します。1回のリクエストで、1つのSSL証明書の1つの詳細情報を更新できます。 ModifySslCertificateAttribute
SSL証明書を管理する申請法人情報を登録または更新します。 RegisterCorporateInfoForCertificate
指定したSSL証明書をアップロードします。1回のリクエストで、SSL証明書のキー・CA・証明書の1セットをアップロードできます。 UploadSslCertificate
登録されている申請法人情報を取得します。 NiftyDescribeCorporateInfoForCertificate

利用状況

概要 API名
リソースの利用状況を返却します。 DescribeResources
サービスの稼働情報を返却します。 DescribeServiceStatus
リソースの利用状況を返却します。 DescribeUsage
APIおよびコントロールパネルの利用履歴を返却します。 DescribeUserActivities

アップロード

概要 API名
アップロード中のタスク情報を返却します。 DescribeUploads
サーバーインポートの処理をキャンセルします。 CancelUpload

付替IPアドレス

概要 API名
付替IPアドレスを割り当てます。 AllocateAddress
指定したサーバーへ付替IPアドレスを追加します。 AssociateAddress
付替IPアドレスの基本情報を更新します。 NiftyModifyAddressAttribute
付替IPアドレスの情報を取得します。 DescribeAddresses
サーバーから付替IPアドレスを解除します。 DisassociateAddress
付替IPアドレスの解放を行います。 ReleaseAddress

オートスケール

概要 API名
オートスケール定義を新規作成します。 NiftyCreateAutoScalingGroup
指定したオートスケールの定義情報を取得します。 NiftyDescribeAutoScalingGroups
指定したオートスケール定義のログを取得します。 NiftyDescribeScalingActivities
指定したオートスケールの定義を変更します。 NiftyUpdateAutoScalingGroup
指定したオートスケールの定義を削除します。 NiftyDeleteAutoScalingGroup

基本監視

概要 API名
基本監視ルールを新規作成します。 NiftyCreateAlarm
指定した基本監視ルールの情報を取得します。 NiftyDescribeAlarms
基本監視ルールを更新します。 NiftyUpdateAlarm
基本監視ルールを削除します。 NiftyDeleteAlarm
監視ルールに設定されているパーティション情報を取得します。 NiftyDescribeAlarmsPartitions
サーバー、ロードバランサーおよびディスクパーティションの稼働状況を表示したチャートのデータを取得します。 NiftyDescribePerformanceChart
アラーム履歴一覧を取得します。 NiftyDescribeAlarmHistory
監視ルールの監視項目毎に、リソース異常発生と解除のログ情報を取得します。 NiftyDescribeAlarmRulesActivities

プライベートLAN

概要 API名
プライベートLANを新規作成します。 NiftyCreatePrivateLan
プライベートLANの削除を行います。 NiftyDeletePrivateLan
指定されたプライベートLANの情報を取得します。 NiftyDescribePrivateLans
プライベートLANの基本情報の変更を行います。 NiftyModifyPrivateLanAttribute

ルーター

概要 API名
ルーターを新規作成します。 NiftyCreateRouter
指定したルーターを削除します。 NiftyDeleteRouter
指定したルーターの情報の取得します。 NiftyDescribeRouters
指定したルーターを再起動します。 NiftyRebootRouters
指定したルーターの詳細情報を更新します。 NiftyModifyRouterAttribute
指定したルーターのネットワークの割り当てを変更します。 NiftyUpdateRouterNetworkInterfaces
指定したルーターを最新バージョンに入れ替えます。 NiftyReplaceRouterLatestVersion
指定したルーターを、旧バージョン(バックアップ状態)に差し戻します。 NiftyRestoreRouterPreviousVersion
ルーターのバックアップ状態を解除します。 NiftyReleaseRouterBackupState
ルートテーブル
概要 API名
ルーターに設定するルートテーブルを新規作成します。 CreateRouteTable
ルーターに設定するルートテーブルの削除を行います。 DeleteRouteTable
指定したルートテーブルの情報を取得します。 DescribeRouteTables
指定したルーターへルートテーブルを設定する。 AssociateRouteTable
ルーターに設定されたルートテーブルを解除する。 DisassociateRouteTable
ルーターに設定されたルートテーブルを解除し、指定したルートテーブルに入れ替える。 ReplaceRouteTableAssociation
ルートテーブルに適用するルート情報を作成する。 CreateRoute
ルートテーブルに適用されたルート情報を削除する。 DeleteRoute
ルートテーブルに登録されたルート情報を、指定したルート情報に入れ替える。 ReplaceRoute
NATテーブル
概要 API名
ルーターに設定するNATテーブルを新規作成します。 NiftyCreateNatTable
ルーターに設定するNATテーブルの削除を行います。 NiftyDeleteNatTable
指定したNATテーブルの情報を取得します。 NiftyDescribeNatTables
指定したルーターへNATテーブルを設定する。 NiftyAssociateNatTable
ルーターに設定されたNATテーブルを解除する。 NiftyDisassociateNatTable
ルーターに設定されたルートNATテーブルを解除し、指定したNATテーブルに入れ替える。 NiftyReplaceNatTableAssociation
NATテーブルに適用するNATルール情報を作成する。 NiftyCreateNatRule
NATテーブルに適用されたNATルール情報を削除する。 NiftyDeleteNatRule
NATテーブルに登録されたNATルールを、指定したNATルールに入れ替える。 NiftyReplaceNatRule
DHCP
概要 API名
ルーターに設定されたプライベートLANに対して、DHCP機能を有効化します。 NiftyEnableDhcp
ルーターに設定されたプライベートLANに対してDHCP機能を無効化します。 NiftyDisableDhcp
DHCPオプションの設定情報を新規作成します。 CreateDhcpOptions
DHCPオプションの設定情報を削除します。 DeleteDhcpOptions
DHCPオプションの設定情報を取得します。 DescribeDhcpOptions
ルーターに登録されたDHCPオプションを解除し、指定したDHCPオプションに入れ替えます。 NiftyReplaceDhcpOption
DHCPコンフィグの入れ替えを行います。 NiftyReplaceDhcpConfig
DHCPでのIP払い出し状態を表示します。 NiftyDescribeDhcpStatus
DHCPコンフィグを新規作成します。 NiftyCreateDhcpConfig
指定したDHCPコンフィグを削除します。 NiftyDeleteDhcpConfig
DHCPコンフィグ情報を取得します。 NiftyDescribeDhcpConfigs
指定したDHCPコンフィグに、手動割り当てIPアドレスの設定をを追加します。 NiftyCreateDhcpStaticMapping
指定したDHCPコンフィグから、手動割り当てIPアドレスの設定を削除します。 NiftyDeleteDhcpStaticMapping
指定したDHCPコンフィグに、自動割り当てIPアドレスの設定を追加します。 NiftyCreateDhcpIpAddressPool
指定したDHCPコンフィグから、自動割り当てIPアドレスの設定を削除します。 NiftyDeleteDhcpIpAddressPool
Webプロキシ
概要 API名
指定したルーターに対してWebプロキシを新規作成します。 NiftyCreateWebProxy
ルーターに設定されたWebプロキシを削除します。 NiftyDeleteWebProxy
ルーターに設定されているWebプロキシの設定情報を取得します。 NiftyDescribeWebProxies
ルーターに設定されたWebプロキシの詳細情報を更新します。 NiftyModifyWebProxyAttribute

VPNゲートウェイ

概要 API名
VPNゲートウェイを新規作成します。 CreateVpnGateway
指定されたVPNゲートウェイを削除します。 DeleteVpnGateway
指定したVPNゲートウェイの情報を取得します。 DescribeVpnGateways
VPNゲートウェイで接続されているVPNゲートウェイの接続ログ情報を取得します。 NiftyDescribeVpnGatewayActivities
指定されたVPNゲートウェイの詳細情報を更新します。 NiftyModifyVpnGatewayAttribute
指定したVPNゲートウェイを再起動します。 NiftyRebootVpnGateways
指定したVPNゲートウェイへルートテーブル設定する。 NiftyAssociateRouteTableWithVpnGateway
VPNゲートウェイに設定されたルートテーブルを解除する。 NiftyDisassociateRouteTableFromVpnGateway
VPNゲートウェイへのルートテーブル設定入れ替えを行う。 NiftyReplaceRouteTableAssociationWithVpnGateway
指定したVPNゲートウェイを最新バージョンに入れ替えます。 NiftyReplaceVpnGatewayLatestVersion
指定したVPNゲートウェイを、旧バージョン(バックアップ状態)に差し戻します。 NiftyRestoreVpnGatewayPreviousVersion
指定したVPNゲートウェイのバックアップ状態を解除します。 NiftyReleaseVpnGatewayBackupState
VPNゲートウェイのネットワーク設定変更をします。 NiftyUpdateVpnGatewayNetworkInterfaces
カスタマーゲートウェイ
概要 API名
カスタマーゲートウェイを新規作成します。 CreateCustomerGateway
指定されたカスタマーゲートウェイを削除します。 DeleteCustomerGateway
指定したカスタマーゲートウェイの情報を取得します。 DescribeCustomerGateways
指定されたカスタマーゲートウェイの詳細情報を更新します。 NiftyModifyCustomerGatewayAttribute
VPNコネクション
概要 API名
VPNコネクションを新規作成します。 CreateVpnConnection
指定されたVPNコネクションを削除します。 DeleteVpnConnection
指定されたVPNコネクションの情報を取得します。 DescribeVpnConnections

その他

概要 API名
利用可能なゾーンの情報を取得します。 DescribeAvailabilityZones
利用可能なリージョンの情報を取得します。 DescribeRegions
指定した機能を、指定したユーザーに共有します。 AssociateUsers
指定した機能から、指定したユーザーの共有を解除します。 DissociateUsers
指定した機能の共有ユーザー情報を取得します。 DescribeAssociatedUsers

付録

概要 API名
「パラメーターエラー」「認証エラー、サービスエラー」「サーバーエラー」のエラーコード概要および対応方法を解説します。 APIエラーコード表
「共通パラメーター」「認証方式」について解説します。 共通パラメーター
ニフティクラウドAPI(REST)で利用可能なエンドポイントを記述します。 エンドポイント
サーバー、ファイアウォールグループ、ロードバランサーについては、作成時にゾーンを指定することができます。 ゾーンについて

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

APIメニュー

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

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