APIゲートウェイまたはAPIデプロイメントの更新

• コンソール
• CLI
• API

• 1. ナビゲーション・メニューを開き、「開発者サービス」をクリックします。「API管理」で、「ゲートウェイ」をクリックします
  2. 更新するAPIゲートウェイまたはAPIデプロイメントを含むコンパートメントを選択します。
  3. APIゲートウェイの名前をクリックして、APIゲートウェイの詳細ページを開きます。

  4. APIゲートウェイを更新するには、次のいずれかのアクションを実行します:

     • 「編集」をクリックして、次のAPIゲートウェイ・プロパティのいずれかを変更します:
       • APIゲートウェイの名前を変更します。機密情報の入力は避けてください。
       • 指定したNSGに定義されているセキュリティ・ルール(最大5つのネットワーク・セキュリティ・グループ)を使用して、APIゲートウェイとの間のアクセスを制御するためのネットワーク・セキュリティ・グループ(NSG)の使用を有効または無効にします。セキュリティ・リストに対して定義されたセキュリティ・ルールのかわりに、またはそれに加えてNSGに定義されたセキュリティ・ルールを使用できます。NSGは、APIゲートウェイと同じコンパートメントに属することができますが、する必要はありません。ネットワーク・セキュリティ・グループを参照してください。
       • APIゲートウェイで使用されるTLS証明書およびドメイン名を変更します。APIゲートウェイ証明書リソースおよび証明書サービス証明書リソースは、選択したコンパートメントで使用可能な場合にのみ表示されます。カスタム・ドメインおよびTLS証明書の設定を参照してください。
       • レスポンス・キャッシュ構成設定を変更します。「パフォーマンス向上のためのレスポンスのキャッシュ」を参照してください。
       • APIゲートウェイのトラスト・ストアに含まれる認証局(CA)およびCAバンドルを(デフォルトのCAバンドルに加えて)カスタムCAおよびカスタムCAバンドルとして変更します。「TLS証明書検証のためのトラスト・ストアのカスタマイズ」を参照してください。
     • APIゲートウェイを別のコンパートメントに移動するには、「リソースの移動」をクリックします。
     • 「タグ」タブをクリックしてAPIゲートウェイに適用されたタグを表示および編集し、「タグの追加」をクリックしてAPIゲートウェイにさらにタグを適用します。

  5. APIデプロイメントを更新するには、次のアクションを実行します:

     1. 「ゲートウェイの詳細」ページで、「リソース」リストから「デプロイメント」を選択します。
     2. 更新するAPIデプロイメントの「アクション」メニュー()をクリックし、次のいずれかのアクションを実行します:

        • 「編集」を選択してAPIデプロイメントの名前を変更するか、元のAPIデプロイメント仕様を置換します。元のAPIデプロイメント仕様は、次のいずれかのオプションを選択して変更できます:

          • 最初から: コンソールに値を指定して、APIデプロイメント仕様プロパティを変更します。
          • 既存のAPIのアップロード:置換JSONファイルをアップロードしてAPIデプロイメント仕様プロパティを変更します。

          APIデプロイメント仕様の定義の詳細は、APIデプロイメント仕様の作成を参照してください。機密情報の入力は避けてください。

        • APIデプロイメントを別のコンパートメントに移動するには、「リソースの移動」を選択します。
        • 「タグの追加」および「タグの表示」を選択して、APIデプロイメントに適用されたタグを変更および表示します。

• CLIを使用して既存のAPIゲートウェイおよびAPIデプロイメントを更新するには:

  1. CLIを使用するためにクライアント環境を構成します(APIゲートウェイ開発用のCLIを使用するためのクライアント環境の構成)。

  2. 既存のAPIゲートウェイを更新するには:

     1. コマンド・プロンプトを開き、oci api-gateway gateway updateを実行してAPIゲートウェイを更新します:

        oci api-gateway gateway update --gateway-id <gateway-ocid> --<property-to-update> <property-value>

        ここでは:

        • <gateway-ocid>は、更新するAPIゲートウェイのOCIDです。APIゲートウェイのOCIDを確認するには、APIゲートウェイおよびAPIデプロイメントのリストを参照してください。
        • <property-to-update>は、更新するプロパティです。値を変更できるのは、display-name、--response-cache-details、--network-security-group-ids、--ca-bundles、freeform-tagsおよびdefined-tagsのみです(これが最初にAPIゲートウェイに対して設定されていた場合はcertificate-id>も変更できます)。その他の値はすべて、元のゲートウェイ定義の値と同一である必要があります。
        • <property-value>は、変更するプロパティの新しい値です。

        例:

        oci api-gateway gateway update --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --display-name "Hello World Gateway - version 2"

        コマンドへのレスポンスには、次が含まれます:

        • ライフサイクルの状態(たとえば、ACTIVE、FAILED)。
        • APIゲートウェイを更新する作業リクエストのID(作業リクエストの詳細は、完了、取消または失敗の後の7日間利用可能です)。

        APIゲートウェイがアクティブになる(またはリクエストが失敗する)までコマンドが制御を返すのを待機するには、次のいずれかまたは両方のパラメータを含めます:

        • --wait-for-state ACTIVE
        • --wait-for-state FAILED

        例:

        oci api-gateway gateway update --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --display-name "Hello World Gateway - version 2" --wait-for-state ACTIVE

     2. (オプション) APIゲートウェイを更新している作業リクエストのステータスを確認するには、次を入力します:

        oci api-gateway work-request get --work-request-id <work-request-ocid>

     3. (オプション) APIゲートウェイを更新している作業リクエストのログを表示するには、次を入力します:

        oci api-gateway work-request-log list --work-request-id <work-request-ocid>

     4. (オプション) APIゲートウェイを更新している作業リクエストが失敗し、エラー・ログを確認する場合は、次を入力します:

        oci api-gateway work-request-error --work-request-id <work-request-ocid>

     5. (オプション) APIゲートウェイが更新されたことを確認するには、次のコマンドを入力し、APIゲートウェイのプロパティが予想どおりであることを確認します:

        oci api-gateway gateway get --gateway-id <gateway-ocid>

  3. 既存のAPIデプロイメントを更新するには:

     1. コマンド・プロンプトを開き、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ゲートウェイおよび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

     2. (オプション) APIデプロイメントを更新している作業リクエストのステータスを確認するには、次を入力します:

        oci api-gateway work-request get --work-request-id <work-request-ocid>

     3. (オプション) APIデプロイメントを更新している作業リクエストのログを表示するには、次を入力します:

        oci api-gateway work-request-log list --work-request-id <work-request-ocid>

     4. (オプション) APIデプロイメントを更新している作業リクエストが失敗し、エラー・ログを確認する場合は、次を入力します:

        oci api-gateway work-request-error --work-request-id <work-request-ocid>

     5. (オプション) APIデプロイメントが更新されたことを確認するには、次のコマンドを入力し、APIデプロイメントのプロパティが予想どおりであることを確認します:

        oci api-gateway deployment get --deployment-id <deployment-ocid>

  CLIの使用の詳細は、コマンドライン・インタフェース(CLI)を参照してください。CLIコマンドで使用できるフラグおよびオプションの完全なリストについては、CLIのヘルプを参照してください。

• 次を実行します。

  • APIゲートウェイを更新するUpdateGateway操作
  • APIデプロイメントを更新するUpdateDeployment操作