GMOクラウドPublic API リファレンスsupport.gmocloud.com/public/guide/api/api.pdf · 修正履歴表（1／1） ... ・フォーマットは iso8601の日付と時刻の組み合わせ表記に準じます。

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

GMO クラウド株式会社

2012 年 09 月 12 日（第 1.3 版）

2/205

修正履歴表（１／１）

No

文書

バージョ

ン

修正個所修正内容修正日

1 第 1.0 版初版発行 2012.07.25

2 第 1.1 版章・項番号 2.1-2 2.1-2 を従来の2.1-2 : ハイパーバイザー

系 API の前に追記

2012.08.09

3 第 1.1 版章・項番号 3, 4, 5, 6, 2.1-2 の追加に伴い章番号を繰り延べ 2012.08.09

4 第 1.1 版章・項番号 3, 4, 5, 6, リクエストパラメーター一覧表において、

各パラメーターの説明文の一行目に、パラ

メーターの略称を追記

2012.08.09

5 第 1.1 版 2.1-2, 7.2-4, 8.1-3, 9.1,

10.1-4, 11.1-7, 12.1 の各章項

を新規追加

第二フェーズ公開のためのAPI追加に伴う

追記

2012.08.09

6 第 1.2 版 4.9-10, 5.2-6, 6.2, 11.2-3,

12.1, 13.1-8, 14.1-2 の各章項

を新規追加

第三フェーズ公開のためのAPI追加に伴う

追記

2012.08.31

7 第 1.2 版章・項番号 1 リクエストパラメーターに非必須のパラ

メーターを追加

2012.08.31

8 第 1.2 版章・項番号 2.1 実行機能名を getTransactionLog から

listTransactionLogs へ変更

2012.08.31

9 第 1.2 版章・項番号 2.2 実行機能名を getNodeTransactionLog か

ら listNodeTransactionLogs へ変更

2012.08.31

10 第 1.2 版章・項番号 4.1 レスポンスオブジェクトのうち state で

仮想サーバーの状態を反映

2012.08.31

11 第 1.2 版章・項番号 4.2 リクエストパラメーターの必須パラメー

ターを変更

2012.08.31

12 第 1.2 版章・項番号 9.1 第三フェーズ公開に伴い不要となったた

め API を削除

2012.08.31

13 第 1.2 版章・項番号 10.3 リクエストパラメーターの

ip_address_id を必須から除外

2012.08.31

14 第 1.2 版章・項番号 11.1 レスポンスオブジェクトのうちlabelの返

り値を変更、short_label/arch/type を追

加、checksum/user_id を削除

2012.08.31

15 弟 1.3 版 8 ページ中、Signature 算出式

のうち StringToSign の算出式

“/ + \n +”を“/ + (Cloud-Zone ID) + /

+ \n +”に訂正

2012.09.12

16 弟 1.3 版章・項番号 9.4、リクエストパ

ラメーター ip_address_id の

説明

説明文中の引用が誤っていたため正しい

引用に訂正

2012.09.12

3/205

目次

1. はじめに .......................................................................................................................... 6 2. Transaction Log ..........................................................................................................11

2.1. トランザクションログの取得.................................................................................11 2.2. 仮想サーバー別トランザクションログの取得 ...................................................... 14

3. Hypervisor................................................................................................................... 16 3.1. ハイパーバイザー一覧の取得................................................................................ 16 3.2. ハイパーバイザー詳細情報の取得......................................................................... 21

4. Virtual Machine .......................................................................................................... 24 4.1. 仮想サーバー一覧の取得 ....................................................................................... 24 4.2. 仮想サーバーの詳細情報の取得 ............................................................................ 34 4.3. 仮想サーバーの起動 .............................................................................................. 39 4.4. 仮想サーバーの停止・シャットダウン ................................................................. 41 4.5. 仮想サーバーの再構築と起動................................................................................ 43 4.6. 仮想サーバーの再構築........................................................................................... 45 4.7. 仮想サーバーの作成 .............................................................................................. 47 4.8. 仮想サーバーの削除 .............................................................................................. 53 4.9. 仮想サーバーの設定編集 ....................................................................................... 55 4.10. 仮想サーバーの root パスワードの初期化........................................................ 57 4.11. 仮想サーバーの再起動 ....................................................................................... 59 4.12. 仮想サーバーのマイグレーション..................................................................... 61 4.13. 仮想サーバーのリソース割り当て変更.............................................................. 63

5. Disk............................................................................................................................... 65 5.1. ディスク一覧の取得 .............................................................................................. 65 5.2. ディスクの詳細情報の取得 ................................................................................... 68 5.3. ディスクの追加...................................................................................................... 70 5.4. ディスクの削除...................................................................................................... 73 5.5. ディスクの設定変更 .............................................................................................. 74 5.6. ディスクのバックアップの作成 ............................................................................ 76

6. Backup ......................................................................................................................... 78 6.1. 仮想サーバーのバックアップ一覧の取得.............................................................. 78 6.2. バックアップからテンプレートへのコンバート................................................... 82

7. Network Interface..................................................................................................... 84

4/205

7.1. ネットワークインターフェース一覧の取得.......................................................... 84 7.2. ネットワークインターフェースの追加 ................................................................. 88 7.3. ネットワークインターフェースの編集 ................................................................. 90 7.4. ネットワークインターフェースの削除 ................................................................. 92

8. Network ....................................................................................................................... 94 8.1. ネットワーク一覧の取得 ....................................................................................... 94 8.2. ネットワーク詳細情報の取得................................................................................ 96 8.3. 仮想サーバーのネットワーク再構築..................................................................... 98

9. IP Address ............................................................................................................... 100 9.1. IP アドレス一覧の取得 ....................................................................................... 100 9.2. IP アドレスの詳細情報の取得 ............................................................................ 104 9.3. IP アドレスの追加............................................................................................... 106 9.4. IP アドレスの削除............................................................................................... 108

10. Firewall Rule ..........................................................................................................110 10.1. ファイアーウォールルール一覧の取得.............................................................110 10.2. 個別のファイアーウォールルールの取得.........................................................113 10.3. ファイアーウォールルールの追加....................................................................115 10.4. ファイアーウォールルールの編集....................................................................118 10.5. ファイアーウォールルールの削除................................................................... 121 10.6. デフォルトファイアーウォールルールの設定................................................. 123 10.7. ファイアーウォールルールの適用................................................................... 125

11. Template ................................................................................................................ 127 11.1. テンプレート一覧の取得 ................................................................................. 127 11.2. テンプレートの詳細情報の取得 ...................................................................... 131 11.3. ユーザーテンプレートの削除 .......................................................................... 133

12. Data Store ............................................................................................................. 135 12.1. データストア一覧の取得 ................................................................................. 135

13. Load Balancers ..................................................................................................... 138 13.1. ロードバランスクラスター一覧の表示............................................................ 138 13.2. 個別のロードバランスクラスターの詳細情報の取得...................................... 149 13.3. ロードバランスクラスターの設定編集............................................................ 155 13.4. クラスタータイプのロードバランサーの作成................................................. 158 13.5. クラスタータイプのロードバランサーへの仮想サーバー追加 ....................... 161 13.6. クラスタータイプのロードバランサーから仮想サーバー取外 ....................... 163 13.7. ロードバランサーの削除 ................................................................................. 165 13.8. オートスケールタイプのロードバランサーの作成 ......................................... 167

5/205

13.9. オートスケールタイプのロードバランサーの設定編集 .................................. 172 13.10. ロードバランサー一覧の表示....................................................................... 175 13.11. 個別のロードバランサーの詳細情報の取得................................................. 183 13.12. ロードバランサーのシャットダウン............................................................ 188 13.13. ロードバランサーの起動.............................................................................. 190 13.14. ロードバランサーの再起動 .......................................................................... 192 13.15. ロードバランサーの再構築 .......................................................................... 194 13.16. ロードバランサーのマイグレーション ........................................................ 196

14. Resources .............................................................................................................. 198 14.1. 使用リソースの詳細情報の取得 ...................................................................... 198 14.2. リソース上限値の取得 ..................................................................................... 202

15. 別紙.......................................................................................................................... 205 15.1. ネットワークグループ ID................................................................................ 205

6/205

1. はじめに・ドキュメントの目的

このドキュメントは、GMO クラウド Public API の処理概要と API の利用に必要なパラメ

ーターの説明を目的としています。

・ドキュメントの利用者

GMO クラウド Public API は、以下に挙げるような方々によるご利用を想定致しておりま

す。

・ GMO クラウド Public API を利用して、仮想サーバーの作成、起動、停止などの自動

化を行う方

・ GMO クラウド Public API を利用して、システム構築や運用・管理アプリケーション

の開発を行う方

・上記によらず、GMO クラウド Public API を活用して GMO クラウド Public を利用す

る、あるいは利用する方のための開発を行う方

・GMO クラウド API の利用準備

GMO クラウド Public API を利用するためには、GMO クラウド Public API ポータルから

“Access Key ID”と“Secret Access Key”を取得する必要があります。

GMO クラウド Public API ポータル

https://api.gmocloud.com/portal/

GMO クラウド Public API ポータルへのログインには、GMO クラウド Public クラウドポー

タルへログインする際の“ユーザーID”と“パスワード”と同じ組み合わせの文字列を使

用します。

“Access Key ID”の破棄・再発行や接続制限も GMO クラウド Public API ポータルで行え

ます。

API のご利用の際は、不正利用防止のために接続元（呼び出し元）の IP アドレスを、この

GMO クラウド Public API ポータルから事前に登録しておく必要がありますのでご注意くだ

さい。

7/205

・GMO クラウド API の利用方法

GMO クラウド Public API を利用するためには、HTTP プロトコルを通して Query Requests

(GET/POST 可)によりリクエストを行う必要があります。

全てのリクエストは以下の形式に沿って記述してください。

https://api.gmocloud.com/ (Cloud-Zone ID) /?Action=（実行機能名）

&（ファンクションパラメーター）

&(Common Parameters)

- “Cloud-Zone ID” はGMOクラウドPublicのマルチロケーションサービスにおける

クラウドゾーンに割り当てている識別子です。以下の相対表に沿って適宜読み替

えてください。

- “ファンクションパラメーター” は 2章以降で以下の形式で説明しています。

- “Common Parameters” は以下の構成で成り立っています。

&AccessKeyId=(Access Key ID)

&Signature=(Signature)

(&Timestamp)

&Version=1.0

ウェブサイトとクラウドポータル上での表記 Cloud-Zone ID

東京 RED jp002

東京 BLUE jp003

サンノゼ RED us001

クアラルンプール RED my001

セクション説明

実行機能名リクエストの一部として渡される実際の機能名

機能の処理概要機能がどのようなことをするかの概要

リクエストパラメーター実行要求の必須およびオプションのパラメーターのリスト

レスポンスオブジェクト応答されるパラメーターの内容のリスト

リクエストサンプル Action とリクエストパラメーターを含むリクエストのサンプル

レスポンスサンプル JSON 形式で応答される内容のサンプル

8/205

- “Access Key ID” はGMOクラウドPublic APIポータルから取得した文字列を使用

してください。

- “Signature” は以下の方法により算出して代入してください。

Base64(SignatureMethod によるハッシュ(SecretAccessKey, StringToSign) )

・ “SignatureMethod” は HmacSHA256 が指定可能です。

・ “SecretAccessKey” は GMO クラウド Public API ポータルから取得した

Secret Access Key の文字列を代入してください。

・ “StringToSign” は以下の方法により算出して代入してください。

StringToSign = HTTP リクエストメソッド + \n +

api.gmocloud.com + \n +

/ + (Cloud-Zone ID) + / + \n +

“正規化された QueryString”

“正規化された QueryString”は以下の方により生成してください。

・パラメーター名を UTF-8 の自然順序でソートします

・パラメーター名と値を URL エンコード（パーセントエンコード）し

ます

・パラメーター名と値をイコール ( = ) で結合します

・パラメーター名と値の組み合わせをアンパサント( & )で結合します

- Timestamp を指定して、リクエストのセキュリティ強度を高くすることができま

す。Timestamp パラメーターが設定されている場合の振る舞いは以下の通りです。

・フォーマットが異なる場合はAPIの実行を許可しない

・ APIサーバーとの処理時間の差が±15秒以内であれば実行を許可

・条件に一致する場合は接続許可IPアドレス以外からのリクエストでも実

行を許可

・条件に一致しない場合は接続許可IPアドレスからのリクエストでも実行

を許可しない

・フォーマットは ISO8601の日付と時刻の組み合わせ表記に準じます。

Timestamp=2012-08-31T12:34:56+09:00

Timestamp=2012-08-31T12:34:56

9/205

GMO クラウド Public API はリクエストごとに適切な HTTP ステータスコードを返します。

レスポンスは JSON 形式で BODY で返します。

それぞれのリクエストに対するレスポンスはサンプルをご参照ください。

・リクエストサンプルとレスポンスサンプル

GMO クラウド Public API を利用の際のリクエストサンプルとレスポンスサンプルの文字

列中、個別の環境に依存する値について抽象化しています。そのため以下の表に基づいて

適宜読み替えを行ってください。

ステータス説明

200 OK リクエストが正常に完了した状態。

201 Scheduled リクエストを受け付け、処理待ちの状態

403 Forbidden リクエストは正しいものの、処理ができなかった状態

404 Not Found URL が誤っているか、リクエストしたリソースのいづれかが存在

しない状態

422 Unprocessable Entry リクエストで送られたパラメーターが誤っている状態

500 Internal Server Error

抽象化例説明

イタリックで Cloud-Zone-ID リクエスト文中のファンクションパラメーターの

うち、クラウドゾーンに割り当てた識別子

イタリックで AccessKeyID

リクエスト文中のファンクションパラメーターの

うち、 GMO クラウド Public API ポータルか

ら取得した Access Key ID の文字列

イタリックで Signature

リクエスト文中のファンクションパラメーターの

うち、所定の算式に基づいて生成した Signature

の文字列

イタリックで ●●-Label-example

リクエスト文中並びにレスポンス文中における、

ハイパーバイザー、仮想サーバー、IP アドレス、

ネットワークインターフェース、システムテンプ

レート、ユーザーテンプレートのラベルの例示

イタリックで Identifier_of_●● リクエスト文中並びにレスポンス文中における、

10/205

ハイパーバイザー、仮想サーバー、 IP アドレス、


レート、ユーザーテンプレートの識別子の例示

イタリックで ID_of_●●

リクエスト文中並びにレスポンス文中における、

ハイパーバイザー、仮想サーバー、 IP アドレス、


レート、ユーザーテンプレートの ID の例示

イタリックで 192.168.0.100 リクエスト文中並びにレスポンス文中における、

IP アドレスの例示

イタリックで gmocloud.example.jp リクエスト文中並びにレスポンス文中における、

ホスト名やドメイン名の例示

11/205

2. Transaction Log

2.1. トランザクションログの取得

実行機能名

listTransactionLogs

機能の処理概要

契約アカウントのクラウドの操作・振る舞いなどのトランザクションログのうち、ス

テータスが 201 のものの直近の 10件分を取得します。

GMO クラウド Public のクラウドコンソールにおける仮想サーバーのアクティビティ

ログと同一の内容を反映します。

リクエストパラメーター

この機能の実行時に指定するパラメーターはありません。

レスポンスオブジェクト

以下の形式で応答します。

フィールド説明

actor 現在は null を返します

（このパラメーターは将来使用するためにシステムによっ

て予約しています）

action クラウド操作・振る舞いを返します

allowed_cancel タスク処理前の保留中の状態の際に、当該タスクのキャン

セルができるか否かを返します

true : タスクのキャンセルは可能です

false : タスクのキャンセルはできません

created_at タスクが登録された日時を返します

日時は以下のフォーマットで表されます

12/205

YYYY-MM-DDThh:mm:ssZ

dependent_transaction_id 依存タスクがある場合、当該依存タスクのタスク ID を返し

ます

id タスク IDを返します

identifier 当該タスクが適用される（ターゲット）仮想サーバーやデ

ィスクの識別子を返します

仮想サーバーの識別子は 4.1. listNodes API で取得できま

す。

4.1. listNodes API のレスポンスオブジェクトのうち、

identifier が該当します

ディスクの識別子は 5.1. listDisks API で取得できます。

5.1. listDisks API のレスポンスオブジェクトのうち、

identifier が該当します

params 当該タスクの処理に際してパラメーターが指定されている

場合、その値を返します

parent_id 当該タスクが適用される（ターゲット）仮想サーバーやデ

ィスクの ID を返します

仮想サーバーの IDは 4.1. listNodes API で取得できます。

4.1. listNodes API のレスポンスオブジェクトのうち、id

が該当します

ディスクの識別子は 5.1. listDisks API で取得できます。

5.1. listDisks API のレスポンスオブジェクトのうち、id

が該当します

parent_type 当該タスクが処理される仮想サーバーの種類を返します

started_at 当該タスクの処理の開始日時を返します



start_after 当該タスクの処理の開始日時を返します



status 当該タスクの処理状態を返します

updated_at 当該タスクの処理の終アップデート日時を返します。


13/205


リクエストサンプル

https://api.gmocloud.com/Cloud-Zone-ID/?Action=listTransactionLogs&AccessKeyI

