GMOクラウド Public APIリファレンス

サポートトップ » GMOクラウド Public トップ » APIリファレンス

APIリファレンス

はじめに

前提知識

APIのご利用にあたっては、以下の知識を持つ方を対象とさせていただいております。

  • Webサービスの基本構造に関する知識(W3Schools参照)
  • プログラミングに関する知識
  • GMOクラウド Publicでのサーバー構築・運用に関する知識

注意事項

  • 実行結果に伴う影響(仮想サーバーの削除や各種設定変更、また課金など)でお客さま、または第三者に生じた損害については、当社の過失の有無やその程度に関わらず、一切の責任は負いかねますのでご了承ください。
  • APIポータル上の操作方法についてはサポートいたしますが、実行結果の内容やエラーの原因等についてはサポート範囲外となります。各種参考書籍などをご参照くださいますようお願いいたします。

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

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

APIリファレンス一覧

分類 概要 API名
Transaction Log 契約アカウントのクラウドの操作・振る舞いなどのトランザクションログのうち、ステータスが201のものの直近の10件分を取得します。
GMOクラウドPublic のクラウドコンソールにおける仮想サーバーのアクティビティログと同一の内容を反映します。
listTransactionLogs
指定した仮想サーバーに関する操作・振る舞いなどのトランザクションログのうち、ステータスが201のものの直近の10件分を取得します。
GMOクラウドPublic のクラウドコンソールにおける仮想サーバーのアクティビティログと同一の内容を反映します。
listNodeTransactionLogs
Hypervisor 指定したクラウドゾーンに属する全てのハイパーバイザーの詳細情報の一覧を取得します。 listHypervisors
指定されたハイパーバイザーの詳細情報を返します。
指定したハイパーバイザーのIDが無効である場合は、エラーを返します。
getHypervisor
Virtual Machine 指定したクラウドゾーンに属する全ての仮想サーバーの詳細情報の一覧を取得します。 listNodes
指定した仮想サーバーの詳細情報を返します。
指定した仮想サーバーIDが無効であるか、存在しない場合はエラーを返します。
getNode
指定した仮想サーバーを起動します startupNode
指定した仮想サーバーを停止・シャットダウンします。 shutdownNode
指定した仮想サーバーの初期化を行い、予め作成してあるユーザーテンプレートから仮想サーバーの再構築(再作成)をします。
仮想サーバーの再構築後の稼動状態を指定することができます。
buildNode
指定した仮想サーバーの初期化を行い、その時点で使用しているテンプレートと同じIDのテンプレート(ユーザーテンプレートを使用している場合は同じIDのユーザーテンプレート)を使用して仮想サーバーの再構築(再作成)をします。
再構築後の仮想サーバーは稼動停止状態です。
rebuildNode
仮想サーバーを構築します。
仮想サーバーの構築完了後、仮想サーバーを起動します。
deployNode
指定した仮想サーバーを削除します。 destroyNode
仮想サーバーの設定を変更します。 editNode
仮想サーバーのrootパスワードを初期化します。
システムによって自動的にランダムに割り当てられる英数字に置き換えます。
resetPasswordNode
稼働中の仮想サーバーを再起動します。 rebootNode
仮想サーバーを異なる別の物理マシン上に移動します。 migrateNode
仮想サーバーのリソース割り当てを変更します。 resizeNode
Disk ディスクの一覧を取得します。
仮想サーバーのIDが指定されている場合は、当該仮想サーバーに接続されているディスクの一覧を返します。
それ以外の場合には、GMOクラウドPublicのシステム内のディスクの一覧を返します。
listDisks
指定したディスクの詳細情報を返します。 getDisk
指定した仮想サーバーにディスクを追加します。 attachDisk
指定した仮想サーバーから特定のディスクを削除します。 detachDisk
指定したディスクのディスクサイズと自動バックアップの設定を変更します。
なお、対象のディスクはビルドが完了している必要があります。
editDisk
指定したディスクのバックアップを作成します。
なお、対象のディスクはビルドが完了している必要があります。
また、スワップディスクは指定できません。
createBackup
Backup 仮想サーバーのバックアップ一覧を返します。バックアップが存在しない場合、空の配列を返します。
指定した仮想サーバーのIDが無効であるか、あるいは存在しない場合は、エラーを返します。
listBackups
バックアップからテンプレートへコンバートします。
仮想サーバー作成時のテンプレートとして使用できるようになります。
convertBackup
Network Interface 指定した仮想サーバーに割り当てられたネットワークインターフェースの一覧を返します。
指定した仮想サーバーのIDが無効であるか、あるいは存在しない場合は、エラーを返します。
listNetworkInterfaces
指定した仮想サーバーにネットワークインターフェースを追加します。 attachNetworkInterface
指定した仮想サーバーの特定のネットワークインターフェースの編集をします。
設定内容を有効にするには rebuildNetwork API を実行する必要があります。
editNetworkInterface
指定した仮想サーバーからネットワークインターフェースを削除します。 detachNetworkInterface
Network 指定したクラウドゾーンで利用可能な物理ネットワークの一覧を取得します。 listNetworks
指定したネットワークの詳細情報を返します。 getNetwork
指定した仮想サーバーのネットワークを再構築します。
attachNetworkInterface API / editNetworkInterface API / detachNetworkInterface APIそれぞれの結果を反映させるためには、このAPIの実行が必要です。
rebuildNetwork
IP Address 指定したネットワークに属するIPアドレスの一覧を返します。 listIpAddresses
特定のネットワークに属する、指定したIPアドレスの詳細情報を返します。 getIpAddress
指定した仮想サーバーにIPアドレスを追加します。 addIp
指定した仮想サーバーからIPアドレスを削除します。 deleteIp
Firewall Rule 仮想サーバーに設定されている全てのファイアーウォールルールの一覧を取得します。 listFirewalls
指定したファイアーウォールルールの詳細情報を返します getFirewall
仮想サーバーにファイアーウォールルールを追加します。
追加したファイアーウォールルールが複数ある場合の適用優先順位は、一番低くなります。
追加したファイアーウォールルールを有効にするためには、後述の 10.7. applyFirewall API でファイアーウォールルールを適用する必要があります。
addFirewall
特定の仮想サーバーのネットワークインターフェースに設定されているファイアーウォールルールを編集します editFirewall
指定した仮想サーバーから、特定のファイアーウォール設定を削除します。 deleteFirewall
指定した仮想サーバーのインターフェースに対してデフォルトファイアーウォールルールを設定します。 setFirewallDefault
仮想サーバーにおいてファイアーウォールルールの適用をします。 applyFirewall
Template テンプレートの一覧を返します listImages
指定したテンプレートの詳細情報を返します getImage
指定したユーザーテンプレートを削除します destroyImage
Data Store データストアの一覧を返します listDatastores
Load Balancers ロードバランスクラスターを構成するロードバランサーと仮想サーバーの一覧を返します listClusters
指定したロードバランスクラスターの詳細情報を返します。 getCluster
ロードバランスクラスターの設定を編集します editCluster
クラスタータイプのロードバランサーを作成します deployClusteringBalancer
クラスタータイプのロードバランサーへ仮想サーバーを追加します addClusteringNode
クラスタータイプのロードバランサーから仮想サーバーを削除します removeClusteringNode
クラスタータイプのロードバランサーとオートスケールタイプのロードバランサーを削除します destroyCluster
オートスケールタイプのロードバランサーを作成します deployAutoScalingBalancer
オートスケールタイプのロードバランサーの設定を編集します editAutoScalingBalancer
ロードバランサーの一覧を返します listBalancers
指定したロードバランサーの詳細情報を返します。
指定したロードバランサーIDが無効であるか、存在しない場合はエラーを返します。
getBalancer
指定したロードバランサーをシャットダウンします。 shutdownBalancer
指定したロードバランサーを起動します startupBalancer
指定したロードバランサーを再起動します。 rebootBalancer
指定したロードバランサーの初期化を行い、その時点で使用しているテンプレートと同じIDのテンプレート(ユーザーテンプレートを使用している場合は同じIDのユーザーテンプレート)を使用してロードバランサーの再構築(再作成)をします。
再構築後のロードバランサーは稼動状態です。
rebuildBalancer
ロードバランサーを異なる別の物理マシン上に移動します。 migrateBalancer
Resources 使用しているリソースの詳細情報を取得します。 getResources
仮想サーバーやロードバランサーに割り当てて利用できるリソースやリソースの上限値を取得します getLimits

このガイドで問題は解決しましたか?

ご回答ありがとうございました。

引き続きGMOクラウド サポートサイトをご利用ください。

ご回答ありがとうございました。

GMOクラウド Public サポートまでお問い合わせください。

お問い合わせ