前提条件

このドキュメントでは、Compute Engine API を使用する前提条件について説明します。

最初のクライアント アプリケーションのコーディングを開始する前に完了していない場合は、いくつか行うことがあります。

Google アカウントを取得する

Compute Engine API にアクセスするには、Google アカウントが必要です。既存のアカウントをお持ちの場合は、すでにアクセス権をお持ちです。

テスト用に別の Google アカウントを取得することもできます。

Compute Engine への登録と試用

まず、次のいずれかのガイドを使用して Compute Engine に VM インスタンスを作成できます。

続行する前に、Compute Engine に慣れておくことが重要です。API ドキュメントでは、Compute Engine の使用経験があり、ウェブ プログラミングのコンセプトとウェブデータ形式の知識があることを前提としています。

認証について学習する

Compute Engine に対する認証方法は、API へのアクセス方法によって異なります。詳しくは、Compute Engine に対する認証をご覧ください。

REST について

API は次の 2 つの方法で呼び出すことができます。

クライアント ライブラリを使用しない場合は、REST の基礎を理解する必要があります。

REST の基本

REST は、データをリクエストして変更するための便利で一貫したアプローチを提供するソフトウェア アーキテクチャの 1 つのスタイルです。

REST という用語は「Representational State Transfer」の省略形です。Google API のコンテキストでは、HTTP 動詞を使用して、Google が保存しているデータ表現を取得および変更することを表しています。

RESTful システムでは、リソースはデータストアに保存されており、クライアントはサーバーが特定のアクション（リソースの作成、取得、更新、削除など）を実行するようにリクエストを送信し、サーバーはそのアクションを実行し、多くの場合、指定されたリソースの表現形式でレスポンスを送信します。

Google の RESTful API では、クライアントは POST、GET、PUT、DELETE などの HTTP 動詞を使用してアクションを指定します。また、次の形式のグローバルに一意な URI でリソースを指定します。

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

すべての API リソースは HTTP でアクセス可能な一意の URI を持っているため、REST はデータ キャッシュを有効にし、ウェブの分散インフラストラクチャで動作するように最適化されています。

HTTP 1.1 標準のドキュメントのメソッド定義をご覧ください。GET、POST、PUT、DELETE の仕様が記載されています。

Compute Engine API の REST

Compute Engine API オペレーションは REST の HTTP 動詞に直接マッピングされています。

Compute Engine API では、URI に次の形式を使用します。

https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH

URI には次の値が含まれます。

  • API_VERSION: 使用する API バージョン。これは、Compute Engine リソースの起動ステージに対応しています。次のようになります。
    • 一般提供のリソースの場合: v1
    • パブリック プレビュー版のリソースの場合: beta
    • 限定公開プレビュー版のリソースの場合: alpha
  • RESOURCE_PATH: 特定の Compute Engine リソースへのパス（例: projects/example-project/aggregated/instances）。API バージョンごとに使用可能なリソースについては、以下をご覧ください。

クエリ パラメータを追加する場合は、疑問符（?）の後に URI に追加します。

https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH?QUERY_PARAMETERS

URI の QUERY_PARAMETERS は、アンパサンド（&）で区切られたクエリ パラメータのリストです（例: format=json&filter=zone=us-central1-a）。

JSON データ形式について

Compute Engine API はデータを JSON 形式で返します。

JSON（JavaScript Object Notation）は言語に依存しない一般的なデータ フォーマットであり、任意のデータ構造を単純なテキスト形式で表示します。詳しくは json.org をご覧ください。