d=AccessKeyID&Version=1.0&Signature=Signature

レスポンスサンプル

{

"ID_of_Transaction ": {

"created_at": "2012-07-26T17:57:07+09:00",

"start_after": "2012-07-26T17:57:07+09:00",

"actor": null,

"updated_at": "2012-07-26T17:58:39+09:00",

"action": "startup_virtual_machine",

"parent_type": "VirtualMachine",

"id":ID_of_Transaction,

"allowed_cancel": true,

"dependent_transaction_id": ID_of_Transaction,

"parent_id": ID_of_Parent,

"params": [],

"started_at": "2012-07-26T17:58:32+09:00",

"identifier": "Identifier_of_VM",

"status": "complete"

}

}

14/205

2.2. 仮想サーバー別トランザクションログの取得

実行機能名

listNodeTransactionLogs


指定した仮想サーバーに関する操作・振る舞いなどのトランザクションログのうち、

ステータスが 201 のものの直近の 10 件分を取得します。

GMO クラウド Public のクラウドコンソールにおける仮想サーバーのアクティビティ

ログと同一の内容を反映します。


この機能の実行時には以下のパラメーターを指定してください。

パラメーター説明必須

Identifier VM 識別子

仮想サーバーの識別子を指定します

仮想サーバーの識別子は 4.1. listNodes API で

取得できます。

4.1. listNodes のレスポンスオブジェクトのう

ち、identifier が該当します。

○


2.1. listTransactionLogs API と同じ形式で応答します。

詳細は 2.1. listTransactionLogs API のレスポンスオブジェクトをご参照ください。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=listNodeTransactionLogs&Access

KeyId=AccessKeyID&Version=1.0&Identifier=Identifier_of_VM&Signature=Signature

15/205


{

"ID_of_Transaction": {

"created_at": "2012-07-27T13:20:37+09:00",

"start_after": "2012-07-27T13:20:37+09:00",

"actor": null,

"updated_at": "2012-07-27T13:21:11+09:00",

"action": "rebuild_network",

"parent_type": "VirtualMachine",

"id": Transaction-ID,

"allowed_cancel": true,

"dependent_transaction_id": null,

"parent_id": ID_of_VM,

"params": {

"required_startup": null

},

"started_at": "2012-07-27T13:20:44+09:00",

"identifier": "Identifier_of_VM ",

"status": "complete"

}

}

16/205

3. Hypervisor

3.1. ハイパーバイザー一覧の取得

実行機能名

listHypervisors


指定したクラウドゾーンに属する全てのハイパーバイザーの詳細情報の一覧を取得

します。




Xen と KVM、それぞれのハイパーバイザー種類別に以下の形式で応答します。


xen ハイパーバイザー形式が Xen の種類の情報が含まれます

kvm ハイパーバイザー形式が KVM の種類の情報が含まれます

cpu_cores ハイパーバイザーで使用中の CPU のコア数を返します

created_at ハイパーバイザーが GMOクラウドPublicのシステムの中で

作成された日時を返します



data_stores ハイパーバイザーが使用することができるデータストア ID

とそれぞれのデータストアの空きディスク容量を返します

データストアはデータストアグループに属します

フォーマットは以下の形式で、ディスク容量の単位は

GB(GigaBytes)です

17/205

”DataStore-ID”: Disk-Available-Size

data_store_group ハイパーバイザーが使用することができるデータストアグ

ループIDとそれぞれのデータストアグループの空きディス

ク容量を返します

データストアグループの空き容量は、属するデータストア

の空き容量の合計と一致します

フォーマットは以下の形式で、ディスク容量の単位は

GB(GigaBytes)です

”DataStoreGroup-ID”: Disk-Available-Size

disable_failover ハイパーバイザーがフェイルオーバーできるか否かを返し

ます

true : フェイルオーバーできない設定

false : 上記以外の設定

enabled ハイパーバイザーの利用可能状態を返します

true : ハイパーバイザーを利用可能な状態

false : 上記以外の状態

free_memory ハイパーバイザーにおいて、収容する仮想サーバーに割り

当てられていない空きメモリ容量を返します

単位は MB(MegaBytes)です

hypervisor_group_id ハイパーバイザーに割り当てられたハイパーバイザー・グ

ループ IDを返します

hypervisor_type ハイパーバイザーの種類を返します

id ハイパーバイザーの IDを返します

label ハイパーバイザーのラベルを返します

locked ハイパーバイザーのロック状態を返します

true : ハイパーバイザーがロックされている状態


memory_allocated_by_running

_vms

ハイパーバイザーにおいて、収容している全ての仮想サー

バーに割り当て済みのメモリの総容量を返します


memory_overhead ハイパーバイザーにおいて、全ての仮想サーバーに割り当

18/205

て済みのメモリの総容量から、稼働中の仮想サーバーに割

り当て済みのメモリの総容量を除いた残りのメモリ容量を

返します


online ハイパーバイザーの利用可能状態を返します

true : 利用可能な状態


total_cpus ハイパーバイザーの物理 CPU のコア数を返します

total_memory ハイパーバイザーにおいて使用可能なメモリの総容量を返

します


total_memory_allocated_by_v

ms

ハイパーバイザーにおいて全ての仮想サーバーに割り当て

済みのメモリの総容量を返します


updated_at ハイパーバイザーの終アップデート日時を返します



used_cpu_resources ハイパーバイザーにおける仮想 CPU コアの使用率をパーセ

ンテージで返します

used_memory ハイパーバイザーにおいて全ての仮想サーバーに割り当て

済みのメモリ容量とハイパーバイザーが使用するメモリの

オーバーヘッドの合計容量を返します



https://api.gmocloud.com/Cloud-Zone-ID/?Action=listHypervisors&AccessKeyId=Ac

cessKeyID&Version=1.0&Signature=Signature


{

"xen": {

"ID_of_HV": {

19/205

"label": "HV-Label-example",

"created_at": "2012-06-13T18:59:37+09:00",

"hypervisor_type": "xen",

"used_cpu_resources": 2491,

"memory_allocated_by_running_vms": 31088,

"updated_at": "2012-08-14T21:07:19+09:00",

"enabled": true,

"hypervisor_group_id": ID_of_HV-Group,

"id": ID_of_HV,

"total_memory": 147445,

"total_cpus": 24,

"memory_overhead": 4096,

"free_memory": 109189,

"cpu_cores": 12,

"locked": false,

"online": true,

"total_memory_allocated_by_vms": 34160,

"data_stores": {

"5": 39,

"25": 1470,

"1": 60,

"19": 24,

"13": 80,

"9": 80,

"23": 1176

},

"data_store_groups": {

"3": 2929

},

"used_memory": 38256

},

"kvm": {

"ID_of_HV": {


"created_at": "2012-08-09T12:16:31+09:00",

"hypervisor_type": "kvm",

20/205



"updated_at": "2012-08-14T21:07:22+09:00",

"enabled": true,


"id": ID_of_HV,


"total_cpus": 24,



"cpu_cores": 12,

"locked": false,

"online": true,


"data_stores": {

"15": 301,

"21": 463,

"17": 258,

"7": 481,

"3": 244,

"11": 344

},


"3": 2091

},


},

}

}

}

21/205

3.2. ハイパーバイザー詳細情報の取得

実行機能名

getHypervisor


指定されたハイパーバイザーの詳細情報を返します。

指定したハイパーバイザーの ID が無効である場合は、エラーを返します。




hypervisor_id ハイパーバイザーID

ハイパーバイザーの IDを指定します

ハイパーバイザーの IDは 3.1.

listHypervisors API で取得することができま

す

3.1. listHypervisors API のレスポンスオブジ

ェクトのうち id が該当します

○

Identifier ハイパーバイザーID

（上述の hypervisor_id と同意で、一定の期間

経過後にこのパラメーターは廃止します）

ハイパーバイザーの IDを指定します

ハイパーバイザーの IDは 3.1.

listHypervisors API で取得することができま

す

×

22/205


3.1. listHypervisors API と同じ形式で応答します。

詳細は 3.1. listHypervisors API のレスポンスオブジェクトをご参照ください。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=getHypervisor&AccessKeyId=Acce

ssKeyID&Version=1.0&hypervisor_id=ID_of_Hypervisor&Signature=Signature


{


"created_at": "2012-06-19T15:13:39+09:00",

"hypervisor_type": "xen",



"updated_at": "2012-08-14T21:49:30+09:00",

"enabled": true,


"id": ID_of_HV,


"total_cpus": 24,



"cpu_cores": 12,

"locked": false,

"online": true,


"data_stores": {

"5": 44,

"25": 1395,

"1": 60,

"19": 24,

"13": 80,

"9": 85,

23/205

"23": 1176

},


"3": 2864

},


}

24/205

4. Virtual Machine

4.1. 仮想サーバー一覧の取得

実行機能名

listNodes


指定したクラウドゾーンに属する全ての仮想サーバーの詳細情報の一覧を取得します。






autoscaleout オートスケールタイプのロードバランサー配下に属する仮

想サーバーの詳細情報を返します

cluster クラスタータイプのロードバランサー配下に属する仮想サ

ーバーの詳細情報を返します

vm 契約アカウントに属する全ての仮想サーバーのうち、オー

トスケールタイプならびにクラスタータイプそれぞれのロ

ードバランサー配下に属さない仮想サーバーの詳細情報を

返します

allow_resize_without_reboot 仮想サーバーを再起動せずに各リソースサイズの変更がで

きるか否かを返します

true : 再起動せずにサイズ変更可能


allowed_hot_migrate 仮想サーバーがホットマイグレーションをすることができ

25/205

るか否かを返します（仮想サーバー構築時の OSテンプレー

トに依存します）

true : ホットマイグレーションが可能


allowed_swap 仮想サーバーでスワップディスクの使用ができるか否かを

返します（仮想サーバー構築時の OS テンプレートに依存し

ます）

true : スワップディスクの使用が可能


booted 仮想サーバーの稼働状態を返します

true : 仮想サーバーが稼働中の状態


built 仮想サーバーの構築状態を返します

true : 構築済みの状態


cpu_shares 仮想サーバーに割り当てられている CPU 占有率を返します

cpus 仮想サーバーに割り当てられている仮想 CPU コア数を返し

ます

created_at 仮想サーバーの作成日時を返します

日時は下記のフォーマットで表されます


enable_autoscale 仮想サーバーにおけるオートスケールの設定状態を返しま

す

true : オートスケールの設定がされてる状態


enable_monitis 仮想サーバーにおいて、オートスケールのステータスを監

視するデーモンの稼動状態を返します

true : 有効な状態


26/205

hostname 仮想サーバーに設定されているホスト名を返します

hypervisor_id 仮想サーバーが使用するハイパーバイザーのIDを返します

id 仮想サーバーの IDを返します

identifier 仮想サーバーの識別子を返します

initial_root_password 仮想サーバーの初期の root パスワードを返します

ip 指定した仮想サーバーに割り当てられているIPアドレスを

返します

ip_addresses 仮想サーバーに割り当てられているIPアドレスとその詳細

情報を返します

このフィールドに含まれるパラメーターの詳細は、10.1.

listIpAddresses の項をご参照ください

label 仮想サーバーに設定したラベルを返します

locked 仮想サーバーのロック状態を返します

true : 仮想サーバーがロックされている状態


memory 仮想サーバーに割り当てられているメモリ容量を返します


min_disk_size 指定されたテンプレートから仮想サーバーを構築するため

に必要な少のディスクサイズを返します

note ユーザーアカウントに紐付いて登録した注意情報を返しま

す

operating_system 仮想サーバーが使用している OS の種類を返します

operating_system_distro 仮想サーバーの構築時に使用したOSのディストリビューシ

ョンの種類を返します

recovery_mode 仮想サーバーがリカバリーモードで起動している状態か否

かを返します

true : 仮想サーバーがリカバリーモードで起動中の状態


state 仮想サーバーの状態を返します

on : 起動中

off : 停止中

running : タスク実行中

27/205

pending : タスク実行待ち

suspended 仮想サーバーが停止中の状態か否かを返します

true : 仮想サーバーが停止中の状態


template_id 仮想サーバー構築時に指定したテンプレートのIDを返しま

す

template_label 仮想サーバー構築時に指定したテンプレートのラベル（名

称）を返します

total_disk_size 仮想サーバーに割り当てられている全てのディスクのディ

スク容量を返します

単位は GB(Giga Bites) です

type 指定した仮想サーバーの種類を返します

vm : 仮想サーバー

updated_at 仮想サーバーの設定が後にアップデートされた日時を返

します




https://api.gmocloud.com/Cloud-Zone-ID/?Action=listNodes&AccessKeyId=AccessKe

yID&Version=1.0&Signature=Signature


{

"vm": {

"ID_of_VM": {

"cpus": 1,

"label": "VM-Label-example",

"created_at": "2012-08-10T12:37:40+09:00",

"operating_system_distro": "rhel",

"cpu_shares": 1,

28/205

"enable_autoscale": false,

"operating_system": "linux",

"template_id": ID_of_Template,

"allowed_swap": true,

"memory": 128,

"updated_at": "2012-08-22T14:17:02+09:00",

"allow_resize_without_reboot": true,

"recovery_mode": null,

"enable_monitis": false,

"hypervisor_id": ID_of_Hypervisor,

"id": ID_of_VM,

"allowed_hot_migrate": true,

"note": null,

"suspended": false,

"booted": false,

"hostname": "gmocloud1.example.com",

"template_label": "Template-Label-example",

"total_disk_size": 6,


"initial_root_password": "Password",

"min_disk_size": 5,

"built": true,

"locked": true,

"state": "locked",

"ip_addresses": {

"ID_of_IpAddress": {

"address": "192.168.0.100",

"disallowed_primary": false,

"netmask": "255.255.255.0",

"created_at": "2012-08-10T09:12:23+09:00",

"broadcast": "192.168.0.255",

"updated_at": "2012-08-10T09:12:23+09:00",

"network_id": ID_of_Network,

"network_address": "192.168.0.0",

"free": false,

"id": ID_of_IpAddress,

29/205

"gateway": "192.168.0.254"

}

},

"ip": [

"192.168.0.100"

],

"type": "vm"

}

},

"cluster": {

"ID_of_VM": {

"cpus": 1,

"label": "Template-Label-example",

"created_at": "2012-08-22T12:26:52+09:00",


"cpu_shares": 1,





"memory": 128,

"updated_at": "2012-08-22T14:17:02+09:00",





"id": ID_of_VM,


"note": null,

"suspended": false,

"booted": true,

"hostname": "gmocloud2.example.jp",

"template_label": "Template-Label-examplen",




30/205

"min_disk_size": 5,

"built": true,

"locked": false,

"state": "on",

"ip_addresses": {


"address": "192.168.0.101",


"netmask": "255.255.255.0",

"created_at": "2012-08-17T17:29:17+09:00",

"broadcast": "192.168.0.255",

"updated_at": "2012-08-17T17:29:17+09:00",



"free": false,


"gateway": "192.168.0.254"

}

},

"ip": [

"192.168.0.101"

],

"type": "vm"

},

"ID_of_VM": {

"cpus": 1,


"created_at": "2012-08-22T12:28:13+09:00",


"cpu_shares": 1,





"memory": 128,

"updated_at": "2012-08-22T14:17:02+09:00",

31/205





"id": ID_of_VM,


"note": null,

"suspended": false,

"booted": true,






"min_disk_size": 5,

"built": true,

"locked": false,

"state": "on",

"ip_addresses": {


"address": "192.168.0.102",


"netmask": "255.255.255.0",

"created_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",

"updated_at": "2012-08-17T17:30:35+09:00",



"free": false,


"gateway": "192.168.0.254"

}

},

"ip": [

"192.168.0.102"

],

32/205

"type": "vm"

}

},

"autoscaleout": {

"ID_of_VM": {

"cpus": 1,


"created_at": "2012-08-22T12:48:27+09:00",


"cpu_shares": 5,

"enable_autoscale": null,




"memory": 128,

"updated_at": "2012-08-22T14:17:02+09:00",



"enable_monitis": true,


"id": ID_of_VM,


"note": null,

"suspended": false,

"booted": true,






"min_disk_size": 5,

"built": true,

"locked": false,

"state": "on",

"ip_addresses": {


33/205

"address": "192.168.0.103",


"netmask": "255.255.255.0",

"created_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",

"updated_at": "2012-08-17T17:30:35+09:00",



"free": false,


"gateway": "192.168.0.254"

}

},

"ip": [

"192.168.0.103"

],

"type": "vm"

}

}

}

34/205

4.2. 仮想サーバーの詳細情報の取得

実行機能名

getNode


指定した仮想サーバーの詳細情報を返します。

指定した仮想サーバーIDが無効であるか、存在しない場合はエラーを返します。





（後述の virtual_machine_id と同意で、一定

の期間経過後にこのパラメーターは廃止しま

す）


この Identifier か virtual_machine_id のい

づれかが必須です


取得できます

4.1. listNodes API のレスポンスオブジェクト

のうち、identifier が該当します

（ ○ ）

virtual_machine_id 仮想サーバーID

仮想サーバーの IDを指定します

この virtual_machine_id か Identifier のい

