APIゲートウェイの更新

APIゲートウェイ・サービスで以前に作成したAPIゲートウェイの変更方法を確認します。

APIゲートウェイを作成した後、APIゲートウェイを変更する場合があります。たとえば、APIゲートウェイの名前またはそれに適用されたタグを変更できます。

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

コンソール、CLIおよびAPIを使用して、APIゲートウェイを更新できます。

1. 「ゲートウェイ」リスト・ページで、更新するAPIゲートウェイを検索します。リスト・ページまたはAPIゲートウェイの検索に関するヘルプが必要な場合は、APIゲートウェイのリストを参照してください。
2. APIゲートウェイの「アクション」メニュー()から:
  
  「編集」を選択して、次のAPIゲートウェイ・プロパティのいずれかを変更します:
  
  APIゲートウェイの名前を変更します。機密情報の入力は避けてください。
  
  指定したNSGに定義されているセキュリティ・ルール(最大5つのネットワーク・セキュリティ・グループ)を使用して、APIゲートウェイとの間のアクセスを制御するためのネットワーク・セキュリティ・グループ(NSG)の使用を有効または無効にします。セキュリティ・リストに対して定義されたセキュリティ・ルールのかわりに、またはそれに加えてNSGに定義されたセキュリティ・ルールを使用できます。NSGは、APIゲートウェイと同じコンパートメントに属することができますが、する必要はありません。ネットワーク・セキュリティ・グループを参照してください。
  
  APIゲートウェイで使用されるTLS証明書およびドメイン名を変更します。APIゲートウェイ証明書リソースおよび証明書サービス証明書リソースは、選択したコンパートメントで使用可能な場合にのみ表示されることに注意してください。カスタム・ドメインおよびTLS証明書の設定を参照してください。
  
  レスポンス・キャッシュ構成設定を変更します。「パフォーマンス向上のためのレスポンスのキャッシュ」を参照してください。
  
  APIゲートウェイのトラスト・ストアに含まれる認証局(CA)およびCAバンドルを、カスタムCAおよびカスタムCAバンドル(デフォルトのCAバンドルに加えて)として変更します。「TLS証明書検証のためのトラスト・ストアのカスタマイズ」を参照してください。
  
  APIゲートウェイを別のコンパートメントに移動するには、「リソースの移動」を選択します。
  
  「タグ」タブを選択してAPIゲートウェイに適用されたタグを表示および編集し、「タグの追加」を選択してAPIゲートウェイにさらにタグを適用します。
CLIを使用して既存のAPIゲートウェイを更新するには:
1. CLIを使用するためにクライアント環境を構成します(APIゲートウェイ開発用のCLIを使用するためのクライアント環境の構成)。
2. 既存のAPIゲートウェイを更新するには:
  
  コマンド・プロンプトを開き、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ゲートウェイのリストを参照してください。
  
  <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
  
  (オプション) 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 gateway get --gateway-id <gateway-ocid>
CLIの使用の詳細は、コマンドライン・インタフェース(CLI)を参照してください。CLIコマンドで使用できるフラグおよびオプションの完全なリストについては、CLIのヘルプを参照してください。
UpdateGateway操作を実行して、APIゲートウェイを更新します。

Oracle Cloud Infrastructureドキュメント

APIゲートウェイの更新