Python で Cloud Run functions の HTTP 関数を作成してデプロイする（第 1 世代）

このガイドでは、Python ランタイムを使用して Cloud Run functions の関数を記述するプロセスを説明します。Cloud Run functions には次の 2 つのタイプがあります。

• HTTP 関数。標準的な HTTP リクエストから呼び出します。
• イベント ドリブン関数。Pub/Sub トピックのメッセージや Cloud Storage バケットの変更など、Cloud インフラストラクチャのイベントを処理するために使用します。

次のサンプルでは、簡単な HTTP 関数を作成しています。

詳細: 詳細については、HTTP 関数とイベント ドリブン関数をご覧ください。

始める前に

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions and Cloud Build APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions and Cloud Build APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

1. gcloud CLI をインストールして初期化します。
2. gcloud コンポーネントを更新してインストールします。

   gcloud components update

注: コマンド プロンプトが必要な場合は、Google Cloud Shell を使用できます。Google Cloud Shell は、Google Cloud CLI がすでに含まれているコマンドライン環境であるため、インストールする必要はありません（Google Cloud CLI は、Google Compute Engine の仮想マシンにもプリインストールされています）。
3. 開発環境を準備します。

   Python 設定ガイドに移動

関数を作成する

1. 関数コードで使用するため、ローカル システムにディレクトリを作成します。

   Linux / Mac OS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

   mkdir %HOMEPATH%\helloworld
   cd %HOMEPATH%\helloworld
   

2. helloworld ディレクトリに、次の内容の main.py ファイルを作成します。

   
   import functions_framework
   
   
   from markupsafe import escape
   
   @functions_framework.http
   def hello_http(request):
       """HTTP Cloud Function.
       Args:
           request (flask.Request): The request object.
           <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
       Returns:
           The response text, or any set of values that can be turned into a
           Response object using `make_response`
           <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
       """
       request_json = request.get_json(silent=True)
       request_args = request.args
   
       if request_json and "name" in request_json:
           name = request_json["name"]
       elif request_args and "name" in request_args:
           name = request_args["name"]
       else:
           name = "World"
       return f"Hello {escape(name)}!"
   
   

   このサンプル関数は HTTP リクエストで指定された名前を使用します。名前が指定されていない場合は、「Hello World!」という挨拶を返します。

   注: Cloud Run functions は、デフォルトで main.py にデプロイ可能な関数を探します。gcloud を介して関数をデプロイし、main.py ファイルを含む別のディレクトリを指定する場合は、--source フラグを使用します。

依存関係を指定する

Python における依存関係は pip で管理され、requirements.txt というメタデータ ファイルで表現されます。このファイルは、関数のコードを含む main.py ファイルと同じディレクトリに置く必要があります。

この特定のサンプルを実行するために requirements.txt を作成する必要はありませんが、独自の依存関係を追加するとします。方法は次のとおりです。

1. helloworld ディレクトリに requirements.txt ファイルを作成します。

2. 関数の依存関係を requirements.txt ファイルに追加します。次に例を示します。

   # An example requirements file, add your dependencies below
   sampleproject==2.0.0
   

詳細: 詳細については、依存関係の指定をご覧ください。

関数をデプロイする

HTTP トリガーを使用して関数をデプロイするには、helloworld ディレクトリで次のコマンドを実行します。

gcloud functions deploy hello_http --no-gen2 --runtime python313 --trigger-http --allow-unauthenticated

--allow-unauthenticated フラグを使用すると、認証なしで関数にアクセスできます。認証を要求するには、フラグを省略します。

詳細: 詳細については、Cloud Run functions のデプロイをご覧ください。

関数をテストする

1. 関数がデプロイされたら、httpsTrigger.url プロパティをメモするか、次のコマンドを使用して検索します。

   gcloud functions describe hello_http
   

   次のようになります。

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http

2. ブラウザで、この URL にアクセスします。「Hello World!」というメッセージが表示されます。

   たとえば、次の URL を使用して HTTP リクエストで名前を渡します。

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http?name=NAME

   「Hello NAME!」というメッセージが表示されます。

ログを表示する

Cloud Run functions のログは、Google Cloud CLI を使用して、また Cloud Logging UI で表示できます。

コマンドライン ツールを使用する

gcloud CLI を使用して関数のログを表示するには、logs read コマンドの後に関数の名前を続けます。

gcloud functions logs read hello_http

出力は次のようになります。

LEVEL  NAME        EXECUTION_ID  TIME_UTC                 LOG
D      hello_http  pdb5ys2t022n  2019-09-18 23:29:09.791  Function execution started
D      hello_http  pdb5ys2t022n  2019-09-18 23:29:09.798  Function execution took 7 ms, finished with status code: 200

注: 通常、ログエントリが作成されてから Cloud Logging に表示されるまでに若干時間がかかります。

Logging ダッシュボードを使用する

Google Cloud コンソールで Cloud Run functions のログを確認することもできます。

詳細: 詳細については、ログの作成、表示、処理をご覧ください。