づれかが必須です

仮想サーバーID は 4.1. listNodes API で取得

できます

（ ○ ）

35/205


のうち、id が該当します


4.1. listNode と同じ形式で応答します。

詳細は 4.1. listNode のレスポンスオブジェクトをご参照ください。

なお、4.1. listNode のレスポンスに含まれないオブジェクトについては以下の通りで

す。


backup 指定した仮想サーバーのバックアップのサイズ（容量）を返

します

backups 指定した仮想サーバーのバックアップの状況とバックアッ

プサイズを返します

（このフィールドに含まれるパラメーターの詳細は 6.1.

listBackups の項をご参照ください）

backup_size 指定した仮想サーバーのバックアップのサイズ（容量）の合

計値を返します

disks 指定した仮想サーバーに割り当てられているディスクとそ

の詳細情報を返します

（このフィールドに含まれるパラメーターの詳細は 5.1.

listDisks の項をご参照ください）

ip 指定した仮想サーバーに割り当てられている IP アドレスを

返します

network_interfaces 指定した仮想サーバーで設定されているネットワークイン

ターフェースの詳細情報を返します

このフィールドに含まれるパラメーターの詳細は 7.1.

listNetworkInterfaces の項をご参照ください

type 指定した仮想サーバーの種類を返します

VM : 仮想サーバー

LB : ロードバランサー


36/205

https://api.gmocloud.com/Cloud-Zone-ID/?Action=getNode&AccessKeyId=

AccessKeyId &Version=1.0&Identifier=Id_of_VM&Signature=Signature


{

"cpus": 1,


"created_at": "2012-07-19T12:32:33+09:00",


"cpu_shares": 1,



"template_id": 9,


"memory": 128,

"updated_at": "2012-07-20T23:42:51+09:00",


"recovery_mode": false,


"hypervisor_id": Id_of_HV,

"id": Id_of_VM,


"note": null,

"suspended": false,

"booted": true,

"hostname": "gmocloud.example.jp",

"template_label": "CentOS 6.0 LAMP x64 xen",




"min_disk_size": 5,

"built": true,

"locked": false,

"state": "on",

"ip_addresses": [

37/205

{

"ip_address": {

"address": "192.168.0.100",


"netmask": "255.255.255.0",

"created_at": "2012-06-13T19:59:42+09:00",

"broadcast": "192.168.0.255",

"updated_at": "2012-06-13T19:59:42+09:00",

"network_id": Id_of_Network,


"free": false,

"id": Id_of_IPaddress,

"gateway": "192.168.0.254"

}

}

],

"type": "vm",

"ip": [

"192.168.0.100"

],

"disks": {

"Id_of_disk": {

"created_at": "2012-07-19T12:32:33+09:00",

"add_to_linux_fstab": null,

"disk_size": 5,

"updated_at": "2012-07-19T12:32:46+09:00",

"primary": true,

"data_store_id": Id_of_DataStore,

"id": Id_of_disk,

"disk_vm_number": 1,

"is_swap": false,

"mount_point": null,

"identifier": "Identifier_of_Disk",

"virtual_machine_id": Id_of_VM,

"has_autobackups": true,

"built": true,

38/205

"locked": false

},

}

"backup": [

"210520",

"210540"

],

"backup_size": 421060,

"network_interfaces": {

"Id_of_NetworkInterface": {

"label": "eth0",

"created_at": "2012-07-19T12:32:33+09:00",

"usage": null,

"updated_at": "2012-07-20T23:50:59+09:00",

"primary": true,

"id":Id_of_VM,

"usage_month_rolled_at": null,

"mac_address": "00:00:00:00:00:00",

"default_firewall_rule": "ACCEPT",

"usage_last_reset_at": null,

"rate_limit": 1,

"identifier": "Identifier_of_NetworkInterface ",

"network_join_id": Id_of_Network_join_id,

"virtual_machine_id": Id_of_VM

}

}

}

39/205

4.3. 仮想サーバーの起動

実行機能名

startupNode


指定した仮想サーバーを起動します







取得できます



○

Recovery リカバリーモード指定

リカバリーモードで起動するか否かを指定しま

す

true : リカバリーモードで起動する

false : リカバリーモードで起動しない

デフォルト値は false で、このパラメーターが

指定されていない場合は false が指定されたも

のとして処理されます

×

40/205


指定した仮想サーバーの起動のリクエストに成功した場合は true を返します。

指定した仮想サーバーの起動のリクエストに失敗した場合は、内容に応じたエラーメ

ッセージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=startupNode&AccessKeyId=Access

KeyId&Version=1.0&Identifier=Identifier_of_VM&Recovery=false&Signature=Signat

ure


true

41/205

4.4. 仮想サーバーの停止・シャットダウン

実行機能名

shutdownNode


指定した仮想サーバーを停止・シャットダウンします。







取得できます



○


指定した仮想サーバーの停止・シャットダウンのリクエストに成功した場合は true

を返します。

指定した仮想サーバーの停止・シャットダウンのリクエストに失敗した場合は、内容

に応じたエラーメッセージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=shutdownNode&AccessKeyId=Acces

sKeyId&Version=1.0&Identifier=Identifier_of_VM&Signature=Signature

42/205


true

43/205

4.5. 仮想サーバーの再構築と起動

実行機能名

buildNode


指定した仮想サーバーの初期化を行い、予め作成してあるユーザーテンプレートから

仮想サーバーの再構築（再作成）をします。

仮想サーバーの再構築後の稼動状態を指定することができます。







取得できます



○

template_id テンプレート ID

仮想サーバーの構築時に使用するテンプレート

ID を指定します

システムテンプレートとユーザーテンプレート

の IDは、11.1 listImages API で取得できます

11.1 listImages API のレスポンスオブジェクト


○

required_startup VM 起動指定

仮想サーバー構築後にサーバーを起動するか否

かを指定します

×

44/205

1 : 仮想サーバーを起動します

0 : 仮想サーバーを起動しません


指定した仮想サーバーの再構築と、起動を指定している場合には起動のリクエストが

成功した場合は true を返します。

指定した仮想サーバーの再構築と、起動を指定している場合には起動のリクエストが

失敗した場合は、内容に応じたエラーメッセージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=buildNode&AccessKeyId=

AccessKeyId &Version=1.0&Identifier=Identifier &template_id=User_Template_id

&required_startup=1&Signature=Signature


true

45/205

4.6. 仮想サーバーの再構築

実行機能名

rebuildNode


指定した仮想サーバーの初期化を行い、その時点で使用しているテンプレートと同じ

ID のテンプレート（ユーザーテンプレートを使用している場合は同じ IDのユーザーテ

ンプレート）を使用して仮想サーバーの再構築（再作成）をします。

再構築後の仮想サーバーは稼動停止状態です。







取得できます


ち、identifier が該当します

○


指定した仮想サーバーの再構築のリクエストに成功した場合は true を返します。

指定した仮想サーバーの再構築のリクエストに失敗した場合は、内容に応じたエラー

メッセージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=rebuildNode&AccessKeyId=Acces

sKeyId&Version=1.0&Identifier=Identifier_of_VM&Signature=Signature

46/205


true

47/205

4.7. 仮想サーバーの作成

実行機能名

deployNode


仮想サーバーを構築します。

仮想サーバーの構築完了後、仮想サーバーを起動します。






の IDを指定します



11.1 listImages のレスポンスオブジェクトの

うち、id が該当します

○

Identifier テンプレート ID

（上述の template_id と同意で、一定の期間経

過後にこのパラメーターは廃止します）


の IDを指定します



11.1 listImages のレスポンスオブジェクトの


×

cpu_shares CPU 占有率

×

48/205

構築する仮想サーバーのハイパーバイザーに

Xen を選択する場合、仮想 CPU の占有率を任意

の数値で指定できます

このパラメーターを指定しない場合の初期値は

1です

ハイパーバイザーに KVM を選択した場合は 100

で固定されます

cpus CPU コア数

構築する仮想サーバーに割り当てる仮想 CPU コ

ア数を指定します

○

data_store_group_primary_id ディスクデータストア ID

構築する仮想サーバーに割り当てるプライマリ

ディスクのデータストアゾーンの ID を指定し

ます

データストアゾーンの ID は、 12.1.

listDatastores API で取得できます

12.1 listDatastores API のレスポンスオブジ

ェクトのうち、idが該当します

×

data_store_group_swap_id スワップデータストア ID

構築する仮想サーバーに割り当てるスワップデ

ィスクのデータストアゾーンの ID を指定しま

す

データストアゾーンの ID は、 12.1.

listDatastores API で取得できます

12.1 listDatastores API のレスポンスオブジ


×

hostname ホスト名

構築する仮想サーバーの hostname を指定しま

す

○

hypervisor_group_id ハイパーバイザーグループ ID

仮想サーバーを構築するハイパーバイザーに割

×

49/205

り当てられたハイパーバイザーグループ ID を

指定します

ハイパーバイザーグループ ID を指定しない場

合は、GMO クラウド Public の中で利用できるい

づれかのハイパーバイザーに仮想サーバーが構

築されます

ハイパーバイザーグループ ID は、 3.1

listHypervisors API で取得できます

3.1 listHypervisors API のレスポンスオブジ

ェクトのうち、hypervisor_group_id が該当し

ます


仮想サーバーを構築するハイパーバイザーのID

を指定します

ハイパーバイザーID を指定しない場合は、GMO

クラウド Public の全てのハイパーバイザーの

うち、もメモリ容量の残りがあるハイパーバ

イザーの中に構築されます

ハイパーバイザーID は、3.1 listHypervisors

API で取得できます

3.1 listHypervisors API のレスポンスオブジ

ェクトのうち、id が該当します

×

initial_root_password root パスワード

構築する仮想サーバーの root ユーザーの初期

パスワードを指定します

パスワードは以下の文字列を使用することがで

きます

・ 6 文字以上 32文字以内

・ A から Zまでの半角英大文字

・ a から zまでの半角英小文字

・ 0 から 9までの半角数字

・ -（ハイフン）、_（アンダースコア）

初期パスワードの文字列を何も指定しない場

×

50/205

合、GMO クラウド Public のシステムがランダム

な文字列で生成したパスワードを設定します

label ラベル

構築する仮想サーバーのラベルを指定します

仮想サーバーを複数構築する場合など、判別し

やすくするためのものです

○

memory メモリ[MB]

構築する仮想サーバーに割り当てるメモリ容量

を指定します

単位は MB (MegaBytes)です

○

note メモ

構築する仮想サーバーに付加できるコメントを

指定します

×

primary_disk_size ディスクサイズ[GB]

構築する仮想サーバーのプライマリディスクの

ディスクサイズ（ディスク容量）を指定します

単位は GB (GigaBytes)です

○

primary_network_group_id ネットワークグループ ID

構築する仮想サーバーに割り当てるネットワー

クグループの ID を指定します

ネットワークグループIDは、8.1. listNetworks


8.1. listNetworks API のレスポンスオブジェ

クトのうち、network_group_id が該当します

×

primary_network_id ネットワーク ID


クの ID を指定します

ネットワーク ID は、8.1. listNetworks API で

取得できます

×

51/205


クトのうち、id が該当します

rate_limit 帯域[Mbps]


クのポートスピードを指定します

単位は Mbps です

○

required_automatic_backup 自動バックアップ指定

構築する仮想サーバーで自動バックアップを行

う指定をします

1 : 自動バックアップを行う設定

0 : 自動バックアップを行わない設定

×

required_virtual_machine_build サーバー構築

構築する仮想サーバーで構築して起動させるか

を指定をします

1 : 構築して起動する

0 : 仮想サーバーの確保のみ行う

×

selected_ip_address_id IP アドレス

構築する仮想サーバーに割り当てる IP アドレ

スを指定します

指定できる IP アドレスは 9.1.

listIpAddresses API で取得できます

9.1 listIpAddresses API のレスポンスオブジ

ェクトのうち、free パラメーターが true の

IP アドレスの id が該当します

×

swap_disk_size スワップディスク容量

構築する仮想サーバーに割り当てるスワップデ

ィスクのディスクサイズ（ディスク容量）を指

定します


○

52/205

Windows 系 OSの場合にはスワップディスクはあ

りません


以下の形式で応答します


Identifier 仮想サーバーの構築のリクエストに成功した場合、仮想サ

ーバーに割り当てられる Identifier を返します


https://api.gmocloud.com/Cloud-Zone-ID/?Action=deployNode&AccessKeyId=AccessK

eyId&Version=1.0&template_id=ID_of_Template&cpu_shares=1&cpus=1&data_store_gr

oup_primary_id=ID_of_DataStore-Group&data_store_group_swap_id=ID_of_DataStore

-Group&hostname=gmocloud.example.com&hypervisor_group_id=ID_of_HV-Group&hyper

visor_id=ID_of_HV&initial_root_password=Password&label=VM-Label-example&memor

y=128&note=memo&primary_disk_size=5&primary_network_group_id=ID_of_Network-Gr

oup&primary_network_id=ID_of_Network&rate_limit=1&required_automatic_backup=0

&required_virtual_machine_build=0&selected_ip_address_id=ID_of_IPaddress&swap

_disk_size=1&Signature=Signature


{

"identifier": "Identifier_of_VM"

}

53/205

4.8. 仮想サーバーの削除

実行機能名

destroyNode


指定した仮想サーバーを削除します。







取得できます



○


指定した仮想サーバーの削除のリクエストに成功した場合は true を返します。

指定した仮想サーバーの削除のリクエストに失敗した場合は、内容に応じたエラーメ



https://api.gmocloud.com/Cloud-Zone-ID/?Action=destroyNode&AccessKeyId=Access

KeyId&Version=1.0&Identifier=Identifier_of_VM&Signature=Signature

54/205


true

55/205

4.9. 仮想サーバーの設定編集

実行機能名

editNode


仮想サーバーの設定を変更します。





対象の仮想サーバーの識別子を指定します

仮想サーバー識別子は 4.1. listNodes API で取

得できます。


のうち、identifier が該当します。

○

label ラベル

変更後のラベルを指定します

×

note メモ

変更後の付加コメントを指定します

×


指定したディスクの設定変更のリクエストに成功した場合は true を返します。

指定したディスクの設定変更のリクエストに失敗した場合は、内容に応じたエラーメ


56/205


https://api.gmocloud.com/Cloud-Zone-ID/?Action=editNode&AccessKeyId=AccessKey

Id&Version=1.0&Identifier=Identifier_of_VM&label=VM-Label-example&note=Note-e

xample&Signature=Signature


true

57/205

4.10. 仮想サーバーの root パスワードの初期化

実行機能名

resetPasswordNode


仮想サーバーの root パスワードを初期化します。

システムによって自動的にランダムに割り当てられる英数字に置き換えます。





対象の仮想サーバーの識別子を指定します

仮想サーバー識別子は 4.1. listNodes API で取

得できます。


のうち、identifier が該当します。

○


root パスワードの初期化のリクエストに成功した場合は true を返します。

root パスワードの初期化のリクエストに失敗した場合は、内容に応じたエラーメッセ

ージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=resetPasswordNode&AccessKeyId=

AccessKeyId&Version=1.0&Identifier=Identifier_of_VM&Signature=Signature

58/205


true

59/205

4.11. 仮想サーバーの再起動

実行機能名

rebootNode


稼働中の仮想サーバーを再起動します。







取得できます



○

Recovery リカバリーモード指定

再起動時にリカバリーモードで仮想サーバーを

起動するか否かを指定します

true : リカバリーモードで起動する

false : リカバリーモードで起動しない

デフォルト値は false で、このパラメーターが

指定されていない場合は false が指定されたも

のとして処理されます

×

60/205


指定した仮想サーバーの再起動のリクエストに成功した場合は true を返します。

指定した仮想サーバーの再起動のリクエストに失敗した場合は、内容に応じたエラー



https://api.gmocloud.com/Cloud-Zone-ID/?Action=rebootNode&AccessKeyId=Access



true

61/205

4.12. 仮想サーバーのマイグレーション

実行機能名

migrateNode


仮想サーバーを異なる別の物理マシン上に移動します。







取得できます



○

destination ハイパーバイザーID

マイグレーション先のハイパーバイザーのIDを

指定します

ハイパーバイザーID は、3.1. listHypervisors




○

cold_migrate_on_rollback ロールバック方法

ホットマイグレーション失敗時の振る舞いを指

定します

1 : コールドマイグレーションに切り替えます

×

62/205

0 : マイグレーションを取り止めます


指定した仮想サーバーのマイグレーションのリクエストに成功した場合は true を返

します。

指定した仮想サーバーのマイグレーションのリクエストに失敗した場合は、内容に応

じたエラーメッセージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=migrateNode&AccessKeyId=Access

KeyId&Version=1.0&Identifier=Identifier_of_VM&destination=ID_of_HV&cold_migra

te_on_rollback=1&Signature=Signature


true

63/205

4.13. 仮想サーバーのリソース割り当て変更

実行機能名

resizeNode


仮想サーバーのリソース割り当てを変更します。







取得できます



○

allow_cold_resize ロールバック方法

仮想サーバーの再起動を伴わずにリソース変更

をすることに失敗した場合の振る舞いを指定し

ます

