Documentation Oracle Cloud Infrastructure

Déplacement d'une passerelle d'API entre des compartiments

Découvrez comment déplacer des passerelles d'API entre des compartiments avec le service API Gateway.

Après avoir créé une passerelle d'API, vous pouvez décider de la déplacer d'un compartiment vers un autre. Une passerelle d'API et les déploiements d'API qui y sont déployés peuvent se trouver dans des compartiments distincts.

Les appels adressant à un déploiement d'API seront interrompus pendant le déplacement de la passerelle d'API sur laquelle il est déployé vers un autre compartiment. N'appelez pas de déploiement d'API avant la fin de l'opération de déplacement.

    1. Sur la page de liste Passerelles, recherchez la passerelle d'API à déplacer. 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, sélectionnez Déplacer une ressource, sélectionnez le compartiment vers lequel déplacer la passerelle d'API, puis Déplacer une ressource pour lancer le processus de déplacement de la passerelle d'API. Les déploiements d'API sur la passerelle d'API ne sont pas déplacés vers le nouveau compartiment.

      N'appelez pas les déploiements d'API lorsque la passerelle sur laquelle ils sont déployés est en cours de déplacement vers le nouveau compartiment.

    3. Sur la page des détails de la passerelle, sélectionnez Demandes de travail dans la liste Ressources et vérifiez que l'opération de déplacement est terminée.

      Une fois l'opération de déplacement terminée, reprenez les appels vers les déploiements d'API déployés sur la passerelle d'API.

  • Pour déplacer des passerelles d'API vers un autre compartiment à 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 déplacer une passerelle d'API vers un autre compartiment, procédez comme suit :

      1. Ouvrez une invite de commande et exécutez oci api-gateway gateway change-compartment pour déplacer la passerelle d'API :

        oci api-gateway gateway change-compartment --gateway-id <gateway-ocid> --compartment-id <compartment-ocid>

        où :

        • <gateway-ocid> est l'OCID de la passerelle d'API à déplacer. Pour déterminer l'OCID de la passerelle d'API, reportez-vous à Liste des passerelles d'API.
        • <compartment-ocid> est l'OCID du compartiment vers lequel déplacer la passerelle d'API.

        Par exemple :

        oci api-gateway gateway change-compartment --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq

        Les déploiements d'API sur la passerelle d'API ne sont pas déplacés.

        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 déplacer 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 change-compartment --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq" --wait-for-state ACTIVE

      2. (Facultatif) Pour afficher le statut de la demande de travail qui déplace 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 déplace 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 déplace 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é déplacée, entrez la commande suivante et assurez-vous que la passerelle d'API présente l'OCID du nouveau compartiment prévu :

        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 ChangeGatewayCompartment pour déplacer une passerelle d'API vers un autre compartiment.