デプロイメントを管理する

このページは Apigee と Apigee ハイブリッドに適用されます。

このドキュメントでは、API デプロイの作成と管理について説明します。API デプロイの概要もご覧ください。 デプロイ エンティティを作成したら、1 つ以上の API バージョンにリンクできます。

デプロイを作成する

デプロイ エンティティは、コンソールまたは REST API で作成できます。

コンソール

新しいデプロイを作成するには:

  1. Google Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動
  2. [API] をクリックします。
  3. [フィルタ] を使用して、API のリストをフィルタするキーワードを指定します。 必要に応じて、[検索] を使用して API を探します。
  4. API をクリックして詳細を表示します。
  5. [デプロイ] タブで [デプロイを追加] をクリックします。
  6. [デプロイの作成] フォームで、デプロイの詳細を指定します。
    • デプロイ ID: [一意の ID を指定] をクリックし、必要に応じてデプロイの一意の ID を指定します。ID を省略すると、API Hub によって ID が作成されます。ID は 4～500 文字にする必要があります。有効な文字は /[A-Z][a-z][0-9]-/. です。
    • デプロイ名: （必須）デプロイの表示名を指定します。
    • 説明: デプロイの説明を入力します。
    • デプロイタイプ: デプロイのタイプを選択します。使用可能な値はシステム属性で定義されており、[属性を管理] で変更できます。
    • リソース URI: （必須）ランタイム リソースの URI を指定します。この URI を使用してリソースを管理できます。たとえば、ランタイム リソースが Apigee API プロキシの場合、このフィールドにはプロキシの管理ユーザー インターフェースの URI を指定する必要があります。
    • 環境: このデプロイにマッピングされた環境。環境は、システム定義の環境属性にマッピングされます。
    • ドキュメント: デプロイのドキュメントへのリンクを入力します。
    • SLO: このデプロイの SLO を指定します。これは、SLO のシステム定義属性にマッピングされます。この属性の値は、[属性を管理] で変更できます。
    • エンドポイント: （必須）このデプロイ リソースが API リクエストをリッスンするエンドポイントを指定します。完全な URI、ホスト名、IP アドレスのリストを指定できます。
    • バージョンにリンク: デプロイを 1 つ以上の API バージョンにリンクします。
    • ユーザー定義属性: ユーザー定義の Key-Value ペア。ユーザー定義属性は、[属性を管理] で追加できます。
  7. [作成] をクリックします。

REST

Create a deployment API を使用して新しいデプロイを追加するには:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments?deployment_id=DEPLOYMENT_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME
    }'

次のように置き換えます。

  • HUB_PROJECT: API Hub のホスト プロジェクトの名前。API Hub のプロビジョニング時にホスト プロジェクトが選択されました。
  • HUB_LOCATION: ホスト プロジェクトのロケーション。API Hub のプロビジョニング時にこのロケーションが選択されました。
  • DEPLOYMENT_ID: 省略可。デプロイの識別子。指定しない場合、システムで生成された ID が使用されます。名前は 4～500 文字の文字列にする必要があり、有効な文字は /[a-z][A-Z][0-9]-_/. です。
  • DISPLAY_NAME: （必須）デプロイの表示名。任意の名前を付けることができます。
  • オプションの属性: 必須の表示名に加えて、オプションの属性とエンティティをデプロイに追加できます。これらの追加項目については、REST API リファレンスのデプロイ リソースの説明をご覧ください。

API バージョンにデプロイをリンクする

1 つのバージョンに 1 つ以上のデプロイがリンクされている場合があります。このセクションでは、デプロイをバージョンにリンクする方法について説明します。デプロイをバージョンにリンクする場合は、バージョンの作成時にリンクします。デプロイを既存のバージョンにリンクする場合は、既存のバージョンを編集します。API バージョンを作成するおよびバージョンを編集するをご覧ください。

デプロイを新しいバージョンまたは既存のバージョンにリンクするには、デプロイがすでに存在している必要があります。デプロイを作成するをご覧ください。

コンソール