1 : 再起動を伴うリソース変更に切り替えます

0 : リソース変更を取り止めます

×

cpu_shares CPU 占有率

仮想サーバーに割り当てたい仮想 CPU の占有率

を指定します

×

cpus CPU コア数

仮想サーバーに割り当てたい仮想 CPU コア数を

×

64/205

指定します

memory メモリ[MB]

仮想サーバーに割り当てたいメモリサイズ（メ

モリ容量）を指定します

×


指定した仮想サーバーのリソース変更のリクエストに成功した場合は true を返しま

す。

指定した仮想サーバーのリソース変更のリクエストに失敗した場合は、内容に応じた

エラーメッセージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=resizeNode&AccessKeyId=AccessK

eyId&Version=1.0&Identifier=Identifier_of_VM&memory=129&cpus=2&cpu_shares=2&a

llow_cold_resize=1&Signature=Signature


true

65/205

5. Disk

5.1. ディスク一覧の取得

実行機能名

listDisks


ディスクの一覧を取得します。

仮想サーバーの IDが指定されている場合は、当該仮想サーバーに接続されているディ

スクの一覧を返します。

それ以外の場合には、GMOクラウドPublicのシステム内のディスクの一覧を返します。







取得できます



×




add_to_linux_fstab ディスクがLinuxの fstab に追加されている状態か否かを

返します

66/205

true : fstab に追加されている状態

false : fstab に追加されていない状態

built 仮想サーバーの構築状態を返します

true : 仮想サーバーが稼働中の状態


created_at ディスクが作成された日時を返します



data_store_id 当該ディスクが属するデータストアの ID を返します

disk_size 当該ディスクのディスクサイズ（ディスク容量）を返しま

す


disk_vm_number 当該ディスクを使用する仮想サーバーでの追加順を返しま

す

has_autobackups 当該ディスクの自動バックアップの設定状態を返します

true : 自動バックアップを行う設定

false : 自動バックアップを行わない設定

id 当該ディスクに割り当てられている IDを返します

identifier 当該ディスクに割り当てられている識別子を返します

is_swap 当該ディスクがスワップディスクか否かを返します

true : スワップディスク

false : スワップディスクではない

locked 当該ディスクのロック状態を返します

true : ディスクがロックされている状態


mount_point 当該ディスクに設定されているマウントポイントを返しま

す

primary 当該ディスクがプライマリディスクか否かを返します

true : プライマリディスク

67/205

false : プライマリディスクではない

updated_at 当該ディスクの設定が後にアップデートされた日時を返

します



virtual_machine_id 当該ディスクが接続されている仮想サーバーのIDを返しま

す


https://api.gmocloud.com/Cloud-Zone-ID/?Action=listDisks&AccessKeyId=AccessKe

yId&Version=1.0&Signature=Signature


{

"Id_of_Disks": {

"created_at": "2012-07-19T12:32:33+09:00",


"disk_size": 5,

"updated_at": "2012-07-19T12:32:46+09:00",

"primary": true,

"data_store_id": Id_of_DataStore,

"id": Id_of_Disks,


"is_swap": false,


"identifier": "Identifier_of_Disks ",

"virtual_machine_id":Id_of_VM,


"built": true,

"locked": false

}

}

68/205

5.2. ディスクの詳細情報の取得

実行機能名

getDisk


指定したディスクの詳細情報を返します。




disk_id ディスク ID

ディスクに割り当てられているIDを指定します

ディスク ID は 5.1. listDisks API で取得でき

ます

5.1. listDisks API のレスポンスオブジェクト


○


5.1. listDisks API と同じ形式で応答します。

詳細は 5.1. listDisks API のレスポンスオブジェクトをご参照ください。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=getDisk&AccessKeyId=AccessKeyI

d&Version=1.0&disk_id=Id_of_Disk&Signature=Signature


{

"created_at": "2012-07-19T12:32:33+09:00",

69/205


"disk_size": 6,

"updated_at": "2012-07-26T17:56:56+09:00",

"primary": true,

"data_store_id": 1,

"id": ID_of_Disk,


"is_swap": false,



"virtual_machine_id": ID_of_VM,


"built": true,

"locked": false

}

70/205

5.3. ディスクの追加

実行機能名

attachDisk


指定した仮想サーバーにディスクを追加します。





ディスクを追加する対象になる仮想サーバーの

識別子を指定します


取得できます



○

data_store_id データストア ID

対象のディスクを属させるデータストアのIDを

指定します

○

disk_size ディスクサイズ[GB]

対象のディスクのディスクサイズ（ディスク容

量）を指定します

単位は GB (GigaByte)です

○

is_swap スワップ指定

対象のディスクをスワップディスクにするか否


×

71/205

true : スワップディスク

false : スワップディスクではない

mount_point マウントポイント指定

対象のディスクに割り当てるマウントポイント

を指定します

×

add_to_linux_fstab fstab 追加指定

対象のディスクを /etc/fstab に追加するか否


/etc/fstab に追加する場合は、後述の

require_format_disk パラメーターで true を

指定して、ディスクをフォーマットする必要が

あります

true : fstab に追加する

false : fstab に追加しない

×

require_format_disk ディスクフォーマット要求

対象のディスクをフォーマットするか否かを指

定します

1 : フォーマットする

0 : フォーマットしない

×


指定したディスクの追加のリクエストに成功した場合は、以下の形式で応答します


disk_id 追加したディスクに割り当てられた idを返します

指定したディスクの追加のリクエストに失敗した場合は、内容に応じたエラーメッセ


72/205


https://api.gmocloud.com/Cloud-Zone-ID/?Action=editDisk&AccessKeyId=AccessKey

Id&Version=1.0&disk_id=ID_of_Disk&disk_size=6&has_autobackups=false&Signature

=Signature


{

"disk_id": ID_of_Disk

}

73/205

5.4. ディスクの削除

実行機能名

detachDisk


指定した仮想サーバーから特定のディスクを削除します。







ます



○


指定したディスクの削除のリクエストに成功した場合は true を返します。

指定したディスクの削除のリクエストに失敗した場合は、内容に応じたエラーメッセ



https://api.gmocloud.com/Cloud-Zone-ID/?Action=detachDisk&AccessKeyId=AccessK

eyId&Version=1.0&disk_id=ID_of_Disk&Signature=Signature


true

74/205

5.5. ディスクの設定変更

実行機能名

editDisk


指定したディスクのディスクサイズと自動バックアップの設定を変更します。

なお、対象のディスクはビルドが完了している必要があります。







ます



○

disk_size ディスクサイズ[GB]

変更後のディスクのディスクサイズ（ディスク

容量）を指定します

なお、減量することはできません

単位は GB (GigaByte)です

○

has_autobackups 自動バックアップ指定

対象のディスクを自動バックアップするか否か

を指定します

true : 自動バックアップを行う

false : 自動バックアップを行わない

○

75/205


指定したディスクの設定変更のリクエストに成功した場合は true を返します。

指定したディスクの設定変更のリクエストに失敗した場合は、内容に応じたエラーメ



https://api.gmocloud.com/Cloud-Zone-ID/?Action=editDisk&AccessKeyId=AccessKey

Id&Version=1.0&disk_id=ID_of_Disk&disk_size=2&has_autobackups=true&Signature=

Signature


true

76/205

5.6. ディスクのバックアップの作成

実行機能名

createBackup


指定したディスクのバックアップを作成します。

なお、対象のディスクはビルドが完了している必要があります。

また、スワップディスクは指定できません。







ます



○


指定したディスクのバックアップ作成のリクエストに成功した場合は true を返しま

す。

指定したディスクのバックアップ作成のリクエストに失敗した場合は、内容に応じた



https://api.gmocloud.com/Cloud-Zone-ID/?Action=createBackup&AccessKeyId=Acces

sKeyId&Version=1.0&disk_id=Identifier_of_Disk&Signature=Signature

77/205


true

78/205

6. Backup

6.1. 仮想サーバーのバックアップ一覧の取得

実行機能名

listBackups


仮想サーバーのバックアップ一覧を返します。バックアップが存在しない場合、空の

配列を返します。

指定した仮想サーバーの ID が無効であるか、あるいは存在しない場合は、エラーを返

します。







取得できます



○




allow_resize_without_reboot 仮想サーバーのバックアップを再起動せずに CPU とメモリ

のサイズ変更ができるか否かを返します

79/205



allowed_hot_migrate 仮想サーバーのバックアップがホットマイグレーションを

することができるか否かを返します



allowed_swap 仮想サーバーのバックアップでスワップディスクの使用が

できるか否かを返します



backup_size 当該バックアップで使用しているディスク容量を返します


backup_type 当該バックアップのバックアップタイプを返します

built 当該バックアップのビルド状態を返します

true : ビルド済みの状態


built_at 当該バックアップが完了した日時を返します



created_at 当該バックアップがビルド済みもしくは実行待ちになった

日時を返します



disk_id 当該バックアップの対象のディスクの ID を返します

id 当該バックアップの IDを返します

identifier 当該バックアップの識別子を返します

locked 当該仮想サーバーのバックアップのロック状態を返します

true : バックアップがロックされている状態


80/205

min_disk_size 少のディスクサイズを返します

operating_system 当該仮想サーバーのバックアップが仮想サーバー構築時に

使用した OS の種類を返します

operating_system_distro 当該仮想サーバーのバックアップが仮想サーバー構築時に

使用した OS のディストリビューションの種類を返します

template_id 当該仮想サーバーのバックアップが仮想サーバー構築時に

指定したテンプレートの ID を返します

updated_at 当該バックアップが後にアップデートされた日時を返し

ます




https://api.gmocloud.com/Cloud-Zone-ID/?Action=listBackups&AccessKeyId=Access



{

"Id_of_Backups": {

"built_at": "2012-07-19T12:37:49+09:00",

"disk_id": Id_of_Disk,

"marked_for_delete": false,

"created_at": "2012-07-19T12:35:48+09:00",


"min_memory_size": 128,


"template_id": 9,


"backup_type": "normal",

"updated_at": "2012-07-19T12:37:50+09:00",


"id": Id_of_Backups,


81/205

"backup_server_id": null,

"backup_size": "210520",

"identifier": "Identifier_of_Backups",

"min_disk_size": 5,

"built": true,

"locked": false

}

}

82/205

6.2. バックアップからテンプレートへのコンバート

実行機能名

convertBackup


バックアップからテンプレートへコンバートします。

仮想サーバー作成時のテンプレートとして使用できるようになります。




backup_id バックアップ ID

バックアップに割り当てられているIDを指定し

ます

仮想サーバーの識別子は 6.1. listBackups API

で取得できます

6.1. listBackups API のレスポンスオブジェク

トのうち、id が該当します

○

label ラベル

テンプレートのラベルを指定します

システムテンプレートとの区別や、複数のユー

ザーテンプレートを作成する場合などに判別し

やすくするためのものです

○

min_disk_size 必要ディスクサイズ[GB]

作成するテンプレートから仮想サーバーを構築

する際に、仮想サーバーに割り当てるべき少

のプライマリディスクのディスクサイズ（ディ

スク容量）を指定します


×

83/205

min_memory_size 必要メモリ[MB]

作成するテンプレートから仮想サーバーを構築

する際に、仮想サーバーに割り当てるべき少

のメモリ容量を指定します


×


バックアップからテンプレートへのコンバートのリクエストに成功した場合は true

を返します。

バックアップからテンプレートへのコンバートのリクエストに失敗した場合は、内容



https://api.gmocloud.com/Cloud-Zone-ID/?Action=convertBackup&AccessKeyId=Acce

ssKeyId&Version=1.0&backup_id=ID_of_Backup&label=UserTemplate-Label-example&m

in_disk_size=5&min_memory_size=128&Signature=Signature


true

84/205

7. Network Interface

7.1. ネットワークインターフェース一覧の取得

実行機能名

listNetworkInterfaces


指定した仮想サーバーに割り当てられたネットワークインターフェースの一覧を返し

ます。

指定した仮想サーバーの ID が無効であるか、あるいは存在しない場合は、エラーを返

します。







取得できます



○




created_at ネットワークインターフェースの設定がされた日時を返し

ます

85/205



default_firewall_rule 当該ネットワークインターフェースのファイアーウォール

の設定において指定されているデフォルトファイアーウォ

ールルールを返します

ACCEPT

DROP

id 当該ネットワークインターフェースの ID を返します

identifier 当該ネットワークインターフェースの識別子を返します

label 当該ネットワークインターフェースに設定されているラベ

ルを返します

mac_address 当該ネットワークインターフェースに割り当てられている

MAC Address を返します

network_id 当該ネットワークインターフェースが接続するネットワー

ク IDを返します

ネットワーク ID は 8.1. listNetworks API で取得できま

す

8.1. listNetworks API のレスポンスオブジェクトのうち

id が該当します

network_join_id 当該ネットワークインターフェースにハイパーバイザーか

ら割り当てられた ID を返します

primary 当該ネットワークインターフェースがプライマリインター

フェースとして設定されているかを返します

true : プライマリインターフェースとして設定されてい

る状態


rate_limit 当該ネットワークインターフェースで設定されているポー

トスピードを返します


updated_at 当該ネットワークインターフェースの設定が後にアップ

デートされた日時を返します


86/205


usage 当該ネットワークインターフェースの設定が初に作成さ

れた日時を返します



virtual_machine_id 当該ネットワークインターフェースが接続されている仮想

サーバーの IDを返します


https://api.gmocloud.com/Cloud-Zone-ID/?Action=listNetworkInterfaces&AccessKe

yId=AccessKeyId&Version=1.0&Identifier=Identifier_of_VM&Signature=Signature


{

"Id_of_NetworkInterface ": {

"label": "eth0",

"created_at": "2012-07-19T12:32:33+09:00",

"usage": null,

"updated_at": "2012-07-25T20:26:06+09:00",

"primary": true,

"id": Id_of_NetworkInterface,


"mac_address": "00:00:00:00:00:00",

"default_firewall_rule": "DROP",


"rate_limit": 1,

"identifier": "Identifier_of_NetworkInterface ",

"network_join_id": Id_of_Network_Join,

"virtual_machine_id": Id_of_VM,

"network_id": Id_of_Network

}

}

87/205

88/205

7.2. ネットワークインターフェースの追加

実行機能名

attachNetworkInterface


指定した仮想サーバーにネットワークインターフェースを追加します。







取得できます



○

label ラベル

追加したいネットワークインターフェースに割

り当てる識別用のラベルを指定します

○


追加したいネットワークインターフェースに割

り当てるポートスピードを指定します


○

network_id ネットワーク ID

追加したいネットワークインターフェースを接

続させるネットワーク IDを指定します

network_id は 8.1. listNetworks API で取得で

○

89/205

きます

8.1. listNetworks API のレスポンスオブジェク


primary プライマリ指定

追加したいネットワークインターフェースをプ

ライマリインターフェースとして設定するか否


1 : プライマリインターフェースとして設定す

る

0 : プライマリインターフェースとして設定し

ない

○


指定したネットワークインターフェースの追加のリクエストに成功した場合は、以下の

形式で応答します


network_interface_id 追加したネットワークインターフェースに割り当てられた

id を返します

指定したディスクの追加のリクエストに失敗した場合は、内容に応じたエラーメッセ



https://api.gmocloud.com/Cloud-Zone-ID/?Action=attachNetworkInterface&AccessK

eyId=AccessKeyId&Version=1.0&Identifier=Identifier_of_VM&label=NetworkInterfa

ce-Label-example&rate_limit=1&network_id=Id_of_networkid&primary=0&Signature=

Signature


{

"network_interface_id": ID_of_NetworkInterface

}

90/205

7.3. ネットワークインターフェースの編集

実行機能名

editNetworkInterface


指定した仮想サーバーの特定のネットワークインターフェースの編集をします。

設定内容を有効にするには rebuildNetwork API を実行する必要があります。







取得できます



○

label ラベル

該当のネットワークインターフェースに割り当

てられている識別用のラベルについて、変更し

たい内容を指定します

×

network_interface_id ネットワークインターフェース ID

情報を編集したいネットワークインターフェー

ス IDを指定します

ネットワークインターフェース IDは 7.1.

listNetworkInterfaces API で取得できます

7.1. listNetworkInterfaces API のレスポンス

オブジェクトのうち、idが該当します

○

91/205


該当のネットワークインターフェースに割り当

てられているポートスピードについて、変更し

たい数値を指定します


×


指定したネットワークインターフェースの追加のリクエストに成功した場合は true

を返します。

指定したネットワークインターフェースの追加のリクエストに失敗した場合は、内容



https://api.gmocloud.com/Cloud-Zone-ID/?Action=editNetworkInterface&AccessKey

Id=AccessKeyId&Version=1.0&Identifier=Identifier_of_VM&network_interface_id=I

D_of_Network_Interfaces&label=Label_of_NetworkInterface&rate_limit=2&Signatur

e=Signature


true

92/205

7.4. ネットワークインターフェースの削除

実行機能名

detachNetworkInterface


指定した仮想サーバーからネットワークインターフェースを削除します。







取得できます



○


情報を編集したいネットワークインターフェー

ス IDを指定します





○


指定したネットワークインターフェースの削除のリクエストに成功した場合は true

