Documentation sur Oracle Cloud Infrastructure

Mise à jour d'une passerelle d'API

Découvrez comment modifier les passerelles d'API que vous avez créées précédemment avec le service de passerelle d'API.

Après avoir créé une passerelle d'API, vous pouvez décider de la modifier. Par exemple, vous pouvez modifier le nom de la passerelle d'API ou les marqueurs qui lui sont appliqués.

Notez qu'il existe certaines propriétés de passerelle d'API pour lesquelles vous ne pouvez pas modifier les valeurs initiales.

Vous pouvez mettre à jour les passerelles d'API à l'aide de la console, de l'interface de ligne de commande et de l'API.

    1. Dans la page de liste Passerelles, recherchez la passerelle d'API à mettre à jour. Si vous avez besoin d'aide pour trouver la page de liste ou la passerelle d'API, voir Liste des passerelles d'API.
    2. Dans le menu Actions (trois points) de la passerelle d'API :
      • Sélectionnez Modifier pour modifier l'une des propriétés de passerelle d'API suivantes :
        • Modifiez le nom de la passerelle d'API. Évitez d'entrer des informations confidentielles.
        • Activez ou désactivez l'utilisation de groupes de sécurité de réseau pour contrôler l'accès à la passerelle d'API et à partir de celle-ci en utilisant les règles de sécurité définies pour les groupes de sécurité de réseau que vous spécifiez (jusqu'à un maximum de cinq groupes de sécurité de réseau). Vous pouvez utiliser les règles de sécurité définies pour les groupes de sécurité de réseau au lieu ou en plus de celles définies pour les listes de sécurité. Les groupes de sécurité de réseau peuvent appartenir au même compartiment que la passerelle d'API, mais pas nécessairement. Voir Groupes de sécurité de réseau.
        • Modifiez le certificat TLS et le nom de domaine utilisés par la passerelle d'API. Notez que les ressources de certificat du service de passerelle d'API et les ressources de certificat du service de certificats ne sont affichées que si elles sont disponibles dans le compartiment sélectionné. Voir Configuration des domaines et des certificats TLS personnalisés.
        • Modifier les paramètres de configuration de la mémoire cache des réponses. Voir Mise en cache des réponses pour améliorer les performances.
        • Modifiez les autorités de certification et les ensembles AC inclus dans le magasin de certificats SSL de la passerelle d'API en tant qu'autorités de certification personnalisées et ensembles AC personnalisés (en plus de l'ensemble AC par défaut). Voir Personnalisation des magasins de certificats pour la vérification des certificats TLS.
      • Sélectionnez Déplacer la ressource pour déplacer la passerelle d'API vers un autre compartiment.
      • Sélectionnez l'onglet Marqueurs pour voir et modifier les marqueurs appliqués à la passerelle d'API, puis sélectionnez Ajouter des marqueurs pour appliquer d'autres marqueurs à la passerelle d'API.

  • Pour mettre à jour des passerelles d'API existantes à l'aide de l'interface de ligne de commande :

    1. Configurez l'environnement client pour utiliser l'interface de ligne de commande (Configuration de l'environnement client afin d'utiliser l'interface de ligne de commande pour le développement de passerelles d'API).

    2. Pour mettre à jour une passerelle API existante :

      1. Ouvrez une invite de commande et exécutez oci api-gateway gateway update pour mettre à jour la passerelle d'API :

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

        où :

        • <gateway-ocid> est l'OCID de la passerelle d'API à mettre à jour. Pour connaître l'OCID de la passerelle d'API, voir Liste des passerelles d'API.
        • <property-to-update> est la propriété à mettre à jour. Notez que vous pouvez uniquement modifier les valeurs display-name, --response-cache-details, --network-security-group-ids, --ca-bundles, freeform-tags et defined-tags (et certificate-id> si définie initialement pour la passerelle d'API). Toutes les autres valeurs doivent être identiques aux valeurs de la définition de passerelle initiale.
        • <property-value> est la nouvelle valeur de la propriété à modifier.

        Par exemple :

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

        La réponse à la commande comprend les données suivantes :

        • L'état du cycle de vie (par exemple, ACTIVE, FAILED).
        • L'ID demande de travail permettant de mettre à jour la passerelle d'API (les détails des demandes de travail sont disponibles pendant sept jours après l'achèvement, l'annulation ou l'échec).

        Si vous souhaitez que la commande attende avant de retourner un contrôle tant que la passerelle d'API n'est pas active (ou que la demande a échoué), incluez l'un des paramètres suivants ou les deux :

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

        Par exemple :

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

      2. (Facultatif) Pour voir le statut de la demande de travail qui met à jour la passerelle d'API, entrez :

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

      3. (Facultatif) Pour voir les journaux de la demande de travail qui met à jour la passerelle d'API, entrez :

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

      4. (Facultatif) Si la demande de travail qui met à jour la passerelle d'API échoue et que vous voulez vérifier les journaux d'erreurs, entrez :

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

      5. (Facultatif) Pour vérifier que la passerelle d'API a été mise à jour, entrez la commande suivante et vérifiez que les propriétés de la passerelle d'API sont celles attendues :

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

    Pour plus d'informations sur l'utilisation de l'interface de ligne de commande, voir Interface de ligne de commande. Pour la liste complète des indicateurs et des options disponibles pour les commandes d'interface de ligne de commande, voir Aide sur l'interface de ligne de commande.

  • Exécutez l'opération UpdateGateway pour mettre à jour une passerelle d'API.