Documentation 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 API Gateway.

Une fois que vous avez 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 balises qui lui sont appliquées.

Vous ne pouvez pas modifier les valeurs d'origine de certaines propriétés des passerelles d'API.

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

    1. Sur la page de liste Passerelles, recherchez la passerelle d'API à mettre à jour. Si vous avez besoin d'aide pour rechercher la page de liste ou la passerelle d'API, reportez-vous à Liste des passerelles d'API.
    2. Dans le menu Actions (trois points) de la passerelle d'API, procédez comme suit :
      • Sélectionnez Modifier pour modifier l'une des propriétés de passerelle d'API suivantes :
        • Modifiez le nom de la passerelle d'API. Evitez de saisir des informations confidentielles.
        • Activez ou désactivez l'utilisation de groupes de sécurité réseau pour contrôler l'accès à la passerelle d'API et à partir de celle-ci à l'aide de règles de sécurité définies pour les groupes de sécurité réseau que vous indiquez (cinq groupes de sécurité réseau au maximum). Vous pouvez utiliser les règles de sécurité définies pour les groupes de sécurité réseau plutôt que celles définies pour les listes de sécurité ou en plus. Les groupes de sécurité réseau peuvent appartenir au même compartiment que la passerelle d'API, mais ce n'est pas obligatoire. Reportez-vous à Groupes de sécurité réseau.
        • Modifiez le certificat TLS et le nom de domaine utilisés par la passerelle d'API. Les ressources de certificat API Gateway et les ressources de certificat de service Certificates sont affichées uniquement si elles sont disponibles dans le compartiment sélectionné. Reportez-vous à Configuration de certificats TLS et de domaines personnalisés.
        • Modifier les paramètres de configuration du cache des réponses. Reportez-vous à Réponses de mise en cache pour l'amélioration des performances.
        • Modifiez les packages d'autorité de certification et d'autorité de certification inclus dans le truststore de la passerelle d'API en tant qu'autorités de certification personnalisées et packages d'autorité de certification personnalisés (en plus du package d'autorité de certification par défaut). Reportez-vous à la section Customizing Trust Stores for TLS Certificate Verification.
      • Sélectionnez Déplacer la ressource pour déplacer la passerelle d'API vers un autre compartiment.
      • Sélectionnez l'onglet Balises pour visualiser et modifier les balises appliquées à la passerelle d'API, puis sélectionnez Ajouter des balises pour appliquer d'autres balises à la passerelle d'API.

  • Pour mettre à jour des passerelles d'API existantes à l'aide de l'interface de ligne de commande, procédez comme suit :

    1. Configurez votre environnement client de façon à pouvoir utiliser l'interface de ligne de commande (Configuration de l'environnement client pour utiliser l'interface de ligne de commande pour le développement de passerelle d'API).

    2. Pour mettre à jour une passerelle d'API existante, procédez comme suit :

      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 déterminer l'OCID de la passerelle d'API, reportez-vous à Liste des passerelles d'API.
        • <property-to-update> est la propriété à mettre à jour. Vous pouvez uniquement modifier les valeurs de display-name, --response-cache-details, --network-security-group-ids, --ca-bundles, freeform-tags et defined-tags (et certificate-id> si ce paramètre a été initialement défini pour la passerelle d'API). Toutes les autres valeurs doivent être identiques aux valeurs figurant dans la définition d'origine de la passerelle.
        • <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 inclut les éléments suivants :

        • Etat de cycle de vie (par exemple, ACTIVE, FAILED).
        • ID de la demande de travail utilisée pour mettre à jour la passerelle d'API (les détails des demandes de travail sont disponibles pendant sept jours après leur fin, leur annulation ou leur échec).

        Pour que la commande attende que la passerelle d'API soit active (ou que la demande ait échoué) avant de renvoyer le contrôle, 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 afficher le statut de la demande de travail qui met à jour la passerelle d'API, saisissez ce qui suit :

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

      3. (Facultatif) Pour afficher les journaux de la demande de travail qui met à jour la passerelle d'API, saisissez ce qui suit :

        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 consulter les journaux d'erreurs, saisissez ce qui suit :

        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 assurez-vous que la passerelle d'API présente les propriétés prévues :

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

    Pour plus d'informations sur l'utilisation de l'interface de ligne de commande, reportez-vous à Interface de ligne de commande (CLI). Afin d'obtenir la liste complète des indicateurs et des options disponibles pour les commandes de l'interface de ligne de commande, reportez-vous à Aide relative à l'interface de ligne de commande.

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