を返します。

指定したネットワークインターフェースの削除のリクエストに失敗した場合は、内容

93/205



https://api.gmocloud.com/Cloud-Zone-ID/?Action=detachNetworkInterface&AccessK

eyId=AccessKeyId&Version=1.0&Identifier=Identifier_of_VM&network_interface_id

=ID_of_Network_Interfaces &Signature=Signature


true

94/205

8. Network

8.1. ネットワーク一覧の取得

実行機能名

listNetworks


指定したクラウドゾーンで利用可能な物理ネットワークの一覧を取得します。





パラメーター説明

created_at 物理ネットワークの設定がされた日時を返します



id 物理ネットワーク ID を返します

label 当該物理ネットワークに設定されているラベルを返します

updated_at 当該物理ネットワークの設定が後にアップデートされた

日時を返します



network_group_id 当該物理ネットワークが属するネットワークグループの ID

を返します

ネットワークグループ IDは、ネットワークグループ IDは、

8.1. listNetworks API で取得できます

8.1. listNetworks API のレスポンスオブジェクトのうち、

95/205

network_group_id が該当します


https://api.gmocloud.com/Cloud-Zone-ID/?Action=listNetworks&AccessKeyId=Acces

sKeyId&Version=1.0&Signature=Signature


{

"3": {

"label": "Public01",

"created_at": "2012-06-13T19:58:12+09:00",

"network_group_id": 9,

"updated_at": "2012-06-13T19:58:12+09:00",

"id": 3,

"identifier": "hb36umde2x2t2m"

},

"5": {

"label": "Local01",

"created_at": "2012-06-13T20:20:54+09:00",


"updated_at": "2012-06-13T20:20:54+09:00",

"id": 5,

"identifier": "nfp71jnfggo893"

},

"7": {


"created_at": "2012-07-20T10:12:45+09:00",


"updated_at": "2012-07-20T10:12:45+09:00",

"id": 7,

"identifier": "ybro00d0s68a7r"

}

}

96/205

8.2. ネットワーク詳細情報の取得

実行機能名

getNetwork


指定したネットワークの詳細情報を返します。





該当するネットワークインターフェースIDを指

定します

ネットワークインターフェースの識別子は 8.1.

listNetworks API で、属する仮想サーバーを指

定して取得できます

8.1. listNetworks のレスポンスオブジェクト


○

Identifier ネットワーク ID

古いバージョンの API で使用していたパラメー

ターで、現在は使用しません。

この Identifier パラメーターが指定されてい

ても API の振る舞いには影響を及ぼしません。

相応の期間経過後にこのパラメーターは廃止し

ます。

×

97/205


8.1. listNetworks API と同じ形式で応答します。

詳細は 8.1. listNetworks API のレスポンスオブジェクトをご参照ください。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=getNetwork&AccessKeyId=AccessK

eyId&Version=1.0&network_id=ID_of_Network&Identifier=ID_of_Network&Signature=

Signature


{


"created_at": "2012-06-13T19:58:12+09:00",


"updated_at": "2012-06-13T19:58:12+09:00",

"id": 3,

"identifier": "hb36umde2x2t2m"

}

98/205

8.3. 仮想サーバーのネットワーク再構築

実行機能名

rebuildNetwork


指定した仮想サーバーのネットワークを再構築します。

attachNetworkInterface API / editNetworkInterface API / detachNetworkInterface

API それぞれの結果を反映させるためには、この API の実行が必要です。







取得できます



○


指定したネットワークの再構築のリクエストに成功した場合は true を返します。

指定したネットワークの再構築のリクエストに失敗した場合は、内容に応じたエラー



https://api.gmocloud.com/Cloud-Zone-ID/?Action=rebuildNetwork&AccessKeyId=Acc

essKeyId&Version=1.0&Identifier=Identifier_of_VM&Signature=Signature

99/205


true

100/205

9. IP Address

9.1. IP アドレス一覧の取得

実行機能名

listIpAddresses


指定したネットワークに属する IPアドレスの一覧を返します。





該当するネットワーク IDを指定します

ネットワーク IDは 8.1. listNetworks APIで取

得できます

8.1. listNetworksのレスポンスオブジェクト

のうち、idが該当します

○

free 利用状態

取得するIPアドレスが使用できるか否かでフィ

ルタします

true : レスポンスオブジェクトの free フィー

ルドが true の IPアドレスのみ

（使用中ではない IPアドレス）

false : レスポンスオブジェクトの freeフィ

ールドが false の IPアドレスのみ

（使用中の IPアドレス）

×

101/205

なお、このパラメーターを指定しない場合は全

ての IP アドレスを取得します







ます。

×




address IP アドレスを返します

broadcast 当該IPアドレスが属するネットワークのブロードキャスト

アドレスを返します

created_at 指定したネットワークで当該IPアドレスが使用可能になっ

た日時を返します



disallowed_primary 仮想サーバー作成時に、当該 IP アドレスをプライマリイン

ターフェースで使用できるか否かを返します

true : プライマリインターフェースで使用できない

false : プライマリインターフェースで使用できる

free 当該 IP アドレスが使用中であるか否かを返します

true : 使用中ではない

false : 使用中

gateway 当該IPアドレスが属するネットワークのゲートウェイアド

レスを返します

id 指定したネットワークにおいてIPアドレスに対して設定さ

102/205

れている ID を返します

ip_addresses 指定したネットワークに割り当てられている全てのIPアド


netmask 当該 IP アドレスのネットマスクを返します

network_address 当該IPアドレスが属するネットワークのネットワークアド


network_id 当該ネットワークインターフェースが接続するネットワー

ク IDを返します

ネットワーク ID は 8.1. listNetworks API で取得できま

す

8.1. listNetworks API のレスポンスオブジェクトのうち

id が該当します

updated_at 指定したネットワークにおける当該IPアドレスの設定が

後にアップデートされた日時を返します




https://api.gmocloud.com/Cloud-Zone-ID/?Action=listIpAddresses&AccessKeyId=Ac

cessKeyId&Version=1.0&network_id=ID_of_Network&free=true&Signature=Signature


{

"ID_of_IPaddress": {

"netmask": "255.255.255.0",


"address": "192.168.0.100",

"created_at": "2012-06-13T19:59:39+09:00",



"updated_at": "2012-06-13T19:59:39+09:00",

"broadcast": "192.168.0.255",

"id": ID_of_IPaddress,

103/205

"free": false,

"gateway": "192.168.0.254"

}

}

104/205

9.2. IP アドレスの詳細情報の取得

実行機能名

getIpAddress


特定のネットワークに属する、指定した IPアドレスの詳細情報を返します。





指定するIPアドレスが属するネットワークのネ

ットワーク IDを指定します

ネットワーク ID は 8.1. listNetworks API で取

得できます

8.1. listNetworks のレスポンスオブジェクト


○







ます。

×

ip_address_id IP アドレス ID

該当する IP アドレスに設定された ID を指定し

ます

IP アドレスの ID は 9.1. listIpAddresses API

○

105/205


9.1. listIpAddresses API のレスポンスオブジ



9.1. listIpAddresses API と同じ形式で応答します。

詳細は 9.1. listIpAddresses API のレスポンスオブジェクトをご参照ください。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=getIpAddress&AccessKeyId=Acces

sKeyId&Version=1.0&network_id=ID_of_Network&ip_address_id=ID_of_IpAddress&Sig

nature=Signature


{

"netmask": "192.168.0.0",


"address": "192.168.0.100",

"created_at": "2012-06-13T19:59:39+09:00",



"updated_at": "2012-06-13T19:59:39+09:00",

"broadcast": "192.168.0.255",


"free": false,

"gateway": "192.168.0.254"

}

106/205

9.3. IP アドレスの追加

実行機能名

addIp


指定した仮想サーバーに IP アドレスを追加します。







取得できます



○


追加する対象の IPアドレス IDを指定します



9.1. listIpAddresses のレスポンスオブジェク

トのうち、idが該当します

このパラメーターが指定されていない場合は、

空いているIPアドレスを自動的に取得して割り

当てます

×


対象のIPアドレスを追加するネットワークイン

ターフェースの IDを指定します

○

107/205




オブジェクトのうち、id が該当します


指定した IP アドレスの追加のリクエストに成功した場合は true を返します。

指定した IP アドレスの追加のリクエストに失敗した場合は、内容に応じたエラーメッ

セージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=addIp&AccessKeyId=AccessKeyId&

Version=1.0&Identifier=Identifier_id_VM&ip_address_id=ID_of_IPaddress&network

_interface_id=ID_of_NetworkInterface&Signature=Signature


true

108/205

9.4. IP アドレスの削除

実行機能名

deleteIp


指定した仮想サーバーから IPアドレスを削除します。







取得できます



○


削除する対象の IPアドレス IDを指定します



9.1. listIpAddresses のレスポンスオブジェク

トのうち、idが該当します

○


指定した IP アドレスの追加のリクエストに成功した場合は true を返します。

指定した IP アドレスの追加のリクエストに失敗した場合は、内容に応じたエラーメッ

セージを返します。

109/205


https://api.gmocloud.com/Cloud-Zone-ID/?Action=deleteIp&AccessKeyId=AccessKey

ID&Version=1.0&Identifier=Identifier_of_VM&ip_address_id=ID_of_IPaddress&Sign

ature=Signature


true

110/205

10. Firewall Rule

10.1. ファイアーウォールルール一覧の取得

実行機能名

listFirewalls


仮想サーバーに設定されている全てのファイアーウォールルールの一覧を取得します。







取得できます



○




address 当該ファイアーウォールルールで、送信元アドレスとして

設定されている IPアドレスを返します

0.0.0.0 が返された場合は全てのIPアドレスに対して適用

されることを示します

created_at 当該ファイアーウォールルールが作成された日時を返しま

111/205

す



command 当該ファイアーウォールルールで実行するように設定され

ているコマンドを返します

id 当該ファイアーウォールルールの ID を返します

network_interface_id 当該ファイアーウォールルールが設定されているネットワ

ークインターフェース IDを返します

port 当該ファイアーウォールルールで設定されている送信先ポ

ートを返します

position ファイアーウォールルールの適用優先順位を返します

protocol 当該ファイアーウォールルールで設定されているプロトコ

ル種類を TCP もしくは UDP で返します

updated_at 当該ファイアーウォールルールが後にアップデートされ

た日時を返します




https://api.gmocloud.com/Cloud-Zone-ID/?Action=listFirewalls&AccessKeyId=Acce

ssKeyId=1.0&Identifier=Identifier_of_VM&Signature=Signature


{

"ID_of_FW-rule": {

"address": "192.168.0.1/32",

"position": 1,

"created_at": "2012-07-19T23:46:18+09:00",

"command": "ACCEPT",

"port": "8080",

"updated_at": "2012-07-19T23:46:18+09:00",

"protocol": "TCP",

112/205

"id": ID_of_FW-rule,

"network_interface_id": ID_of_Network-Interface

}

}

113/205

10.2. 個別のファイアーウォールルールの取得

実行機能名

getFirewall


指定したファイアーウォールルールの詳細情報を返します







取得できます



○

firewall_id ファイアーウォールルール ID

仮想サーバーに設定されている特定のファイア

ーウォールルールの IDを指定します

ファイアーウォールルール IDは 10.1

listFirewalls API で取得できます

10.1 listFirewalls のレスポンスオブジェクト


○


10.1 listFirewalls API と同じ形式で応答します。

詳細は 10.1 listFirewalls API のレスポンスオブジェクトをご参照ください。

114/205


https://api.gmocloud.com/Cloud-Zone-ID/?Action=getFirewall&AccessKeyId=Access

KeyID&Version=1.0&Identifier=Identifier_od_VM&firewall_id=ID_of_FW-rule&Signa

ture=Signature


{

"address": "192.168.0.1/32",

"position": 1,

"created_at": "2012-07-19T23:46:18+09:00",

"command": "ACCEPT",

"port": "8080",

"updated_at": "2012-07-19T23:46:18+09:00",

"protocol": "TCP",

"id": ID_of_FW-rule,

"network_interface_id": ID_of_NetworkInterface

}

115/205

10.3. ファイアーウォールルールの追加

実行機能名

addFirewall


仮想サーバーにファイアーウォールルールを追加します。

追加したファイアーウォールルールが複数ある場合の適用優先順位は、一番低くなり

ます。

追加したファイアーウォールルールを有効にするためには、後述の 10.7.

applyFirewall API でファイアーウォールルールを適用する必要があります。







取得できます



○

address IP アドレス

追加するファイアーウォールルールで、送信元

アドレスとして設定したいIPアドレスを指定し

ます

・このフィールドの値が空の場合は全ての IP

アドレスに対して適用します

・ IP アドレスレンジで指定する場合は、IP ア

ドレスをハイフンで繋ぎます

(例： 192.168.1.1-192.168.1.10)

○

116/205

・ IP アドレスを CIDR で指定する場合は、スラ

ッシュで区切ります

(例： 192.168.1.1/24)

command コマンド

追加するファイアーウォールルールで実行する

ように設定するコマンドを ACCEPT もしくは

DROP で指定します

○

port ポート

追加するファイアーウォールルールで設定する

送信先ポートを指定します

・このフィールドの値がからの場合は全ての

ポートに対して適用します

・ポートレンジで指定する場合は、ポート番号

をコロンで繋ぎます

(例： 1024:1028)

・連続しない複数のポートを指定する場合は

カンマで区切ります

(例： 80,443,21)

○

protocol プロトコル

追加するファイアーウォールルールで設定する

プロトコル種類を TCP もしくは UDP で指定し

ます

○


ファイアーウォールルールの追加の対象になる

ネットワークインターフェースIDを指定します





○

117/205


指定したファイアーウォールルールの追加のリクエストに成功した場合は true を返

します。

指定したファイアーウォールルールの追加のリクエストに失敗した場合は、内容に応



https://api.gmocloud.com/Cloud-Zone-ID/?Action=addFirewall&AccessKeyId=Access

KeyId&Version=1.0&Identifier=Identifier_of_VM&address=192.168.1.100%2F32&comm

and=ACCEPT&port=8080&protocol=TCP&network_interface_id=ID_of_IF&Signature=Sig

nature


true

118/205

10.4. ファイアーウォールルールの編集

実行機能名

editFirewall


特定の仮想サーバーのネットワークインターフェースに設定されているファイアーウ

ォールルールを編集します







取得できます



○

address IP アドレス

対象のファイアーウォールルールに設定されて

いる送信元アドレスを変更するために、変更後

の新しい IP アドレスを指定します

・このフィールドの値が空の場合は全ての IP

アドレスに対して適用します

・ IP アドレスレンジで指定する場合は、IP ア

ドレスをハイフンで繋ぎます

(例： 192.168.1.1-192.168.1.10)

・ IP アドレスを CIDR で指定する場合は、スラ

ッシュで区切ります

(例： 192.168.1.1/24)

○

119/205

command コマンド

対象のファイアーウォールルールで実行するよ

うに設定されているコマンドを変更するため

に、変更後のコマンドを ACCEPT もしくは DROP

で指定します

○

firewall_id ファイアーウォール ID

対象のファイアーウォールルールに割り当てら

れている ID を指定します

ファイアーウォールルール IDは 7.1.




○


対象のファイアーウォールルールを設定するネ

ットワークインターフェース ID を指定します





○

port ポート


いる送信先ポートを変更するために、変更後の

新しい送信先ポートを指定します

・このパラメーターを指定しない、あるいは値

が空の場合は全てのポートに対して適用し

ます

・ポートレンジで指定する場合は、ポート番号

をコロンで繋ぎます

(例： 1024:1028)

・連続しない複数のポートを指定する場合は

カンマで区切ります

(例： 80,443,21)

×

120/205

protocol プロトコル


いるプロトコル種類を変更するために、変更後

の新しいプロトコル種類を TCP もしくは UDP

で指定します

×


指定したファイアーウォールルールの編集のリクエストに成功した場合は true を返

します。

指定したファイアーウォールルールの編集のリクエストに失敗した場合は、内容に応



https://api.gmocloud.com/Cloud-Zone-ID/?Action=editFirewall&AccessKeyId=Acces

sKeyId&Version=1.0&Identifier=Identifier_of_VM&address=192.168.0.100%2F32&com

mand=DROP&port=3&protocol=TCP&firewall_id=ID_of_Firewall-rule&Signature=Signa

ture


true

121/205

10.5. ファイアーウォールルールの削除

実行機能名

deleteFirewall


指定した仮想サーバーから、特定のファイアーウォール設定を削除します。







取得できます



○

firewall_id ファイアーウォール ID

仮想サーバーに設定されている特定のファイア

ーウォールルール ID を指定します

ファイアーウォールルール IDは 10.1

listFirewalls API で取得できます

10.1 listFirewalls のレスポンスオブジェクト


○


指定したファイアーウォールルールの削除のリクエストに成功した場合は true を返

します。

指定したファイアーウォールルールの削除のリクエストに失敗した場合は、内容に応

122/205



https://api.gmocloud.com/Cloud-Zone-ID/?Action=deleteFirewall&AccessKeyId=Acc

essKeyId&Version=1.0&Identifier=Identifier_of_VM&firewall_id=ID_of_Firewall-r

