Python 用の Cloud クライアントライブラリの使用

このドキュメントでは、Python 用の Cloud クライアントライブラリを Compute Engine に使用する方法を説明します。ここで説明するのは、リクエストを承認する方法と、インスタンスを作成、一覧取得、削除する方法です。この演習では、google-api-python-client ライブラリを使用して Compute Engine リソースにアクセスする方法について説明します。このサンプルが正しく認証されると、サンプルをローカルマシンまたは VM インスタンスで実行できます。

他の Google クライアントライブラリやサードパーティのオープンソースライブラリを含む使用可能なすべてのクライアントライブラリについては、クライアントライブラリのページをご覧ください。

必要なすべてのインポートを含む完全なコードサンプルを参照するには、GoogleCloudPlatform/python-docs-samples GitHub ページをご覧ください。

目標

oauth2client ライブラリを使用して OAuth 2.0 認証を実行する
google-python-client ライブラリを使用してインスタンスを作成する
google-python-client ライブラリを使用してインスタンスの一覧を取得する
google-python-client ライブラリを使用してインスタンスを削除する

料金

このチュートリアルでは、Google Cloud の課金対象となるコンポーネント（Compute Engine を含む）を使用しています。

新しい Google Cloud ユーザーは無料トライアルをご利用いただける場合があります。

始める前に

Google アカウントにログインします。
Google アカウントをまだお持ちでない場合は、新しいアカウントを登録します。