バージョンにデプロイを追加するには:

  1. Google Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動
  2. [API] をクリックします。
  3. [フィルタ] を使用して、API のリストをフィルタするキーワードを指定します。必要に応じて、[検索] を使用して API を探します。
  4. API を選択します。
  5. [バージョン] 表で、編集するバージョンを見つけます。
  6. バージョン行の右側にある [アクション] メニューで [編集] を選択するか、バージョンを選択して詳細ページの [バージョンを編集] をクリックします。
  7. [デプロイにリンク] で、バージョンにリンクするデプロイを 1 つ以上選択し、[OK] をクリックします。
  8. [保存] をクリックします。

REST

バージョンにデプロイを追加する例:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
  '{
    "deployments": "DEPLOYMENTS"
  }'

次のように置き換えます。

  • HUB_PROJECT: API Hub のホスト プロジェクトの名前。API Hub のプロビジョニング時にホスト プロジェクトが選択されました。
  • HUB_LOCATION: ホスト プロジェクトの場所。API Hub のプロビジョニング時に選択した場所です。
  • API_NAME: 編集するバージョンを含む API の名前。
  • VERSION_ID: 編集するバージョンの一意の ID。
  • DEPLOYMENTS: 1 つ以上のデプロイの完全修飾リソース名。例: "projects/myproject/locations/us-central1/deployments/mydeployment-1, projects/myproject/locations/us-central1/deployments/mydeployment-2"

デプロイのリスト表示

このセクションでは、デプロイを一覧取得する方法について説明します。ある特定の API の全バージョンに関連付けられたデプロイすべてを一覧取得できるほか、特定のバージョンに関連付けられたデプロイすべてを一覧取得することもできます。

コンソール

UI でデプロイを一覧取得するには:

  1. Google Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動
  2. [API] をクリックします。
  3. [フィルタ] を使用して、API のリストをフィルタするキーワードを指定します。 必要に応じて、[検索] を使用して API を探します。
  4. API をクリックして詳細を表示します。
  5. [デプロイ] タブを選択して、API に関連付けられているデプロイすべてを一覧取得します。
  6. バージョンに関連付けられているデプロイを表示する場合は、[バージョン] タブでそのバージョンを選択します。

REST

すべてのデプロイを一覧取得するには、List deployments API を使用します。

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments"
        -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

次のように置き換えます。

  • HUB_PROJECT: API Hub のホスト プロジェクトの名前。このホスト プロジェクトは API Hub のプロビジョニング時に選択されたものです。
  • HUB_LOCATION: ホスト プロジェクトの場所。API Hub のプロビジョニング時に選択した場所です。

デプロイの詳細を取得する

このセクションでは、API デプロイの詳細を取得する方法について説明します。

コンソール

デプロイの詳細を表示するには:

  1. Google Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動
  2. [API] をクリックします。
  3. [フィルタ] を使用して、API のリストをフィルタするキーワードを指定します。 必要に応じて、[検索] を使用して API を探します。
  4. API をクリックして詳細を表示します。
  5. [デプロイ] タブを選択して、API に関連付けられているデプロイすべてを一覧取得します。
  6. デプロイを選択して、その詳細ページを表示します。

REST

デプロイの詳細を表示するには、Get deployment details API を使用します。

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

次のように置き換えます。

  • HUB_PROJECT: API Hub のホスト プロジェクトの名前。このホスト プロジェクトは API Hub のプロビジョニング時に選択されたものです。
  • HUB_LOCATION: ホスト プロジェクトの場所。API Hub のプロビジョニング時に選択した場所です。
  • DEPLOYMENT_ID: デプロイの一意の ID。

API から API デプロイを削除する

このセクションでは、API デプロイを削除する方法について説明します。API から API デプロイを削除すると、まず API のすべてのバージョンとのリンクが解除されてから、API デプロイが API から削除されます。削除したデプロイは、デプロイのリストに表示されなくなり、このデプロイに基づいて API をフィルタリングすることもできなくなります。

Console