ule&Signature=Signature


true

123/205

10.6. デフォルトファイアーウォールルールの設定

実行機能名

setFirewallDefault


指定した仮想サーバーのインターフェースに対してデフォルトファイアーウォールル

ールを設定します。







取得できます



○

default_firewall_rule デフォルトルール

デフォルトファイアーウォールルールの設定を

指定します

ACCEPT : デフォルトファイアーウォールルール

を ACCEPT に設定します

DROP : デフォルトファイアーウォールルー

ルを DROP に設定します

○


デフォルトファイアーウォールルールを設定す

るネットワークインターフェースIDを指定しま

す

×

124/205

対象の仮想サーバーに複数のネットワークイン

ターフェースが設定してあるケースで、このパ

ラメーターを指定しない場合は、対象の仮想サ

ーバーに紐付くすべてのネットワークインター

フェースに対して一律で同じ設定をします






以下の形式で応答します


Network_interface_id デフォルトファイアーウォールルールの適用のリクエスト

に成功したか否かを返します

true : リクエストに成功した場合

false : リクエストに失敗した場合


https://api.gmocloud.com/Cloud-Zone-ID/?Action=setFirewallDefault&AccessKeyId

=AccessKeyId&Version=1.0&Identifier=identifier_of_VM&default_firewall_rule=DR

OP&network_interface_id=ID_of_NetworkInterface&Signature=Signature


{

"ID_of_NetworkInterface": true

}

125/205

10.7. ファイアーウォールルールの適用

実行機能名

applyFirewall


仮想サーバーにおいてファイアーウォールルールの適用をします。







取得できます



○


指定したファイアーウォールルールの適用のリクエストに成功した場合は true を返

します。

指定したファイアーウォールルールの適用のリクエストに失敗した場合は、内容に応



https://api.gmocloud.com/Cloud-Zone-ID/?Action=applyFirewall&AccessKeyId=Acce

ssKeyId&Version=1.0&Identifier=Identifier_of_VM&Signature=Signature

126/205


true

127/205

11. Template

11.1. テンプレート一覧の取得

実行機能名

listImages


テンプレートの一覧を返します






allowed_hot_migrate 該当のテンプレートがホットマイグレーションをすること

ができるか否かを返します



allow_resize_without_reboot 該当のテンプレートが仮想サーバーを再起動せずに各リソ

ースサイズの変更ができるか否かを返します



allow_swap 該当のテンプレートでスワップディスクの使用ができるか

否かを返します



128/205

arch 該当のテンプレートの OSのアーキテクチャを返します

32 : 32bit アーキテクチャ

64 : 64bit アーキテクチャ

created_at 該当のテンプレートが作成された日時を返します



file_name 該当のテンプレートの、クラウドシステム上におけるアー

カイブファイル名を返します

id 該当のテンプレートのテンプレート IDを返します

label OS テンプレートに設定されているラベル名を返します

ユーザーテンプレートの場合には、テンプレート作成時に

指定したラベル名を返します

min_disk_size 該当のテンプレートで仮想サーバーを作成する場合に必要

な小限のディスクサイズを返します

単位は GB (GigaByte) です

min_memory_size 該当のテンプレートに必要な小限のメモリサイズを返し

ます

必要小限の規定が無い場合には空の値を返します

operating_system_arch 該当のテンプレートの OSのアーキテクチャを返します

operating_system_distro 該当のテンプレートのOSのディストリビューションを返し

ます

operating_system 該当のテンプレートの OSの種類を返します

operating_system_tail 該当のテンプレートの OSの細部情報を返します

operating_system_edition 該当のテンプレートの OSにエディションがある場合、その

エディションを返します

parent_template_id 該当のテンプレートがシステムテンプレートの場合は、

null を返します

該当のテンプレートがユーザーテンプレートの場合は、そ

のテンプレートの元になる仮想サーバー作成時に選択した

システムテンプレートのテンプレート ID を返します

short_label テンプレートに設定されている簡略形ラベル名を返します

state 該当のテンプレートの状態を返します

active : 利用可能な状態

129/205

inactive : 利用不可能な状態

template_size 該当のテンプレートのファイルサイズを返します

単位は KB (KiloByte) です

type 該当のテンプレートの OSの種類を返します

updated_at 該当のテンプレートが後にアップデートされた日時を返

します



version 該当のテンプレートのバージョン情報を返します

virtualization 該当のテンプレートが適用できる仮想化方式を返します


https://api.gmocloud.com/Cloud-Zone-ID/?Action=listImages&AccessKeyId=AccessK

eyId&Version=1.0&Signature=Signature


{

"xen": {

"ID_of_Template": {

"short_label": "CentOS 6.0 LAMP",

"arch": "64",

"type": "centos",

"template_set_ids": [],

"label": "CentOS 6.0 LAMP x64 xen",

"parent_template_id": null,

"created_at": "2012-06-16T04:04:59+09:00",

"operating_system_arch": "x64",




"operating_system_tail": null,


"operating_system_edition": null,

130/205

"updated_at": "2012-06-25T18:49:33+09:00",


"disk_target_device": "---\nxen: sda\nkvm: hd\n",

"file_name": "centos-6.0-LAMP-x64-1.2-xen.tar.gz",

"id": ID_of_Template,

"virtualization": "xen",


"template_size": 209744,

"version": "1.2",

"min_disk_size": 5,

"state": "active"

}

}

}

131/205

11.2. テンプレートの詳細情報の取得

実行機能名

getImage


指定したテンプレートの詳細情報を返します





テンプレートに割り当てられているIDを指定し

ます

テンプレート ID は 11.1. listImages API で取

得できます

11.1. listImages API のレスポンスオブジェク


○


11.1. listImages API と同じ形式で応答します。

詳細は 11.1. listImages API のレスポンスオブジェクトをご参照ください。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=getImage&AccessKeyId=AccessKey

Id&Version=1.0&template_id=ID_of_Template&Signature=Signature

132/205


{

"short_label": "Template-Short-Label-example",

"arch": "64",

"type": "centos",

"template_set_ids": [],

"label": "Template-Label-example",

"parent_template_id": ID_of_Template,

"created_at": "2012-08-28T20:51:01+09:00",

"operating_system_arch": "x64",




"operating_system_tail": null,


"operating_system_edition": null,

"updated_at": "2012-08-28T20:51:09+09:00",


"disk_target_device": "---\nxen: sda\nkvm: hd\n",

"file_name": "File-Name",

"id": ID_of_Template,

"virtualization": "xen",


"template_size": 210596,

"version": "1.0",

"min_disk_size": 5,

"state": "active"

}

133/205

11.3. ユーザーテンプレートの削除

実行機能名

destroyImage


指定したユーザーテンプレートを削除します





テンプレートに割り当てられているIDを指定し

ます

テンプレート ID は 11.1. listImages API で取

得できます

11.1. listImages API のレスポンスオブジェク


○


指定したユーザーテンプレートの削除のリクエストに成功した場合は true を返しま

す。

指定したユーザーテンプレートの削除のリクエストに失敗した場合は、内容に応じた



https://api.gmocloud.com/Cloud-Zone-ID/?Action=destroyImage&AccessKeyId=Acces

sKeyId&Version=1.0&template_id=ID_of_UserTemplate&Signature=Signature

134/205


true

135/205

12. Data Store

12.1. データストア一覧の取得

実行機能名

listDatastores


データストアの一覧を返します






created_at データストアが GMOクラウドPublicのシステムの中で作成

された日時を返します



capacity データストアのディスクサイズのうち、ユーザーが利用で

きる総ディスクサイズを返します

単位は GB(GigaBytes)です

data_store_size データストアの総ディスクサイズを返します


id データストアに割り当てられている IDを返します

identifier データストアに割り当てられている識別子を返します

ip データストアに割り当てられているIPアドレスを返します

label データストアに設定されているラベルを返します

local_hypervisor_id データストアを使用しているハイパーバイザーのIDを返し

136/205

ます

usage データストアのうち、使用中のディスクサイズを返します


updated_at データストアの終アップデート日時を返します。



data_store_group_id データストアに割り当てられたデータストア・グループID

を返します

zombie_disk_size データストアのうち、開放処理待ちのディスクサイズを返

します


enabled データストアが利用可能な状態か否かを返します

true : 利用可能な状態

false : 利用不可能な状態


https://api.gmocloud.com/Cloud-Zone-ID/?Action=listDatastores&AccessKeyId=Acc

essKeyId&Version=1.0&Signature=Signature


{

"ID_of_DataStore": {

"label": "LABEL_of_DataStore",

"usage": 945,

"created_at": "2012-08-09T10:10:18+09:00",

"updated_at": "2012-08-09T23:52:52+09:00",

"data_store_group_id": ID_of_DataStore-Group,

"enabled": true,

"id": ID_of_DataStore,

"zombie_disks_size": 6,

"ip": "10.63.0.100",

"local_hypervisor_id": null,

137/205

"capacity": 2048,

"data_store_size": 2048,

"identifier": "Identifier_of_DataStore"

}

}

138/205

13. Load Balancers

13.1. ロードバランスクラスター一覧の表示

実行機能名

listClusters


ロードバランスクラスターを構成するロードバランサーと仮想サーバーの一覧を返し

ます






autoscaleout オートスケーリングタイプのロードバランスクラスター

の詳細情報を返します

cluster クラスタリングタイプのロードバランスクラスターの詳

細情報を返します

auto_scaling_in_cpu CPU 利用率によるオートスケールインの設定値を返しま

す

created_at : 設定を行った日時

enebled : true の場合、設定が有効な状態

false の場合、設定が無効な状態

for_minutes : オートスケール判定時間間隔（分）

id : オートスケール設定 ID

units : 削除する仮想サーバーの個数

updated_at : 設定の終変更日時

139/205

value : オートスケール判定の CPU 利用率(%)の閾

値

auto_scaling_in_memory メモリー残領域によるオートスケールインの設定値を返

します






units : 削除する仮想サーバーの個数


value : オートスケール判定のメモリー残領域サ

イズ(MB)の閾値

auto_scaling_out_cpu CPU 利用率によるオートスケールアウトの設定値を返し

ます






units : 追加する仮想サーバーの個数


value : オートスケール判定の CPU 利用率(%)の閾

値

auto_scaling_out_memory メモリー残領域によるオートスケールアウトの設定値を

返します






units : 追加する仮想サーバーの個数


140/205

value : オートスケール判定のメモリー残領域サ

イズ(MB)の閾値

cluster_type ロードバランスクラスターの種別を返します

autoscaleout : オートスケール

cluster : クラスタリング（クラスター）

config オートスケーリングタイプのロードバランサーの、クラス

ターノードの設定値を返します

max_node_amount : 大ノード数の設定値

min_node_amount : 小ノード数の設定値

created_at ロードバランスクラスターの作成日時を返します



id クラスターIDを返します

identifier クラスター識別子を返します

image_template_id ロードバランスクラスターの構築時に利用したテンプレ

ートの IDを返します

load_balancer_id ロードバランサーの IDを返します

load_balancer_password ロードバランサーの管理画面にログインする際の root

のパスワードを返します

load_balancer ロードバランスクラスターに属するロードバランサーの

詳細情報を返します


listBalancers 項をご参照ください

name ロードバランサーに設定されているラベルを返します

nodes ロードバランスクラスターに属するノードの情報を返し

ます

cluster_id : ノードが属するクラスターの ID

created_at : ノードが作成された日時

id : ノード ID

ip_address_id : ノードに割り当てられている IP アドレ

ス ID

updated_at : ノードの情報の終更新日時

141/205

virtual_machine_id : ロードバランサー本体となる仮想

サーバーの ID

node_attributes クラスターノードのリソース割り当て値を返します

cpu_shares : CPU 占有率(%)

cpus : 仮想 CPU コア数

memory : メモリ容量(MB)

rate_limit : ポートスピード(Mbps)

ports ロードバランシング対象のポート番号を返します

updated_at ロードバランスクラスターの設定が後にアップデート

された日時を返します




https://api.gmocloud.com/Cloud-Zone-ID/?Action=listClusters&AccessKeyId=Acces



{

"cluster": {

"ID_of_Cluster": {

"name": "Cluster-Label-example",

"created_at": "2012-08-22T12:45:13+09:00",

"config": {

"max_node_amount": "",

"min_node_amount": ""

},

"load_balancer_id": ID_of_LB,

"load_balancer_password": "Password",

"updated_at": "2012-08-22T12:45:13+09:00",

"auto_scaling_out_cpu": null,

"id": ID_of_Cluster,

142/205

"load_balancer": {

"label": "LB-Label-example",

"cpus": 1,

"operating_system_distro": "lbva",

"created_at": "2012-08-22T12:45:13+09:00",




"cpu_shares": 10,

"updated_at": "2012-08-23T21:29:02+09:00",

"memory": 512,



"allow_resize_without_reboot": false,

"id": ID_of_LB,

"hypervisor_id": ID_of_HV,



"suspended": false,

"note": null,


"template_label": "Load Balancer Virtual Appliance",


"booted": false,

"min_disk_size": 5,


"identifier": "Identifier_of_LB",

"ip_addresses": {

"ID_of_IpAdress": {

"netmask": "255.255.255.0",


"address": "192.168.0.100",

"created_at": "2012-08-17T17:30:35+09:00",



"updated_at": "2012-08-17T17:30:35+09:00",

143/205

"broadcast": "192.168.0.255",


"free": false,

"gateway": "192.168.0.254"

},


"netmask": "255.255.255.0",


"address": "192.168.0.101",

"created_at": "2012-08-17T17:30:35+09:00",



"updated_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",


"free": false,

"gateway": "192.168.0.254"

}

},

"state": "off",

"locked": false,

"built": true,

"ip": [

"192.168.0.100",

"192.168.0.101"

],

"type": "lb"

},

"auto_scaling_out_memory": null,

"ports": [

80

],

"auto_scaling_in_memory": null,

"nodes": {

"ID_of_Node": {

"cluster_id": ID_of_Cluster,

144/205

"ip_address_id": ID_of_IpAddress,

"created_at": "2012-08-22T12:45:13+09:00",

"updated_at": "2012-08-22T12:45:13+09:00",

"id": ID_of_Node,

"virtual_machine_id": ID_of_Cluster-VM

},

"ID_of_Node": {



"created_at": "2012-08-22T12:45:13+09:00",

"updated_at": "2012-08-22T12:45:13+09:00",

"id": ID_of_Node,

"virtual_machine_id": ID_of_Cluster-VM

}

},

"cluster_type": "cluster",

"identifier": "Identifier_of_Cluster",

"node_attributes": null,

"auto_scaling_in_cpu": null,

"image_template_id": null

}

},

"autoscaleout": {

"ID_of_Cluster": {


"created_at": "2012-08-22T12:48:26+09:00",

"config": {

"max_node_amount": 3,

"min_node_amount": 1

},



"updated_at": "2012-08-22T13:30:18+09:00",

"auto_scaling_out_cpu": {

"for_minutes": 5,

"created_at": "2012-08-22T12:48:26+09:00",

145/205

"updated_at": "2012-08-22T13:30:18+09:00",

"units": 1,

"id": ID_of_AutoScale,

"enabled": true,

"value": 100

},


"load_balancer": {


"cpus": 1,


"created_at": "2012-08-22T12:48:26+09:00",




"cpu_shares": 10,

"updated_at": "2012-08-23T21:29:04+09:00",

"memory": 512,




"id": ID_of_LB,




"suspended": false,

"note": null,




"booted": true,

"min_disk_size": 5,



"ip_addresses": {


146/205

"netmask": "255.255.255.0",


"address": "192.168.0.110",

"created_at": "2012-08-17T17:30:35+09:00",



"updated_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",


"free": false,

"gateway": "192.168.0.254"

},


"netmask": "255.255.255.0",


"address": "192.168.0.111",

"created_at": "2012-08-17T17:30:35+09:00",



"updated_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",


"free": false,

"gateway": "192.168.0.254"

}

},

"state": "on",

"locked": false,

"built": true,

"ip": [

"192.168.0.110",

"192.168.0.111"

],

"type": "lb"

},

"auto_scaling_out_memory": {

147/205

"for_minutes": 5,

"created_at": "2012-08-22T12:48:26+09:00",

"updated_at": "2012-08-22T13:30:18+09:00",

"units": 1,

"id": ID_of_AutScaling,

"enabled": true,

"value": 1

},

"ports": [

443

],

"auto_scaling_in_memory": {

"for_minutes": 20,

"created_at": "2012-08-22T12:48:26+09:00",

"updated_at": "2012-08-22T12:48:26+09:00",

"units": 1,

"id": ID_of_AutoScaling,

"enabled": true,

"value": 42

},

"nodes": {

"ID_of_Node": {



"created_at": "2012-08-22T12:48:28+09:00",

"updated_at": "2012-08-22T12:48:28+09:00",

"id": ID_of_Node,

"virtual_machine_id": ID_of_VM

}

},

"cluster_type": "autoscaleout",


"node_attributes": {

"cpus": "1",

"cpu_shares": "5",

"memory": "128",

148/205

"rate_limit": "1"

},