Google Cloud Console の [プロジェクトセレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

注: この手順で作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

[プロジェクトの選択] ページに移動

Cloud プロジェクトに対して課金が有効になっていることを確認します。プロジェクトに対して課金が有効になっていることを確認する方法を学習する。

Cloud SDK をインストールします。
SDK をインストールしたら、gcloud auth application-default login を実行します。
google-api-python-client ライブラリをインストールします。通常、次のコマンドを実行します。
```
$ pip install --upgrade google-api-python-client
```
このライブラリのインストール方法の詳細については、インストール手順をご覧ください。また、Python 用 Cloud クライアントライブラリを実行するには Python 2.7 または 3.3 以降が必要です。
Cloud Storage API を有効にします。
Cloud Storage バケットを作成し、バケットの名前をメモします。

リクエストの承認

このサンプルでは、OAuth 2.0 認証を使用します。OAuth 2.0 を使用してリクエストを承認する方法は多数ありますが、この例では、アプリケーションのデフォルト認証情報を使用します。これにより、ローカルのワークステーションでサンプルを実行するときに、gcloud ツールから認証情報を再利用できます。また、Compute Engine または App Engine 内でサンプルを実行する場合には、サービスアカウントから認証情報を再利用できます。始める前にで説明している gcloud ツールをインストールし、承認しておく必要があります。

アプリケーションのデフォルトの認証情報は、Google API クライアントライブラリで自動的に提供されます。必要な作業は、この API のビルドと初期化です。

compute = googleapiclient.discovery.build('compute', 'v1')

たとえば、次のスニペットはこのサンプルのメインメソッドで、API のビルドと初期化を行い、インスタンスの作成、一覧取得、削除を実行するために呼び出しを行います。

compute/api/create_instance.py

GitHub で表示

def main(project, bucket, zone, instance_name, wait=True):
    compute = googleapiclient.discovery.build('compute', 'v1')

    print('Creating instance.')

    operation = create_instance(compute, project, zone, instance_name, bucket)
    wait_for_operation(compute, project, zone, operation['name'])

    instances = list_instances(compute, project, zone)

    print('Instances in project %s and zone %s:' % (project, zone))
    for instance in instances:
        print(' - ' + instance['name'])

    print("""
Instance created.
It will take a minute or two for the instance to complete work.
Check this URL: http://storage.googleapis.com/{}/output.png
Once the image is uploaded press enter to delete the instance.
""".format(bucket))

    if wait:
        input()

    print('Deleting instance.')

    operation = delete_instance(compute, project, zone, instance_name)
    wait_for_operation(compute, project, zone, operation['name'])

if __name__ == '__main__':
    parser = argparse.ArgumentParser(
        description=__doc__,
        formatter_class=argparse.RawDescriptionHelpFormatter)
    parser.add_argument('project_id', help='Your Google Cloud project ID.')
    parser.add_argument(
        'bucket_name', help='Your Google Cloud Storage bucket name.')
    parser.add_argument(
        '--zone',
        default='us-central1-f',
        help='Compute Engine zone to deploy to.')
    parser.add_argument(
        '--name', default='demo-instance', help='New instance name.')

    args = parser.parse_args()

    main(args.project_id, args.bucket_name, args.zone, args.name)

インスタンスの一覧取得

Python 用の Cloud クライアントライブラリを使用すると、compute.instances().list メソッドを使用してインスタンスを一覧表示できます。インスタンスの一覧を取得するプロジェクト ID とゾーンを入力する必要があります。次に例を示します。

compute/api/create_instance.py

GitHub で表示

def list_instances(compute, project, zone):
    result = compute.instances().list(project=project, zone=zone).execute()
    return result['items'] if 'items' in result else None

インスタンスの追加

インスタンスを追加するには、instances().insert メソッドを使用し、新しいインスタンスのプロパティを指定します。これらのプロパティは、リクエストの本文で指定します。各プロパティの詳細については、instances.insert の API リファレンスをご覧ください。

新しいインスタンスの作成時に、少なくとも次のプロパティの値をリクエストで指定する必要があります。

インスタンス名
ルート永続ディスク
マシンタイプ
ゾーン
ネットワークインターフェース

このサンプルは、選択したゾーンで次のプロパティを持つインスタンスを開始します。

マシンタイプ: e2-standard-2
ルート永続ディスク: 最新の Debian 8 イメージに基づく新しい永続ディスク
次のスコープを持つ Compute Engine デフォルトサービスアカウント
- https://www.googleapis.com/auth/devstorage.read_write、インスタンスで Cloud Storage 内のファイルの読み取りと書き込みを行えるようにします。
- https://www.googleapis.com/auth/logging.write、インスタンスのログを Cloud Logging にアップロードできるようにします。
起動時にインスタンスで実行する必要があるコマンドを指定するためのメタデータ

compute/api/create_instance.py

GitHub で表示

def create_instance(compute, project, zone, name, bucket):
    # Get the latest Debian Jessie image.
    image_response = compute.images().getFromFamily(
        project='debian-cloud', family='debian-9').execute()
    source_disk_image = image_response['selfLink']

    # Configure the machine
    machine_type = "zones/%s/machineTypes/n1-standard-1" % zone
    startup_script = open(
        os.path.join(
            os.path.dirname(__file__), 'startup-script.sh'), 'r').read()
    image_url = "http://storage.googleapis.com/gce-demo-input/photo.jpg"
    image_caption = "Ready for dessert?"

    config = {
        'name': name,
        'machineType': machine_type,

        # Specify the boot disk and the image to use as a source.
        'disks': [
            {
                'boot': True,
                'autoDelete': True,
                'initializeParams': {
                    'sourceImage': source_disk_image,
                }
            }
        ],

        # Specify a network interface with NAT to access the public
        # internet.
        'networkInterfaces': [{
            'network': 'global/networks/default',
            'accessConfigs': [
                {'type': 'ONE_TO_ONE_NAT', 'name': 'External NAT'}
            ]
        }],

        # Allow the instance to access cloud storage and logging.
        'serviceAccounts': [{
            'email': 'default',
            'scopes': [
                'https://www.googleapis.com/auth/devstorage.read_write',
                'https://www.googleapis.com/auth/logging.write'
            ]
        }],

        # Metadata is readable from the instance and allows you to
        # pass configuration from deployment scripts to instances.
        'metadata': {
            'items': [{
                # Startup script is automatically executed by the
                # instance upon startup.
                'key': 'startup-script',
                'value': startup_script
            }, {
                'key': 'url',
                'value': image_url
            }, {
                'key': 'text',
                'value': image_caption
            }, {
                'key': 'bucket',
                'value': bucket
            }]
        }
    }

    return compute.instances().insert(
        project=project,
        zone=zone,
        body=config).execute()

以下のセクションでは、インスタンス作成パラメータについて説明します。

ルート永続ディスク

すべてのインスタンスはルート永続ディスクから起動する必要があります。ルート永続ディスクには、インスタンスの起動に必要なすべてのファイルが含まれます。ルート永続ディスクを作成するときに、ディスクに適用する公開イメージまたはカスタムイメージを選択する必要があります。上の例では、インスタンスと同時に、Debian 8 に基づいて新しいルート永続ディスクを作成しました。ただし、ディスクを事前に作成し、インスタンスにアタッチすることもできます。

インスタンスメタデータ

インスタンスを作成するときに、起動スクリプト、構成変数、SSH 認証鍵などのインスタンスメタデータを含めることもできます。上の例では、リクエストの本文で metadata フィールドを使用してインスタンスの起動スクリプトを指定し、構成変数を Key-Value ペアとして指定しました。以下に記載されている起動スクリプトは、これらの変数を読み込んで使用し、テキストを画像に適用して Cloud Storage にアップロードする方法を示しています。

compute/api/startup-script.sh

GitHub で表示

apt-get update
apt-get -y install imagemagick

# Use the metadata server to get the configuration specified during
# instance creation. Read more about metadata here:
# https://cloud.google.com/compute/docs/metadata#querying
IMAGE_URL=$(curl http://metadata/computeMetadata/v1/instance/attributes/url -H "Metadata-Flavor: Google")
TEXT=$(curl http://metadata/computeMetadata/v1/instance/attributes/text -H "Metadata-Flavor: Google")
CS_BUCKET=$(curl http://metadata/computeMetadata/v1/instance/attributes/bucket -H "Metadata-Flavor: Google")

mkdir image-output
cd image-output
wget $IMAGE_URL
convert * -pointsize 30 -fill white -stroke black -gravity center -annotate +10+40 "$TEXT" output.png

# Create a Google Cloud Storage bucket.
gsutil mb gs://$CS_BUCKET

# Store the image in the Google Cloud Storage bucket and allow all users
# to read it.
gsutil cp -a public-read output.png gs://$CS_BUCKET/output.png

インスタンスの削除

インスタンスを削除するには、instances().delete メソッドを呼び出し、削除するインスタンスの名前、ゾーン、プロジェクト ID を指定する必要があります。起動ディスクに対して autoDelete パラメータが設定されているため、インスタンスを削除すると、ディスクも削除されます。この設定はデフォルトではオフになっていますが、ディスクとインスタンスを同時に削除する必要がある場合に使用すると便利です。

compute/api/create_instance.py

GitHub で表示

def delete_instance(compute, project, zone, name):
    return compute.instances().delete(
        project=project,
        zone=zone,
        instance=name).execute()

サンプルの実行

完全なサンプルを実行するには、コードをダウンロードして、コマンドラインで実行します。create_instance.py ファイルと startup-script.sh ファイルをダウンロードしてください。サンプルの実行方法:

python create_instance.py --name [INSTANCE_NAME] --zone [ZONE] [PROJECT_ID] [CLOUD_STORAGE_BUCKET]

ここで

[INSTANCE_NAME] は、作成するインスタンスの名前です。
[ZONE] は、このリクエストのゾーンです。
[PROJECT_ID] は、プロジェクト ID です。
[CLOUD_STORAGE_BUCKET] は、最初の設定したバケットの名前です。ただし、gs:// 接頭辞は付けません。

例:

python python-example.py --name example-instance --zone us-central1-a example-project my-gcs-bucket

オペレーション完了の待機

インスタンスなどのリソースを変更する Compute Engine API へのリクエストでは、リクエストの受信を確認するレスポンスがすぐに返されます。この確認応答で、リクエストしたオペレーションのステータスを確認できます。オペレーションの完了には数分かかることがあるため、多くの場合は、オペレーションが完了するまで待機してから続行したほうが簡単です。このヘルパーメソッドは、オペレーションが完了するまで待機してから制御を返します。

compute/api/create_instance.py

GitHub で表示

def wait_for_operation(compute, project, zone, operation):
    print('Waiting for operation to finish...')
    while True:
        result = compute.zoneOperations().get(
            project=project,
            zone=zone,
            operation=operation).execute()

        if result['status'] == 'DONE':
            print("done.")
            if 'error' in result:
                raise Exception(result['error'])
            return result

        time.sleep(1)

クリーンアップ

このチュートリアルで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、リソースを含むプロジェクトを削除するか、プロジェクトを維持して個々のリソースを削除します。

Cloud Storage バケットの削除

Cloud Storage バケットを削除するには:

Cloud Console で、[Cloud Storage ブラウザ] ページに移動します。
Cloud Storage ブラウザページに移動
削除するバケットのチェックボックスをクリックします。
[削除] をクリックして、バケットを削除します。

次のステップ

完全なコードサンプルをダウンロードして確認する。完全なサンプルには、これらすべてのメソッドを同時に使用する一例が含まれています。自由にダウンロードし、ニーズに合わせて変更し、実行してください。
API リファレンスで API を使用した他のタスクの実行方法を確認する。

Python 用の Cloud クライアント ライブラリの使用

目標

料金

始める前に

リクエストの承認

インスタンスの一覧取得

インスタンスの追加

ルート永続ディスク

インスタンス メタデータ

インスタンスの削除

サンプルの実行

オペレーション完了の待機

クリーンアップ

Cloud Storage バケットの削除

次のステップ

Python 用の Cloud クライアントライブラリの使用

インスタンスメタデータ