UI を使用してデプロイを削除するには:

  1. Google Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動
  2. [API] をクリックします。
  3. [フィルタ] を使用して、API のリストをフィルタするキーワードを指定します。 必要に応じて、[検索] を使用して API を探します。
  4. API をクリックして詳細を表示します。
  5. [デプロイ] タブを選択して、API に関連付けられているデプロイすべてを一覧取得します。
  6. 削除するデプロイを見つけます。
  7. デプロイの [操作] メニューで [削除] を選択します。

REST

API Hub からデプロイを削除するには、Delete deployment API を使用します。

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

次のように置き換えます。

  • HUB_PROJECT: API Hub のホスト プロジェクトの名前。このホスト プロジェクトは API Hub のプロビジョニング時に選択されたものです。
  • HUB_LOCATION: ホスト プロジェクトの場所。API Hub のプロビジョニング時に選択した場所です。
  • DEPLOYMENT_ID: 削除するデプロイの一意の ID。

API デプロイと API またはバージョンのリンクを解除する

このセクションでは、API デプロイと API またはバージョンのリンクを解除する方法について説明します。API からデプロイのリンクを解除すると、このデプロイは API のすべてのバージョンからリンク解除されます。リンクを解除すると、このデプロイはデプロイのリストに表示されなくなります。

Console

UI を使用してデプロイと API のリンクを解除するには:

  1. Google Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動
  2. [API] をクリックします。
  3. [フィルタ] を使用して、API のリストをフィルタするキーワードを指定します。 必要に応じて、[検索] を使用して API を探します。
  4. API をクリックして詳細を表示します。
  5. [デプロイ] タブを選択して、API に関連付けられているデプロイすべてを一覧取得します。
  6. リンクを解除するデプロイを見つけます。
  7. デプロイの [操作] メニューから [API とのリンクを解除] を選択します。

UI を使用してデプロイとバージョンのリンクを解除するには:

  1. Google Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動
  2. [API] をクリックします。
  3. [フィルタ] を使用して、API のリストをフィルタするキーワードを指定します。 必要に応じて、[検索] を使用して API を探します。
  4. API をクリックして詳細を表示します。
  5. バージョンを選択します。
  6. [デプロイ] セクションで、リンクを解除するデプロイを見つけます。
  7. デプロイの [操作] メニューから [バージョンとのリンクを解除] を選択します。

REST

API Hub から API リソースを削除するには、デプロイの削除 API を使用します。

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

次のように置き換えます。

  • HUB_PROJECT: API Hub のホスト プロジェクトの名前。このホスト プロジェクトは API Hub のプロビジョニング時に選択されたものです。
  • HUB_LOCATION: ホスト プロジェクトの場所。API Hub のプロビジョニング時に選択した場所です。
  • DEPLOYMENT_ID: 削除するデプロイの一意の ID。

デプロイメントを編集する

このセクションでは、デプロイを編集する方法について説明します。

コンソール

  1. Google Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動
  2. [API] をクリックします。
  3. [フィルタ] を使用して、API のリストをフィルタするキーワードを指定します。 必要に応じて、[検索] を使用して API を探します。
  4. API をクリックして詳細を表示します。
  5. [デプロイ] タブを選択して、API に関連付けられているデプロイすべてを一覧取得します。
  6. 編集するデプロイを見つけます。
  7. デプロイの [操作] メニューで [編集] を選択するか、デプロイをクリックして、[デプロイの詳細] パネルで [デプロイの編集] をクリックします。

REST

デプロイを編集するには、Patch deployment API を使用します。

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
      '{
        DEPLOYMENT_ATTRIBUTES
      {'

次のように置き換えます。

  • HUB_PROJECT: API Hub のホスト プロジェクトの名前。このホスト プロジェクトは API Hub のプロビジョニング時に選択されたものです。
  • HUB_LOCATION: ホスト プロジェクトの場所。API Hub のプロビジョニング時に選択した場所です。
  • DEPLOYMENT_ID: 編集するデプロイの一意の ID。
  • DEPLOYMENT_ATTRIBUTES: リクエスト本文内の変更する属性をアタッチします。編集可能な属性については、REST API リファレンスのデプロイ リソースの説明をご覧ください。