"auto_scaling_in_cpu": {

"for_minutes": 20,

"created_at": "2012-08-22T12:48:26+09:00",

"updated_at": "2012-08-22T13:07:35+09:00",

"units": 1,

"id": ID_of_AutoScaling,

"enabled": true,

"value": 50

},

"image_template_id": ID_of_Template

},

}

}

149/205

13.2. 個別のロードバランスクラスターの詳細情報の取得

実行機能名

getCluster


指定したロードバランスクラスターの詳細情報を返します。




cluster_id クラスタ ID

クラスターIDを指定します

クラスターIDは 13.1. listClusters API で取得

できます

13.1. listCluster API のレスポンスオブジェク

トのうち、autoscaleout フィールドもしくは

cluster フィールドの id が該当します

○



各エレメントは、13.1. listClusters API のレスポンスの構造と同様の構造です。


network_interfaces 指定したロードバランサーに設定されているネットワーク

インターフェースの詳細情報を返します


listNetworkInterfaces 項をご参照ください

その他の詳細は 13.1. listClusters API のレスポンスオブジェクトをご参照ください。

150/205


https://api.gmocloud.com/Cloud-Zone-Id/?Action=getCluster&AccessKeyId=AccessK

eyId&Version=1.0&cluster_id=ID_of_Cluster&Signature=Signature


{


"created_at": "2012-08-22T12:48:26+09:00",

"config": {

"max_node_amount": 3,

"min_node_amount": 1

},



"updated_at": "2012-08-22T13:30:18+09:00",

"auto_scaling_out_cpu": {

"for_minutes": 5,

"created_at": "2012-08-22T12:48:26+09:00",

"updated_at": "2012-08-22T13:30:18+09:00",

"units": 1,


"enabled": true,

"value": 100

},

"id": ID_of_LB,

"load_balancer": {


"cpus": 1,


"created_at": "2012-08-22T12:48:26+09:00",




151/205

"cpu_shares": 10,

"updated_at": "2012-08-23T21:29:04+09:00",

"memory": 512,








"suspended": false,

"note": null,




"booted": true,

"min_disk_size": 5,



"ip_addresses": {


"netmask": "255.255.255.0",


"address": "192.168.0.110",

"created_at": "2012-08-17T17:30:35+09:00",



"updated_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",


"free": false,

"gateway": "192.168.0.254"

},


"netmask": "255.255.255.0",


152/205

"address": "192.168.0.111",

"created_at": "2012-08-17T17:30:35+09:00",



"updated_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",


"free": false,

"gateway": "192.168.0.254"

}

},

"state": "on",

"locked": false,

"built": true,

"ip": [

"192.168.0.110",

"192.168.0.111"

],

"type": "lb",


"ID_of_NetworkInterface": {

"label": "NetworkInterface-Label-example",

"created_at": "2012-08-22T12:48:26+09:00",

"usage": null,

"updated_at": "2012-08-22T12:48:26+09:00",

"primary": true,

"id": ID_of_NetworkInterface,


"mac_address": "00:00:00:00:00:00",



"rate_limit": 1,

"identifier": "Identifier_of_NetworkInterface",

"network_join_id": ID_of_NetworkJoin,

"virtual_machine_id": ID_of_VM,

"network_id": null

153/205

}

}

},

"auto_scaling_out_memory": {

"for_minutes": 5,

"created_at": "2012-08-22T12:48:26+09:00",

"updated_at": "2012-08-22T13:30:18+09:00",

"units": 1,


"enabled": true,

"value": 1

},

"ports": [

443

],

"auto_scaling_in_memory": {

"for_minutes": 20,

"created_at": "2012-08-22T12:48:26+09:00",

"updated_at": "2012-08-22T12:48:26+09:00",

"units": 1,


"enabled": true,

"value": 42

},

"nodes": {

"ID_of_AutoScale": {



"created_at": "2012-08-22T12:48:28+09:00",

"updated_at": "2012-08-22T12:48:28+09:00",


"virtual_machine_id": ID_of_VM

}

},

"cluster_type": "autoscaleout",


154/205

"node_attributes": {

"cpus": "1",

"cpu_shares": "5",

"memory": "128",

"rate_limit": "1"

},

"auto_scaling_in_cpu": {

"for_minutes": 20,

"created_at": "2012-08-22T12:48:26+09:00",

"updated_at": "2012-08-22T13:07:35+09:00",

"units": 1,


"enabled": true,

"value": 50

},

"image_template_id": ID_of_Template

}

155/205

13.3. ロードバランスクラスターの設定編集

実行機能名

editCluster


ロードバランスクラスターの設定を編集します







できます




○

label ラベル

ロードバランスクラスターに設定されているラ

ベルを変更するために、変更後の新しいラベル

を指定します

・変更しない場合は、このパラメーターはリク

エストに含めないでください

・ label, rate_limit, ports のいづれかが必

須パラメーターです

（ ○ ）


ロードバランスクラスターに設定されているポ

ートスピードについて、変更したい数値を指定

（ ○ ）

156/205

します






ports ポートリスト[ex. 80,443]

ロードバランスクラスターに設定されているク

ラスタ対象のポートを変更するために、変更後

の新しいポート番号を指定します



・複数のポート番号を指定する場合はカンマ

で区切ります

（例： 80,8080,443,4443）



（ ○ ）






https://api.gmocloud.com/Cloud-Zone-ID/?Action=editCluster&AccessKeyId=Access

KeyId&Version=1.0&cluster_id=ID_of_Cluster&label=LB-Label-example&rate_limit=

1&ports=4443&Signature=Signature

157/205


true

158/205

13.4. クラスタータイプのロードバランサーの作成

実行機能名

deployClusteringBalancer


クラスタータイプのロードバランサーを作成します




label ラベル

ロードバランサーに設定するラベルを指定しま

す

○


構築するロードバランサーの hostname を指定

します

○


ロードバランサーを作成する仮想サーバーを構

築するハイパーバイザーに割り当てられたハイ

パーバイザーグループ IDを指定します

ハイパーバイザーグループIDを指定しない場合

は、GMO クラウド Public の中で利用できるいづ

れかのハイパーバイザーにロードバランサーが

構築されます

ハイパーバイザーグループ ID は、3.1.




ます

×

159/205



築するハイパーバイザーの IDを指定します


クラウドPublicの全てのハイパーバイザーのう

ち、もメモリ容量の残りがあるハイパーバイ

ザーの中に構築されます





×

nodes VM 識別子リスト[ex. ABC:IP,XYZ]

構築するロードバランサーに設定する仮想サー

バーを指定します

複数の仮想サーバーを指定する場合はカンマで

区切ります

（例： abc123def456gh,9zyx8wvu7ts）

×




ネットワークグループ IDは、ネットワークグル

ープ ID は、8.1. listNetworks API で取得でき

ます



×


構築するロードバランサーに割り当てるネット

ワークのポートスピードを指定します


○


○

160/205

構築するロードバランサーに設定するクラスタ

対象のポートを指定します

複数のポート番号を指定する場合はカンマで区

切ります

（例： 80,8080,443,4443）


指定したロードバランサーの作成のリクエストに成功した場合は、以下の形式で応答

します


cluster_id ロードバランサーの作成のリクエストに成功した場合、ロ

ードバランサーに割り当てられる cluster_id を返します

指定したロードバランサーの作成のリクエストに失敗した場合は、内容に応じたエラ

ーメッセージを返します。


https://api.gmocloud.com/Cloud-Zone-Id/?Action=deployClusteringBalancer&Acces

sKeyId=AccessKeyId&Version=1.0&label=Cluster-Label-example&hostname=gmocloud.

example.com&hypervisor_group_id=ID_of_HV-Group&hypervisor_id=ID_of_HV&primary

_network_group_id=ID_of_NetworkGroup&rate_limit=1&ports=80%2C443&nodes=abc123

def456gh%2C9zyx8wvu7ts&Signature=Signature


{

"cluster_id": ID_of_Cluster

}

161/205

13.5. クラスタータイプのロードバランサーへの仮想サーバー追加

実行機能名

addClusteringNode


クラスタータイプのロードバランサーへ仮想サーバーを追加します







できます

13.1. listClusters API のレスポンスオブジェ

クトのうち、autoscaleout フィールドもしくは


○


ロードバランサー配下でクラスタリングの対象

として追加する仮想サーバーを指定します


区切ります


○


指定したロードバランサーへの仮想サーバーの追加のリクエストに成功した場合は、

true を返します。

162/205

指定したロードバランサーへの仮想サーバーの追加のリクエストに失敗した場合は、

内容に応じたエラーメッセージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=addClusteringNode&AccessKeyId=

AccessKeyId&Version=1.0&cluster_id=ID_of_Cluster&nodes=abc123def456gh%2C9zyx8

wvu7ts&Signature=Signature


true

163/205

13.6. クラスタータイプのロードバランサーから仮想サーバー取外

実行機能名

removeClusteringNode


クラスタータイプのロードバランサーから仮想サーバーを削除します







できます




○


ロードバランサー配下のクラスタリング対象か

ら取り外す仮想サーバーを指定します


区切ります


○


指定したロードバランサーからの仮想サーバーの取り外しのリクエストに成功した場

合は、true を返します。

164/205

指定したロードバランサーからの仮想サーバーの取り外しのリクエストに失敗した場

合は、内容に応じたエラーメッセージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=removeClusteringNode&AccessKey

Id=AccessKeyId&Version=1.0&cluster_id=ID_of_Cluster&nodes=abc123def456gh%2C9z

yx8wvu7ts&Signature=Signature


true

165/205

13.7. ロードバランサーの削除

実行機能名

destroyCluster


クラスタータイプのロードバランサーとオートスケールタイプのロードバランサーを

削除します







できます




○


指定したロードバランサーの削除のリクエストに成功した場合は、true を返します。

指定したロードバランサーの削除のリクエストに失敗した場合は、内容に応じたエラ



https://api.gmocloud.com/Cloud-Zone-ID/?Action=destroyCluster&AccessKeyId=Acc

essKeyId&Version=1.0&cluster_id=ID_of_Cluster&Signature=Signature

166/205


true

167/205

13.8. オートスケールタイプのロードバランサーの作成

実行機能名

deployAutoScalingBalancer


オートスケールタイプのロードバランサーを作成します




autoscaling_in_cpu ノード削除 CPU 条件[継続時間,削除ノード

数,CPU 負荷[%]]

CPU 負荷に応じてオートスケールインさせる際

の条件を指定します

条件のパラメーターはカンマで区切ります

×

autoscaling_in_memory ノード削除メモリ条件[継続時間,削除ノード

数,残メモリ[MB]]

残メモリに応じてオートスケールインさせる際

の条件を指定します


×

autoscaling_out_cpu ノード追加 CPU 条件[継続時間,追加ノード

数,CPU 負荷[%]]

CPU 負荷に応じてオートスケールアウトさせる

際の条件を指定します


×

autoscaling_out_memory ノード追加メモリ条件[継続時間,追加ノード


×

168/205

残メモリに応じてオートスケールアウトさせる

際の条件を指定します


label ラベル

ロードバランサーに設定するラベルを指定しま

す

○


構築するロードバランサーの hostname を指定

します

○



築するハイパーバイザーに割り当てられたハイ

パーバイザーグループ IDを指定します

ハイパーバイザーグループIDを指定しない場合

は、GMO クラウド Public の中で利用できるいづ

れかのハイパーバイザーにロードバランサーが

構築されます

ハイパーバイザーグループ ID は、3.1.




ます

×



築するハイパーバイザーの IDを指定します


クラウドPublicの全てのハイパーバイザーのう

ち、もメモリ容量の残りがあるハイパーバイ

ザーの中に構築されます




×

169/205


max_node_amount 大ノード数

オートスケールアウトで構築する仮想サーバー

の大ノード数を指定します

○

min_node_amount 小ノード数

オートスケールインでノードを削除する際に残

す小限の仮想サーバー数を指定します

○

node_cpu_shares ノード CPU 占有率


に割り当てる CPU 占有率を指定します

このパラメーターを指定しない場合の初期値は

1 です

単位は % （Percent）です

×

node_cpus ノード CPU コア数


に割り当てる仮想 CPU コア数を指定します

単位は個です

○

node_memory ノードメモリ[MB]


に割り当てるメモリ容量を指定します

単位は MB（MegaByte）です

○

node_rate_limit ノード帯域[Mbps]


に割り当てるネットワークのポートスピードを

指定します


○

170/205

node_template_id テンプレート ID


が使用するテンプレートの IDを指定します


の IDは、11.1. listImages API で取得できます

11.1. listImages のレスポンスオブジェクトの


○




ネットワークグループ IDは、ネットワークグル

ープ ID は、8.1. listNetworks API で取得でき

ます



×


構築するロードバランサーに割り当てるネット

ワークのポートスピードを指定します


○


構築するロードバランサーに設定するクラスタ

対象のポートを指定します

複数のポート番号を指定する場合はカンマで区

切ります

（例： 80,8080,443,4443）

○


指定したロードバランサーの作成のリクエストに成功した場合は、以下の形式で応答

します

171/205


cluster_id ロードバランサーの作成のリクエストに成功した場合、ロ

ードバランサーに割り当てられる cluster_id を返します

指定したロードバランサーの作成のリクエストに失敗した場合は、内容に応じたエラ



https://api.gmocloud.com/Cloud-Zone-ID/?Action=deployAutoScalingBalancer&Acce

ssKeyId=AccessKeyId&Version=1.0&label=LB-Label-example&hostname=gmocloud.exam

ple.com&rate_limit=1&ports=80%2C443&node_cpus=1&node_memory=128&node_rate_lim

it=1&node_template_id=ID_of_Template&max_node_amount=2&min_node_amount=1&auto

_scaling_in_cpu=20%2C1%2C90&auto_scaling_in_memory=20%2C1%2C42&auto_scaling_o

ut_cpu=5%2C1%2C1&auto_scaling_out_memory=5%2C1%2C1&hypervisor_group_id=ID_of_

HV-Group&hypervisor_id=ID_of_HV&node_cpu_shares=1&primary_network_group_id=ID

_of_NetworkGroup&Signature=Signature


{

"cluster_id": ID_of_Cluster

}

172/205

13.9. オートスケールタイプのロードバランサーの設定編集

実行機能名

editAutoScalingBalancer


オートスケールタイプのロードバランサーの設定を編集します






ロードバランサーの識別子は 13.1.

listClusters API で取得できます




○

autoscaling_in_cpu ノード削除 CPU 条件[継続時間,削除ノード

数,CPU 負荷[%]]

CPU 負荷に応じてオートスケールインさせる際

の条件について、変更後の値を指定します

継続時間は5分から60分の間で5分刻みで指定

できます


×

autoscaling_in_memory ノード削除メモリ条件[継続時間,削除ノード


残メモリに応じてオートスケールインさせる際

の条件について、変更後の値を指定します


×

173/205

できます


autoscaling_out_cpu ノード追加 CPU 条件[継続時間,追加ノード

数,CPU 負荷[%]]

CPU 負荷に応じてオートスケールアウトさせる

際の条件について、変更後の値を指定します


できます


×

autoscaling_out_memory ノード追加メモリ条件[継続時間,追加ノード


残メモリに応じてオートスケールアウトさせる

際の条件について、変更後の値を指定します


できます


×

max_node_amount 大ノード数


の大ノード数について、変更後の値を指定し

ます

×

min_node_amount 小ノード数

オートスケールインでノードを削除する際に残

す小限の仮想サーバー数について、変更後の

値を指定します

×





174/205


https://api.gmocloud.com/Cloud-Zone-Id/?Action=editAutoScalingBalancer&Access

KeyId=AccessKeyId&Version=1.0&cluster_id=ID_of_Cluster&max_node_amount=4&min_

node_amount=1&auto_scaling_in_memory=30%2C3%2C44&auto_scaling_out_memory=15%2

C1%2C3&auto_scaling_in_cpu=30%2C3%2C80&auto_scaling_out_cpu=15%2C1%2C2&Signat

ure=Signature


true

175/205

13.10. ロードバランサー一覧の表示

実行機能名

listBalancers


ロードバランサーの一覧を返します






autoscaleout オートスケーリングタイプのロードバランサーが稼動して

いる仮想サーバーの詳細情報を返します

cluster クラスタリングタイプのロードバランサーが稼動している

仮想サーバーの詳細情報を返します

allow_resize_without_reboot ロードバランサーを再起動せずに CPU コア数とメモリサイ

ズの変更ができるか否かを返します



allowed_hot_migrate ロードバランサーがホットマイグレーションをすることが

できるか否かを返します



allowed_swap ロードバランサーでスワップディスクの使用ができるか否

かを返します


176/205


booted ロードバランサーの稼働状態を返します

true : ロードバランサーが稼働中の状態


built ロードバランサーの構築状態を返します

true : 構築済みの状態


cpu_shares ロードバランサーに割り当てられている CPU 占有率を返し

ます

cpus ロードバランサーに割り当てられている仮想 CPU コア数を

返します

created_at ロードバランサーの作成日時を返します



enable_autoscale ロードバランサーにおけるオートスケールの設定状態を返

します

true : オートスケールの設定がされてる状態


enable_monitis ロードバランサーにおいて、オートスケールのステータス

を監視するデーモンの稼動状態を返します

true : 有効な状態


hostname ロードバランサーに設定されているホスト名を返します

hypervisor_id ロードバランサーが使用するハイパーバイザーのIDを返し

ます

id ロードバランサーの IDを返します

identifier ロードバランサーの識別子を返します

initial_root_password ロードバランサーの初期の root パスワードを返します

ip_addresses ロードバランサーに割り当てられているIPアドレスとその

詳細情報を返します

このフィールドに含まれるパラメーターの詳細は

177/205

listIpAddresses 項をご参照ください

ip ロードバランサーに割り当てられているIPアドレスの一覧

を返します

label ロードバランサーに設定したラベルを返します

locked ロードバランサーのロック状態を返します

true : ロードバランサーがロックされている状態


memory ロードバランサーに割り当てられているメモリ容量を返し

ます


min_disk_size ロードバランサーの構築に用いられたテンプレートが必要

とする少のディスクサイズを返します

note ロードバランサーに設定されているメモを返します

operating_system ロードバランサーが使用している OS の種類を返します

operating_system_distro ロードバランサーの構築時に使用したOSのディストリビュ

ーションの種類を返します

recovery_mode ロードバランサーがリカバリーモードで起動できるか否か

を返します

true : リカバリーモードで起動できる

false : 上記以外

state ロードバランサーの稼動状態を返します

on : 起動中

off : 停止中

pending : クラウドコントローラーによる処理待ち

running : クラウドコントローラーによる処理中

suspend ロードバランサーが停止中の状態か否かを返します

true : 停止中の状態


template_id ロードバランサー構築時に利用したテンプレートのIDを返

します

template_label ロードバランサー構築時に利用したテンプレートのラベル

を返します

178/205

total_disk_size ロードバランサーに割り当てられている全てのディスクの

ディスク容量を返します

単位は GB(Giga Bites) です

type 指定したロードバランサーの仮想サーバー種別として lb

を返します

updated_at 指定したロードバランサーの設定が後にアップデートさ

れた日時を返します




https://api.gmocloud.com/Cloud-Zone-ID/?Action=listBalancers&AccessKeyId=Acce

ssKeyId&Version=1.0&Signature=Signature


{

"cluster": {

"ID_of_LB": {


"cpus": 1,


"created_at": "2012-08-22T12:45:13+09:00",




"cpu_shares": 10,

"updated_at": "2012-08-23T09:58:20+09:00",

"memory": 512,




"id": ID_of_LB,


179/205



"suspended": false,

"note": null,




"booted": true,

"min_disk_size": 5,



"ip_addresses": {


"netmask": "255.255.255.0",


"address": "192.168.0.100",

"created_at": "2012-08-17T17:30:35+09:00",



"updated_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",


"free": false,

"gateway": "192.168.0.254"

},


"netmask": "255.255.255.0",


"address": "192.168.0.101",

"created_at": "2012-08-17T17:30:35+09:00",



"updated_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",


"free": false,

180/205

"gateway": "192.168.0.254"

}

},

"state": "on",

"locked": false,

"built": true,

"ip": [

"192.168.0.100",

"192.168.0.101"

],

"type": "lb"

}

},

"autoscaleout": {

"ID_of_LB": {


"cpus": 1,


"created_at": "2012-08-22T12:48:26+09:00",




"cpu_shares": 10,

"updated_at": "2012-08-23T09:58:20+09:00",

"memory": 512,




"id": ID_of_LB,




"suspended": false,

"note": null,



181/205


"booted": true,

"min_disk_size": 5,



"ip_addresses": {


"netmask": "255.255.255.0",


"address": "192.168.0.102",

"created_at": "2012-08-17T17:30:35+09:00",



"updated_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",


"free": false,

"gateway": "192.168.0.254"

},


"netmask": "255.255.255.0",


"address": "192.168.0.103",

"created_at": "2012-08-17T17:30:35+09:00",



"updated_at": "2012-08-17T17:30:35+09:00",

"broadcast": "192.168.0.255",


"free": false,

"gateway": "192.168.0.254"

}

},

"state": "on",

"locked": false,

"built": true,

182/205

"ip": [

"192.168.0.102",

"192.168.0.103"

],

"type": "lb"

}

}

}

