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

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

API は複数のデプロイメントを持つことができます。例としては、異なるステージング環境やリージョンなどがあります。デプロイメントとは、ユーザーが API にアクセスできる場所（アドレス）です。これらのデプロイメントの一つを推奨のデプロイメントとして指定できます。

[デプロイメント] タブに、編集権限を持つユーザーによって構成された API のすべてのデプロイメントが表示されます。デプロイメントは環境別にアルファベット順で表示されます。

API Registry スキーマを表示する

次に、API Hub API、バージョン、デプロイメント、仕様の関係を示します。

リファレンス	項目	説明
	レジストリ	レジストリは、API カタログとしてサービスを提供する API のコレクションです。
	バージョン	1 つの API に複数のバージョンを作成することもできます。バージョンは、クライアントが API の呼び出しに使用できる、安定したインターフェースに対応している必要があります。これらのバージョンのいずれかを推奨バージョンとして指定できます。`semver` の観点では、バージョンをメジャーバージョンにすることをおすすめします。
	デプロイ	API は、複数のステージング環境やリージョンなど、複数のデプロイメントを持つことができます。デプロイメントとは、ユーザーが API にアクセスできる場所（アドレス）です。これらのデプロイメントの 1 つが推奨デプロイメントになります。
	仕様	API バージョンは、正式な API 仕様に従って記述することを推奨しますが、必須ではありません。これらの仕様は、多くの場合に異なる API 仕様の形式を使用しています。これらの仕様形式のいずれかをメインにできます。つまり、このバージョンの他の仕様がこの仕様から派生しています。
	リビジョン	デプロイメントには変更履歴があります。デプロイメントリビジョンは、デプロイメントの特定のインスタンスを表します。デプロメントイから提供される API 実装が変更されると、1 つ以上の仕様リビジョンを参照できます。仕様には変更履歴があります。仕様のリビジョンは、仕様の後続のインスタンスを表し、通常は仕様の内容に対する互換性を損なわない変更を表します。`semver` では、リビジョンはマイナーバージョンまたはポイントバージョンに対応している場合があります。

デプロイメントを追加する

デプロイメントを追加するには:

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

[API Hub] に移動

デフォルトでは、[APIs] リストページが表示されます。
[APIs] リストから API 行をクリックします。デフォルトでは、[概要] タブが表示されます。
[デプロイメント] タブを選択します。
[デプロイを追加] をクリックします。
次の情報を入力または選択します。
- ID: API リソースの識別子。ID に使用できるのは小文字、数字、ハイフンのみです。この ID はプロジェクト内で一意である必要があります。ID は、4～63 文字にする必要があります。デプロイメントの作成後に ID を変更することはできません。
- 環境: API のインスタンスを使用できる場所。例: 本番環境、ステージング、テストなど。
- ゲートウェイ: ゲートウェイの種類。API の提供と保護に使用するプロキシ。システム分類として定義されます。
- API バージョン: このデプロイメントで提供される API のバージョン。バージョンにリビジョンがない場合、リスト内ではこのようにマークが付けられ、選択できません。
- 外部チャネルの名前と URL: デベロッパーポータルなど、API の外部チャネルへのリンクのラベルと URL
- アクセス情報
  - 使用上のガイダンス: デプロイメントのオーディエンスを指定するガイダンス。たとえば、一般利用、内部テストなど
  - サーバーエンドポイント: API のサーバーエンドポイント
  - アクセスガイダンス: API コンシューマーがデプロイメントにアクセスする方法を記述する自由形式のマークダウンコンテンツ。
[保存] または [キャンセル] をクリックします。

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

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

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

[API Hub] に移動

デフォルトでは、[APIs] リストページが表示されます。
[APIs] リストから API 行をクリックします。デフォルトでは、[概要] タブが表示されます。
[デプロイメント] タブを選択します。
デプロイメントの横にある [その他] > [ 編集] をクリックします。
必要に応じて変更を行います。
リビジョンを更新する: このチェックボックスは、現在選択されているバージョンに、すでにデプロイメントに割り当てられているバージョンよりも新しい仕様リビジョンがある場合に表示されます。デプロイ済みの仕様リビジョンを更新するには、このボックスをオンにします。
[保存] または [キャンセル] をクリックします。

デプロイメントを削除する

デプロイメントを削除するには:

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

[API Hub] に移動

デフォルトでは、[APIs] リストページが表示されます。
[APIs] リストから API 行をクリックします。デフォルトでは、[概要] タブが表示されます。
[デプロイメント] タブを選択します。
デプロイメントの横にある [その他] > [ 削除] をクリックします。
確認のプロンプトで [削除] または [キャンセル] をクリックします。

推奨デプロイメントを指定する

推奨デプロイメントを設定またはクリアするには:

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

[API Hub] に移動

デフォルトでは、[APIs] リストページが表示されます。
[APIs] リストから API 行をクリックします。デフォルトでは、[概要] タブが表示されます。
[デプロイメント] タブを選択します。
目的のデプロイメントの行で、 [その他] > [おすすめとして設定] をクリックします。推奨のデプロイメントをクリアすることはできません。推奨のデプロイメントとしてのみ別のデプロイメントを指定できます。

アクセス権を取得する

API にアクセスする方法を表示するには:

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

[API Hub] に移動

デフォルトでは、[APIs] リストページが表示されます。
[APIs] リストから API 行をクリックします。デフォルトでは、[概要] タブが表示されます。
[全般] ペインまたは [デプロイメント] タブで、[Get access] をクリックして [アクセス] API パネルを開きます。[Get access] ボタンがない場合は、情報が提供されていません。アクセス情報を追加する手順については、デプロイメントを追加するをご覧ください。
リストからデプロイメントを選択します。デプロイメントにアクセス権に関する情報がない場合は、リスト内でそのようにマークが付けられ、選択できません。

外部チャネルに移動する

外部チャネルに移動するには:

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

[API Hub] に移動

デフォルトでは、[APIs] リストページが表示されます。
[APIs] リストから API 行をクリックします。デフォルトでは、[概要] タブが表示されます。
[デプロイメント] タブを選択します。
外部チャネルのリンクをクリックすると、ポータルなどの外部チャネルに移動します（定義されている場合）。