Google Compute Engine API は HTTP と JSON を基に構築されているため、標準の HTTP クライアントであれば、この API にリクエストを送信してレスポンスを解析できます。
ただし、手動で HTTP リクエストを作成してレスポンスを解析するのではなく、クライアント ライブラリを使用することをおすすめします。クライアント ライブラリでは、言語の統合性が高く、セキュリティも強化されています。また、ユーザーの承認が必要な呼び出しもサポートしています。
Compute Engine API は、Google が提供するさまざまなライブラリや、Compute Engine 上で動作することが確認されているサードパーティのオープンソース ライブラリから利用できます。このドキュメントでは、Google 提供のライブラリ、および一部の利用可能なサードパーティ製オープンソース ライブラリについて説明します。
利用可能なライブラリ
コミュニティ ライブラリ
ライブラリ | 言語 | ベンダー | ウェブサイト | Compute Engine の使用開始 |
---|---|---|---|---|
libcloud | Python | コミュニティ | ウェブサイト | ドキュメント |
jclouds | Java、Clojure | コミュニティ | ウェブサイト | ドキュメント |
fog.io | Ruby | コミュニティ | ウェブサイト | ドキュメント |
Google Cloud クライアント ライブラリ
ライブラリ | 言語 | ベンダー | ウェブサイト | Compute Engine の使用開始 |
---|---|---|---|---|
Google Cloud Node.js クライアント ライブラリ | Node.js | ウェブサイト | ドキュメント |
Google API クライアント ライブラリ
ライブラリ | 言語 | ベンダー | ウェブサイト | Compute Engine の使用開始 |
---|---|---|---|---|
Google API Java クライアント ライブラリ | Java | ウェブサイト | ドキュメント | |
Google API .NET クライアント ライブラリ | .NET | ウェブサイト | ドキュメント | |
Google API Go クライアント ライブラリ | Go | ウェブサイト | ドキュメント | |
Google API JavaScript クライアント ライブラリ | JavaScript | ウェブサイト | ドキュメント | |
Google API Ruby クライアント ライブラリ | Ruby | ウェブサイト | ドキュメント | |
Google API Node.js クライアント ライブラリ | Node.js | ウェブサイト | ドキュメント | |
Google API Objective C クライアント ライブラリ | Objective C | ウェブサイト | ドキュメント | |
Google API PHP クライアント ライブラリ | PHP | ウェブサイト | ドキュメント | |
Google API Python クライアント ライブラリ | Python | ウェブサイト | ドキュメント |
libcloud
libcloud は、1 つの統一された API を介して多数の広く利用されているクラウド サービス プロバイダとやり取りするための Python ライブラリです。
Compute Engine に関するメモ
Apache libcloud API プロジェクトでは、2013 年 7 月以来、Compute Engine 向けのサポートとアップデートが確実に実施されてきました。この API は、インスタンス、ディスク、ネットワークとファイアウォール、ロードバランサなど、Compute Engine の広範な機能をサポートしています。便利なスタートアップ デモも用意されており、libcloud と Compute Engine の使い方を示した優れたコード例が含まれています。
jclouds
jclouds は、複数のクラウド プロバイダで Java と Clojure を使えるようにするオープンソース ライブラリです。
Compute Engine に関するメモ
jclouds クラウド API は Compute Engine をサポートしており、ユーザーはこの API を使用して、仮想マシン、ディスク、ネットワーキングなどのリソースを管理できます。バージョン 1.9 より、Compute Engine は、jclouds コアに組み込まれました。
fog.io
fog.io は、1 つの API で複数のクラウド サービスとのやり取りを可能にするオープンソース Ruby ライブラリです。
Compute Engine に関するメモ
fog.io クラウド API は、2013 年 5 月にリリースされたバージョン 1.11.0 より、Compute Engine をサポートしています。fog.io のドキュメントを参照して、Compute Engine と fog の使用を開始してみましょう。fog.io API は、作成、破棄、ブートストラップなどのインスタンス オペレーションや、ディスク、ネットワーク、ロードバランサといったリソースの管理をサポートしています。
Google Cloud Node.js クライアント ライブラリ
Compute Engine Node.js スタートガイドをご覧ください。
Google API Java クライアント ライブラリ
このページには、Google API Client Library for Java を使用して Compute Engine API の使用を開始するための情報が記載されています。以下のドキュメントも必要に応じて参照してください。
- Compute Engine API の JavaDoc リファレンスを閲覧する
- Java 用 Google API クライアント ライブラリのデベロッパー ガイドを読む
- Compute Engine API の API Explorer を使用してブラウザ内でこの API を使う
サンプル
クライアント ライブラリの使用を開始するにあたっては、compute-engine-cmdline-sample をご参照ください。
プロジェクトにライブラリを追加する
以下のタブからビルド環境(Maven または Gradle)を選択するか、必要な jar ファイルすべてを含む zip ファイルをダウンロードしてください。
Java 用 Compute Engine API v1 クライアント ライブラリをダウンロードします。
下記の詳細については、compute/readme.html
ファイルをご覧ください。
- zip ファイルの内容
- 各アプリケーション タイプ(ウェブ アプリケーション、インストール アプリケーション、Android アプリケーション)に必要な依存 Jar ファイル。
libs
フォルダには、すべてのアプリケーション タイプで必要となる可能性のあるグローバルに適用可能な依存関係がすべて格納されています。
以下を pom.xml
ファイルに追加してください。
Maven Central Repository で入手可能なすべてのバージョンを確認してください。
以下を build.gradle
ファイルに追加してください。
Maven Central Repository で入手可能なすべてのバージョンを確認してください。
Google API .NET クライアント ライブラリ
このページには、.NET 用 Google API クライアント ライブラリを使用して Compute Engine API の使用を開始するための情報が記載されています。以下のドキュメントも必要に応じて参照してください。
- Compute Engine API の .NET リファレンス ドキュメントを閲覧する
- .NET 用 Google API クライアント ライブラリのデベロッパー ガイドを読む
- Compute Engine API の API Explorer を使用してブラウザ内でこの API を使う
ライブラリをダウンロードする
Google.Apis.compute で提供されているパッケージの中から NuGet をインストールします。
Google API Go クライアント ライブラリ
このセクションには、Google API Go クライアント ライブラリを使用して Compute Engine API の使用を開始するための情報が記載されています。以下のドキュメントも必要に応じて参照してください。
- Google API Go クライアント ライブラリのスタートガイドを読む
- Google API Explorer を使用してブラウザ内でこの API を使う
ライブラリをダウンロードおよびインストールする
ライブラリをインストールするには、次のコマンドを実行します。
go get google.golang.org/api/compute/v1
ライブラリを使用する
コード内にライブラリをインポートします。
package main
import (
"google.golang.org/api/compute/v1"
)
Google API JavaScript クライアント ライブラリ
このセクションには、Google API JavaScript クライアント ライブラリを使用して Compute Engine API の使用を開始するための情報が記載されています。以下のドキュメントも必要に応じて参照してください。
- スタートガイドを読む
- JavaScript クライアント ライブラリを使用して開発する方法を学習する
- Compute Engine 固有のはじめての JavaScript の例を参照する
- Google API Explorer を使用してブラウザ内でこの API を使う
API を使用する
API を使用するには、まずライブラリを読み込む必要があります。以下をコードに追加します。
<script src="https://apis.google.com/js/client.js?onload=handleClientLoad"></script>
Google API Ruby クライアント ライブラリ
このページには、Ruby 用 Google API クライアント ライブラリを使用して Compute Engine API の使用を開始するための情報が記載されています。以下のドキュメントも必要に応じて参照してください。
- Ruby 用 Google API クライアント ライブラリのスタートガイドを読む
- Compute Engine API の API Explorer を使用してブラウザ内でこの API を使う
google-api-client gem をインストールする
Ruby 用 Google API クライアント ライブラリを初めてインストールする場合は、ターミナルを開き、RubyGems
を使用してインストールします。
$ gem install google-api-client
google-api-client gem がすでにインストールされている場合は、最新のバージョンにアップデートするだけです。
$ gem update -y google-api-client
システムによっては、これらのコマンドの前に sudo
を付ける必要があります。
Ruby 用 Google API クライアント ライブラリを使ってみる
Google 提供のスタートガイドを読み、最初のリクエストを行う方法を確認してください。
Google API Node.js クライアント ライブラリ
Compute Engine Node.js スタートガイドをご覧ください。
Google API Objective C クライアント ライブラリ
このセクションには、Google API Objective C クライアント ライブラリを使用して Compute Engine API の使用を開始するための情報が記載されています。以下のドキュメントも必要に応じて参照してください。
- 概要を読む
- Google API Explorer を使用してブラウザ内でこの API を使う
ライブラリをリンクする
手順に沿って Google API Objective-C クライアント ライブラリをプロジェクトに追加します。
Google API PHP クライアント ライブラリ
このセクションには、Google API PHP クライアント ライブラリを使用して Compute Engine API の使用を開始するための情報が記載されています。以下のドキュメントも必要に応じて参照してください。
- インストール ガイドを読む
- GitHub からライブラリを取得する
- Google API Explorer を使用してブラウザ内でこの API を使う
ライブラリをダウンロードする
このライブラリは、composer.json に依存関係として追加することでインストールできます。
"require": {
"google/apiclient": "1.0.*"
}
このライブラリは GitHub でも入手できるため、git clone
メソッドを使用してローカル リポジトリにクローンを作成できます。
git clone https://github.com/google/google-api-php-client.git .
ライブラリを使用する
ライブラリ ファイルの場所を定義する最良の方法は、PHP.ini 構成ファイル内のパスにライブラリ ファイルの場所を追加することです。
include_path = ".:/usr/local/lib/php:/path/to/google-api-php-client/src"
上記と同じ ini ディレクティブをコード内で動的に設定することもできます。
set_include_path(get_include_path() . PATH_SEPARATOR . '/path/to/google-api-php-client/src');
Google API Python クライアント ライブラリ
このページには、Python 用 Google API クライアント ライブラリを使用して Compute Engine API の使用を開始するための情報が記載されています。以下のドキュメントも必要に応じて参照してください。
- Compute Engine API の PhDoc リファレンスを閲覧する
- Python 用 Google API クライアント ライブラリのデベロッパー ガイドを読む
- Compute Engine API の API Explorer を使用してブラウザ内でこの API を使う
システム要件
-
オペレーティング システム:
- Linux
- Mac OS X
- Windows
- Python 2.7、または 3.4 以降
クライアント ライブラリのインストール
パッケージ マネージャーを使用するか、Python クライアント ライブラリを手動でダウンロードしてインストールできます。
マネージド インストール
pip または setuptools を使用してインストールを管理します(場合によっては、最初に sudo
を実行する必要があります)。
- pip(推奨):
$ pip install --upgrade google-api-python-client
-
Setuptools: setuptools パッケージに含まれる
easy_install
ツールを使用します。$ easy_install --upgrade google-api-python-client
手動インストール
最新の Python 用クライアント ライブラリをダウンロードし、コードを解凍して、
python setup.py install
を実行します。
App Engine
Python クライアント ライブラリは App Engine Python ランタイム環境にはインストールされていないため、サードパーティ ライブラリと同じようにアプリケーションに組み込む必要があります。