183/205

13.11. 個別のロードバランサーの詳細情報の取得

実行機能名

getBalancer


指定したロードバランサーの詳細情報を返します。

指定したロードバランサーIDが無効であるか、存在しない場合はエラーを返します。




load_balancer_id ロードバランサーID

ロードバランサーの識別子を指定します


listBalancers API で取得できます

13.1. listBalancers API のレスポンスオブジェ



○

Identifier ロードバランサー識別子

（後述の load_balancer_id と同意で、一定の

期間経過後にこのパラメーターは廃止します）






cluster フィールドの identifier が該当しま

す

×

184/205



各エレメントは、listNode API のレスポンスの構造と同様の構造です。


lb ロードバランサーの詳細情報を返します

詳細は listBalancer API のレスポンスオブジェクトをご参照ください。


https://api.gmocloud.com/Cloud-Zone-Id/?Action=getBalancer&AccessKeyId=Access

KeyId&Version=1.0&Identifier=Identifier_of_LoadBalancer&Signature=Signature


{

"cpus": 1,

"label": "LABEL_of_LB",

"created_at": "2012-08-10T12:43:00+09:00",


"cpu_shares": 10,





"memory": 512,

"updated_at": "2012-08-10T13:02:34+09:00",





"id": ID_of_Loadbalancer,


185/205

"note": null,

"suspended": false,

"booted": true,

"hostname": "loadbalancer.example.com",



"add_to_marketplace": null,


"initial_root_password": "Password_of_LB",

"min_disk_size": 5,

"built": true,

"locked": false,

"state": "on",

"ip_addresses": {


"address": "192.168.0.220",


"netmask": "255.255.255.0",

"created_at": "2012-08-10T09:12:24+09:00",

"broadcast": "192.168.0.255",

"updated_at": "2012-08-10T09:12:24+09:00",



"free": false,


"gateway": "192.168.0.254"

},


"address": "192.168.0.221",


"netmask": "255.255.255.0",

"created_at": "2012-08-10T09:12:24+09:00",

"broadcast": "192.168.0.255",

"updated_at": "2012-08-10T09:12:24+09:00",



186/205

"free": false,


"gateway": "192.168.0.254"

}

},

"ip": [

"192.168.0.220",

"192.168.0.221"

],

"type": "lb",

"disks": {

"ID_of_Disk": {

"created_at": "2012-08-10T12:43:00+09:00",


"disk_size": 5,

"updated_at": "2012-08-10T12:43:07+09:00",

"primary": true,

"data_store_id": ID_of_DataStore,

"id": ID_of_Disk,


"is_swap": false,



"virtual_machine_id": ID_of_VM(LB),

"has_autobackups": false,

"built": true,

"locked": false

},

},

"disk": [

5,

1

],

"disk_size": 6,


"ID_of_NetworkInterface": {

187/205

"label": "LABEL-of-NetworkInterface",

"created_at": "2012-08-10T12:43:01+09:00",

"usage": null,

"updated_at": "2012-08-10T12:43:01+09:00",

"primary": true,

"id": ID_of_NetworkInterface,


"mac_address": "00:00:00:00:00:00",



"rate_limit": 1,

"identifier": "Identifier_of_NetworkInterface",

"network_join_id": ID_of_NetworkJoin,

"virtual_machine_id": ID_of_VM(LB),

"network_id": null

}

}

}

188/205

13.12. ロードバランサーのシャットダウン

実行機能名

shutdownBalancer


指定したロードバランサーをシャットダウンします。









クトのうち、lb フィールドの identifier が該

当します

○


指定したロードバランサーのシャットダウンのリクエストに成功した場合は true を

返します。

指定したロードバランサーのシャットダウンのリクエストに失敗した場合は、内容に

応じたエラーメッセージを返します。


https://api.gmocloud.com/Cloud-Zone-ID/?Action=shutdownBalancer&AccessKeyId=A

ccessKeyId&Version=1.0&Identifier=Identifier_of_LoadBalancer&Signature=Signat

ure

189/205


true

190/205

13.13. ロードバランサーの起動

実行機能名

startupBalancer


指定したロードバランサーを起動します










当します

○


指定したロードバランサーの起動のリクエストに成功した場合は true を返します。

指定したロードバランサーの起動のリクエストに失敗した場合は、内容に応じたエラ



https://api.gmocloud.com/Cloud-Zone-Id/?Action=startupBalancer&AccessKeyId=Ac

cessKeyId&Version=1.0&Identifier=Identifier_of_LoadBalancer&Signature=Signatu

re

191/205


true

192/205

13.14. ロードバランサーの再起動

実行機能名

rebootBalancer


指定したロードバランサーを再起動します。










当します

○


指定したロードバランサーの再起動のリクエストに成功した場合は true を返します。

指定したロードバランサーの再起動のリクエストに失敗した場合は、内容に応じたエ

ラーメッセージを返します。


https://api.gmocloud.com/Cloud-Zone-Id/?Action=rebootBalancer&AccessKeyId=Acc

essKeyId&Version=1.0&Identifier=Identifier_of_LoadBalancer&Signature=Signatur

e

193/205


true

194/205

13.15. ロードバランサーの再構築

実行機能名

rebuildBalancer


指定したロードバランサーの初期化を行い、その時点で使用しているテンプレートと

同じ ID のテンプレート（ユーザーテンプレートを使用している場合は同じ ID のユー

ザーテンプレート）を使用してロードバランサーの再構築（再作成）をします。

再構築後のロードバランサーは稼動状態です。










当します

○


指定した仮想サーバーの再構築のリクエストに成功した場合は true を返します。

指定した仮想サーバーの再構築のリクエストに失敗した場合は、内容に応じたエラー


195/205


https://api.gmocloud.com/Cloud-Zone-Id/?Action=rebuildBalancer&AccessKeyId=Ac

cessKeyId&Version=1.0&Identifier=Identifier_of_LoadBalancer&Signature=Signatu

re


true

196/205

13.16. ロードバランサーのマイグレーション

実行機能名

migrateBalancer


ロードバランサーを異なる別の物理マシン上に移動します。










当します

○

destination ハイパーバイザーID

マイグレーション先のハイパーバイザーのIDを

指定します



3.l. istHypervisors のレスポンスオブジェク


○

cold_migrate_on_rollback ロールバック方法

ホットマイグレーション失敗時の振る舞いを指

定します

×

197/205

1 : コールドマイグレーションに切り替えます

0 : マイグレーションを取り止めます


指定したロードバランサーのマイグレーションのリクエストに成功した場合は true

を返します。

指定したロードバランサーのマイグレーションのリクエストに失敗した場合は、内容



https://api.gmocloud.com/Cloud-Zone-Id/?Action=migrateBalancer&AccessKeyId=Ac

cessKeyId&Version=1.0&Identifier=Identifier_of_LoadBalancer&destination=ID_of

_HV&cold_migrate_on_rollback=1&Signature=Signature


true

198/205

14. Resources

14.1. 使用リソースの詳細情報の取得

実行機能名

getResources


使用しているリソースの詳細情報を取得します。






created_at GMO クラウド Public にユーザーアカウントが作成された日

時を返します



disk_space_available 仮想サーバーやロードバランサーなどに割り当てて利用す

ることができるディスクスペースの総容量の上限値を返し

ます


login GMO クラウド Public のシステム上のログインユーザー名を

返します

雲パネルアプリのログインの際に使用する ID です

memory_available 仮想サーバーやロードバランサーなどに割り当てて利用す

ることができるメモリの総容量の上限値を返します


updated_at GMO クラウド Public における契約内容（リソース等）の

199/205

終アップデート日時を返します



used_cpus 仮想サーバーやロードバランサーなどに割り当てている仮

想 CPU コア数の合計値を返します

単位は個です

used_cpu_shares 仮想サーバーやロードバランサーなどに割り当てている

CPU 占有率の合計値を返します

単位は % (Percents)です

used_disk_size 仮想サーバーやロードバランサーなどに割り当てているデ

ィスク容量の合計値を返します


used_ip_addresses 仮想サーバーやロードバランサーに割り当てられている IP

アドレスとその詳細情報を返します

このフィールドに含まれるパラメーターの構造は 9.1.

listIPaddress 項と同じです

各パラメーターの詳細は 9.1. listIpAddresses 項をご参

照ください

used_memory 仮想サーバーやロードバランサーなどに割り当てているメ

モリ容量の合計値を返します



https://api.gmocloud.com/Cloud-Zone-Id/?Action=getResources&AccessKeyId=Acces



{

"created_at": "2012-07-19T11:36:56+09:00",

200/205

"memory_available": 32768,

"used_disk_size": 36,

"updated_at": "2012-08-13T11:41:09+09:00",

"used_ip_addresses": {


"address": "192.168.0.220",


"netmask": "255.255.255.0",

"created_at": "2012-08-10T09:12:23+09:00",

"broadcast": "192.168.0.255",

"updated_at": "2012-08-10T09:12:23+09:00",



"free": false,


"gateway": "192.168.0.254"

},


"address": "192.168.0.221",


"netmask": "255.255.255.0",

"created_at": "2012-08-10T09:12:23+09:00",

"broadcast": "192.168.0.255",

"updated_at": "2012-08-10T09:12:23+09:00",



"free": false,


"gateway": "192.168.0.254"

},


"address": "192.168.0.241",


"netmask": "255.255.255.0",

"created_at": "2012-08-10T09:12:24+09:00",

"broadcast": "192.168.0.255",

201/205

"updated_at": "2012-08-10T09:12:24+09:00",



"free": false,

"id": ID_of_Network,

"gateway": "192.168.0.254"

},


"address": "192.168.0.242",


"netmask": "255.255.255.0",

"created_at": "2012-08-10T09:12:24+09:00",

"broadcast": "192.168.0.255",

"updated_at": "2012-08-10T09:12:24+09:00",



"free": false,


"gateway": "192.168.0.254"

}

},

"used_cpu_shares": 600,

"used_cpus": 24,

"used_memory": 1152,

"disk_space_available": 360,

"login": "ID_of_LoginUser",

}

202/205

14.2. リソース上限値の取得

実行機能名

getLimits


仮想サーバーやロードバランサーに割り当てて利用できるリソースやリソースの上限

値を取得します






cpus 仮想 CPU コア数の上限値を返します

単位は個です

cpu_shares CPU 占有率の上限値を返します

単位は % (Percents)です

data_store_groups データストアグループのラベルと ID を返します

hypervisors ハイパーバイザーグループのラベル、種類、IDを返します

hypervisor_groups ハイパーバイザーグループのラベルと ID を返します

memory メモリの上限値を返します


network_groups ネットワークグループのラベルと ID を返します

primary_disk_size 割り当てられるディスク容量の上限に対する残り空きサイ

ズを返します

203/205


rate ポートスピードの上限値を返します


swap_disk_size スワップディスクに割り当てられるディスク容量の上限に

対する残り空きサイズを返します



https://api.gmocloud.com/Cloud-Zone-Id/?Action=getLimits&AccessKeyId=AccessKe

yId&Version=1.0&Signature=Signature


{

"cpus": 24,

"cpu_shares": 2400,

"memory": 31616,

"swap_disk_size": 24,

"rate": 512,


"ID_of_DataStore": {

"label": "LABEL-of-DataStore",

"id": ID_of_DataStore

}

},

"network_groups": {

"ID_of_NetworkGroup": {

"label": "Public Network Zone",

"id": ID_of_NetworkGroup

},

"ID_of_NetworkGroup ": {

"label": "Local Network Zone",

"id": ID_of_NetworkGroup

204/205

}

},

"primary_disk_size": 24,

"hypervisor_groups": {

"ID_of_HypervisorGroup": {

"label": "高速ゾーン(KVM)",

"id": ID_of_HypervisorGroup

},

"ID_of_HypervisorGroup ": {

"label": "多機能ゾーン(Xen)",

"id": ID_of_HypervisorGroup

}

},

"hypervisors": {

"ID_of_Hypervisor": {

"label": "LABEL-of-Hypervisor",

"hypervisor_type": "Types_of_Hypervisor",

"id": ID_of_Hypervisor

},

}

}

205/205

15. 別紙

15.1. ネットワークグループ ID

ID 対比表

クラウドゾーン名、Cloud-Zone ID とネットワーク ID の対比表を以下に示します。

グローバルネットワーク（パブリックネットワークゾーン）とローカルネットワーク（ロ

ーカルネットワークゾーン）それぞれで IDが異なります。

クラウドポータル上の表記 Cloud-Zone ID ネットワークグループ ID

Global 4 東京 RED jp002

Local 5

Global 9 東京 BLUE jp003

Local 11

Global 27 サンノゼ RED us001

Local 7

Global 2 クアラルンプール RED my001

Local 11

Documents

GMOクラウドPublic API リファレンスsupport.gmocloud.com/public/guide/api/api.pdf · 修正履歴表（1／1） ... ・ フォーマットは iso8601の日付と時刻の組み合わせ表記に準じます。

GMOクラウドPublic API リファレンスsupport.gmocloud.com/public/guide/api/api.pdf · 修正履歴表（1／1） ... ・フォーマットは iso8601の日付と時刻の組み合わせ表記に準じます。