APIデプロイメントの更新

APIゲートウェイ・サービスで以前に作成したAPIデプロイメントを変更する方法をご紹介します。

APIデプロイメントを作成してAPIゲートウェイにAPIをデプロイした後で、APIデプロイメントを変更できます。たとえば、APIデプロイメント仕様を変更して、さらにバックエンドをAPIデプロイメントに追加できます。

元の値を変更できないAPIデプロイメントのプロパティがいくつかあることに注意してください。

コンソール、CLIおよびAPIを使用して、APIデプロイメントを更新できます。APIデプロイメント仕様を更新するには、コンソールを使用するか、JSONファイルを編集します。

1. 「ゲートウェイ」リスト・ページで、更新するAPIデプロイメントを含むAPIゲートウェイを選択します。リスト・ページまたはAPIゲートウェイの検索に関するヘルプが必要な場合は、APIゲートウェイのリストを参照してください。
2. 「リソース」で、「デプロイメント」を選択します。
  「デプロイメント」リスト・ページが開きます。選択したAPIゲートウェイ内のすべてのAPIデプロイメントが表に表示されます。
3. 更新するAPIデプロイメントの「アクション」メニュー(3つのドット)から:
  
  「編集」を選択してAPIデプロイメントの名前を変更するか、元のAPIデプロイメント仕様を置換します。元のAPIデプロイメント仕様は、次のいずれかのオプションを選択して変更できます:
  
  最初から:コンソールに値を指定して、APIデプロイメント仕様のプロパティを変更します。
  
  既存のAPIのアップロード:置換JSONファイルをアップロードしてAPIデプロイメント仕様プロパティを変更します。
  
  APIデプロイメント仕様の定義の詳細は、APIデプロイメント仕様の作成を参照してください。機密情報の入力は避けてください。
  
  APIデプロイメントを別のコンパートメントに移動するには、「リソースの移動」を選択します。
  
  「タグの追加」および「タグの表示」を選択して、APIデプロイメントに適用されたタグを変更および表示します。
CLIを使用して既存のAPIデプロイメントを更新するには:
1. CLIを使用するためにクライアント環境を構成します(APIゲートウェイ開発用のCLIを使用するためのクライアント環境の構成)。
2. 既存のAPIデプロイメントを更新するには:
  
  コマンド・プロンプトを開き、oci api-gateway deployment updateを実行してAPIデプロイメントを更新します:
  oci api-gateway deployment update --deployment-id <deployment-ocid> --specification file:///<filename>
  
  ここでは:
  
  <deployment-ocid>は、更新するAPIデプロイメントのOCIDです。APIデプロイメントのOCIDを確認するには、APIゲートウェイのリストを参照してください。
  
  <filename>は、置換APIデプロイメント仕様を含むJSONファイルの相対的な場所およびファイル名です。たとえば、replacement-specification.jsonです。APIデプロイメント仕様の定義の詳細は、APIデプロイメント仕様の作成を参照してください。
  
  例:
  oci api-gateway deployment update --deployment-id ocid1.apideployment.oc1..aaaaaaaaab______pwa --specification file:///Users/jdoe/work/replacement-specification.json
  
  コマンドへのレスポンスには、次が含まれます:
  
  ライフサイクルの状態(たとえば、ACTIVE、FAILED)。
  
  APIデプロイメントを更新する作業リクエストのID(作業リクエストの詳細は、完了、取消または失敗の後の7日間利用可能です)。
  
  APIデプロイメントがアクティブになる(またはリクエストが失敗する)までコマンドが制御を返すのを待機する場合は、次のパラメータのいずれかまたは両方を含めます:
  
  --wait-for-state ACTIVE
  
  --wait-for-state FAILED
  
  例:
  oci api-gateway deployment update --deployment-id ocid1.apideployment.oc1..aaaaaaaaab______pwa --specification file:///Users/jdoe/work/replacement-specification.json --wait-for-state ACTIVE
  
  (オプション) APIデプロイメントを更新している作業リクエストのステータスを確認するには、次を入力します:
  oci api-gateway work-request get --work-request-id <work-request-ocid>
  
  (オプション) APIデプロイメントを更新している作業リクエストのログを表示するには、次を入力します:
  oci api-gateway work-request-log list --work-request-id <work-request-ocid>
  
  (オプション) APIデプロイメントを更新している作業リクエストが失敗し、エラー・ログを確認する場合は、次を入力します:
  oci api-gateway work-request-error --work-request-id <work-request-ocid>
  
  (オプション) APIデプロイメントが更新されたことを確認するには、次のコマンドを入力し、APIデプロイメントのプロパティが予想どおりであることを確認します:
  oci api-gateway deployment get --deployment-id <deployment-ocid>
CLIの使用の詳細は、コマンドライン・インタフェース(CLI)を参照してください。CLIコマンドで使用できるフラグおよびオプションの完全なリストについては、CLIのヘルプを参照してください。
UpdateDeployment操作を実行して、APIデプロイメントを更新します。

Oracle Cloud Infrastructureドキュメント

APIデプロイメントの更新