Déploiement d'une API sur une passerelle d'API en créant un déploiement d'API
Découvrez comment déployer une API sur une passerelle d'API en créant un déploiement d'API avec le service API Gateway.
Une fois que vous avez créé une passerelle d'API, vous devez déployer une API sur celle-ci en créant un déploiement d'API. Lorsque vous créez un déploiement d'API, vous devez inclure une spécification de déploiement d'API qui définit l'API. Le service API Gateway inspecte la spécification de déploiement d'API pour vérifier sa validité.
Vous pouvez utiliser une seule passerelle d'API comme composant frontal pour plusieurs services back-end en :
- créant un seul déploiement d'API sur la passerelle d'API, avec une spécification de déploiement d'API qui définit plusieurs services back-end,
- créant plusieurs déploiements d'API sur la même passerelle d'API, chacun comportant une spécification de déploiement d'API qui définit des services back-end.
Utilisation de la console pour créer un déploiement d'API entièrement nouveau
Pour utiliser la console afin de créer un déploiement d'API, saisissez la spécification de déploiement d'API dans les boîtes de dialogue de la console comme suit :
- Sur la page de liste Passerelles, sélectionnez la passerelle d'API sur laquelle déployer l'API. Si vous avez besoin d'aide pour rechercher la page de liste ou la passerelle d'API, reportez-vous à Liste des passerelles d'API.
- Sur la page des détails de la passerelle, sélectionnez Services dans la liste Ressources, puis Créer un déploiement.
-
Sélectionnez Entièrement nouveau, puis, dans la section Informations de base, indiquez les éléments suivants :
- Nom : nom du nouveau déploiement d'API. Evitez de saisir des informations confidentielles.
-
Préfixe de chemin : chemin vers lequel déployer tous les routages contenus dans la spécification de déploiement d'API. Par exemple :
/v1
/v2
/test/20191122
Le préfixe de chemin de déploiement que vous indiquez présente les caractéristiques suivantes :
- Il doit être précédé d'une barre oblique (
/
). Il peut également s'agir d'une simple barre oblique. - Il peut contenir plusieurs barres obliques (à condition qu'elles ne soient pas adjacentes), mais il ne doit pas se terminer par une barre oblique.
- Il peut inclure des caractères alphanumériques en majuscules et minuscules.
- Il peut inclure les caractères spéciaux
$ - _ . + ! * ' ( ) , % ; : @ & =
. - Il ne peut pas inclure de paramètres ni de caractères génériques.
Notez également que si un déploiement d'API comporte une barre oblique unique comme préfixe de chemin de déploiement, il s'agit du seul déploiement d'API autorisé sur une passerelle d'API donnée. Vous ne pouvez pas créer un déploiement d'API avec une barre oblique unique comme préfixe de chemin de déploiement s'il existe déjà un autre déploiement d'API sur la même passerelle d'API.
- Compartiment : compartiment dans lequel créer le déploiement d'API.
-
(Facultatif) Dans la section Stratégies de demande d'API, indiquez éventuellement les détails de la stratégie de demande de façon à prendre en charge les fonctionnalités suivantes :
- Mutual-TLS : sélectionnez Activer mTLS et entrez les détails d'une stratégie de demande mTLS (reportez-vous à Ajout de la prise en charge de mTLS aux déploiements d'API).
- Authentification : sélectionnez Ajouter et saisissez les détails d'une stratégie de demande d'authentification (voir Ajout de l'authentification et de l'autorisation aux déploiements d'API).
- CORS : sélectionnez Ajouter et saisissez les détails d'une stratégie de demande CORS (reportez-vous à Ajout de la prise en charge CORS aux déploiements d'API).
- Limitation de débit : sélectionnez Ajouter et saisissez les détails d'une stratégie de demande de limitation de débit (reportez-vous à Limitation du nombre de demandes aux back-ends de passerelle d'API).
-
(Facultatif) Dans la section Stratégies de journalisation d'API, indiquez éventuellement un niveau de journal d'exécution pour enregistrer des informations sur le traitement réalisé au sein de la passerelle d'API. Reportez-vous à Ajout de la journalisation aux déploiements d'API.
-
(Facultatif) Sélectionnez Afficher les options avancées et indiquez éventuellement :
- Balises : si vous disposez des droits d'accès nécessaires pour créer une ressource, vous disposez également de droits d'accès nécessaires pour lui appliquer des balises à format libre. Pour appliquer une balise defined, vous devez disposer des droits d'accès permettant d'utiliser l'espace de noms de balise. Pour plus d'informations sur le balisage, reportez-vous à Balises de ressource. Si vous n'êtes pas certain d'appliquer des balises, ignorez cette option ou demandez à un administrateur. Vous pouvez appliquer des balises ultérieurement.
- Sélectionnez Suivant pour afficher la page Authentification et entrer les détails d'une stratégie de demande d'authentification :
- Aucune authentification : sélectionnez cette option pour accorder un accès non authentifié à tous les routages dans le déploiement d'API.
- Authentification unique : sélectionnez cette option pour acheminer toutes les demandes d'authentification vers un serveur d'authentification unique. Le serveur d'authentification peut être un fournisseur d'identités qui valide les jetons Web JSON (JWT), ou une fonction d'autorisation qui valide les jetons d'accès sans argument ou sans argument. Pour plus d'informations, reportez-vous à :
- Authentification multiple : sélectionnez cette option pour acheminer les demandes d'authentification vers différents serveurs d'authentification, en fonction de la variable de contexte et des règles saisies. Pour plus d'informations, reportez-vous à Ajout de plusieurs serveurs d'authentification au même déploiement d'API.
Pour plus d'informations, reportez-vous à Ajout de l'authentification et de l'autorisation aux déploiements d'API.
- Sélectionnez Suivant pour saisir les détails des routages dans le déploiement d'API.
-
Dans la section Routage 1, spécifiez le premier routage du déploiement d'API qui met en correspondance un chemin et des méthodes avec un service back-end :
-
Chemin : chemin pour les appels d'API utilisant les méthodes répertoriées vers le service back-end. Le chemin d'accès que vous spécifiez doit remplir les conditions suivantes :
- Il est relatif au préfixe de chemin de déploiement.
- Il doit être précédé d'une barre oblique (/). Il peut également consister en une unique barre oblique.
- Il peut contenir plusieurs barres obliques (à condition qu'elles ne soient pas adjacentes), ainsi que se terminer par une barre oblique.
- Il peut inclure des caractères alphanumériques en majuscules et minuscules.
- Il peut inclure les caractères spéciaux
$ - _ . + ! * ' ( ) , % ; : @ & =
. - Il peut inclure des paramètres et des caractères génériques (reportez-vous à Ajout de paramètres de chemin et de caractères génériques aux chemins de routage).
- Méthodes : méthodes acceptées par le service back-end, séparées par des virgules. Par exemple,
GET, PUT
. -
Ajouter un seul back-end : ou Ajouter plusieurs back-ends : indique si toutes les demandes doivent être acheminées vers le même back-end ou si elles doivent l'être vers d'autres back-ends en fonction de la variable de contexte et des règles que vous entrez.
Ces instructions supposent que vous souhaitez utiliser un back-end unique. Sélectionnez donc Ajouter un back-end unique. Si vous souhaitez utiliser des back-ends différents, vous pouvez également sélectionner Ajouter plusieurs back-ends et suivre les instructions fournies dans Utilisation de la console pour ajouter une sélection de back-end dynamique à une spécification de déploiement d'API.
-
Type de back-end : type du service back-end correspondant à l'un des types suivants :
- HTTP : pour un back-end HTTP, vous devez également spécifier une URL et des détails d'expiration. Vous devez aussi indiquer si la vérification SSL doit être désactivée (reportez-vous à Ajout d'une URL HTTP ou HTTPS en tant que back-end de passerelle d'API).
- Oracle Functions : pour un back-end OCI Functions, vous devez également indiquer l'application et la fonction (reportez-vous à Ajout d'une fonction dans OCI Functions en tant que back-end de passerelle d'API).
- Réponse par défaut : pour un back-end de réponse par défaut, vous devez également indiquer le code de statut HTTP, le contenu du corps de la réponse et des champs d'en-tête HTTP (reportez-vous à Ajout de réponses par défaut en tant que back-end de passerelle d'API).
-
- (Facultatif) Sélectionnez Autre routage pour saisir les détails d'autres routages.
- Sélectionnez Suivant afin de vérifier les détails saisis pour le nouveau déploiement d'API.
-
Sélectionnez Créer pour créer le déploiement d'API.
La création du déploiement d'API peut prendre quelques minutes. Pendant sa création, le déploiement d'API présente l'état Création en cours sur la page Détails de la passerelle. Une fois créé, le nouveau déploiement d'API présente l'état Actif.
Notez également que, plutôt que de créer le déploiement d'API immédiatement, vous pouvez le créer ultérieurement à l'aide de Resource Manager et de Terraform, en sélectionnant Enregistrer en tant que pile pour enregistrer la définition de ressource en tant que configuration Terraform. Pour plus d'informations sur l'enregistrement de piles à partir de définitions de ressource, reportez-vous à Création d'une pile à partir d'une page de création de ressource.
-
Si vous avez dépassé le délai d'attente de quelques minutes et que le déploiement d'API ne présente toujours pas l'état Actif (ou si l'opération de création du déploiement d'API a échoué), procédez comme suit :
- Sélectionnez le nom du déploiement d'API, puis sélectionnez Demandes de travail pour afficher un aperçu de l'opération de création du déploiement d'API.
- Sélectionnez l'opération Créer un déploiement pour afficher des informations supplémentaires sur celle-ci (y compris les messages d'erreur, les messages journaux et le statut des ressources associées).
- Si l'opération de création du déploiement d'API a échoué et que vous ne pouvez pas diagnostiquer la cause du problème à partir des informations de la demande de travail, reportez-vous à Dépannage d'API Gateway.
- (Facultatif) Vérifiez que l'API a été déployée en l'appelant (reportez-vous à Appel d'une API déployée sur une passerelle d'API).
Utilisation de la console pour créer un déploiement d'API à partir d'un fichier JSON
Pour utiliser la console afin de créer un déploiement d'API en téléchargeant la spécification de déploiement d'API à partir d'un fichier JSON, procédez comme suit :
- Sur la page de liste Passerelles, sélectionnez la passerelle d'API sur laquelle déployer l'API. Si vous avez besoin d'aide pour rechercher la page de liste ou la passerelle d'API, reportez-vous à Liste des passerelles d'API.
- Sur la page des détails de la passerelle, sélectionnez Services dans la liste Ressources, puis Créer un déploiement.
- Sélectionnez Télécharger une API existante.
-
Dans la section Télécharger les informations, indiquez les éléments suivants :
- Nom : nom du nouveau déploiement d'API. Evitez de saisir des informations confidentielles.
-
Préfixe de chemin : chemin vers lequel déployer tous les routages contenus dans la spécification de déploiement d'API. Par exemple :
/v1
/v2
/test/20191122
Le préfixe de chemin de déploiement que vous indiquez présente les caractéristiques suivantes :
- Il doit être précédé d'une barre oblique (
/
). Il peut également s'agir d'une simple barre oblique. - Il peut contenir plusieurs barres obliques (à condition qu'elles ne soient pas adjacentes), mais il ne doit pas se terminer par une barre oblique.
- Il peut inclure des caractères alphanumériques en majuscules et minuscules.
- Il peut inclure les caractères spéciaux
$ - _ . + ! * ' ( ) , % ; : @ & =
. - Il ne peut pas inclure de paramètres ni de caractères génériques.
- Compartiment : compartiment dans lequel créer le déploiement d'API.
- Spécification : fichier JSON contenant la spécification de déploiement d'API. Faites-le glisser ou sélectionnez-en un. Reportez-vous à Création d'une spécification de déploiement d'API.
Notez également que si un déploiement d'API comporte une barre oblique unique comme préfixe de chemin de déploiement, il s'agit du seul déploiement d'API autorisé sur une passerelle d'API donnée. Vous ne pouvez pas créer un déploiement d'API avec une barre oblique unique comme préfixe de chemin de déploiement s'il existe déjà un autre déploiement d'API sur la même passerelle d'API.
-
(Facultatif) Sélectionnez Afficher les options avancées et indiquez éventuellement :
- Balises : si vous disposez des droits d'accès nécessaires pour créer une ressource, vous disposez également de droits d'accès nécessaires pour lui appliquer des balises à format libre. Pour appliquer une balise defined, vous devez disposer des droits d'accès permettant d'utiliser l'espace de noms de balise. Pour plus d'informations sur le balisage, reportez-vous à Balises de ressource. Si vous n'êtes pas certain d'appliquer des balises, ignorez cette option ou demandez à un administrateur. Vous pouvez appliquer des balises ultérieurement.
- Sélectionnez Suivant afin de vérifier les détails saisis pour le nouveau déploiement d'API.
-
Sélectionnez Créer pour créer le déploiement d'API.
La création du déploiement d'API peut prendre quelques minutes. Pendant sa création, le déploiement d'API présente l'état Création en cours sur la page Détails de la passerelle. Une fois créé, le nouveau déploiement d'API présente l'état Actif.
Notez également que, plutôt que de créer le déploiement d'API immédiatement, vous pouvez le créer ultérieurement à l'aide de Resource Manager et de Terraform, en sélectionnant Enregistrer en tant que pile pour enregistrer la définition de ressource en tant que configuration Terraform. Pour plus d'informations sur l'enregistrement de piles à partir de définitions de ressource, reportez-vous à Création d'une pile à partir d'une page de création de ressource.
-
Si vous avez dépassé le délai d'attente de quelques minutes et que le déploiement d'API ne présente toujours pas l'état Actif (ou si l'opération de création du déploiement d'API a échoué), procédez comme suit :
- Sélectionnez le nom du déploiement d'API, puis sélectionnez Demandes de travail pour afficher un aperçu de l'opération de création du déploiement d'API.
- Sélectionnez l'opération Créer un déploiement pour afficher des informations supplémentaires sur celle-ci (y compris les messages d'erreur, les messages journaux et le statut des ressources associées).
- Si l'opération de création du déploiement d'API a échoué et que vous ne pouvez pas diagnostiquer la cause du problème à partir des informations de la demande de travail, reportez-vous à Dépannage d'API Gateway.
- (Facultatif) Vérifiez que l'API a été déployée en l'appelant (reportez-vous à Appel d'une API déployée sur une passerelle d'API).
Utilisation de la console pour créer un déploiement d'API à partir d'une ressource d'API
Vous pouvez créer un déploiement d'API à partir d'une ressource d'API existante en utilisant la description d'API de la ressource. Dans ce cas, la description d'API repose sur un fichier de description d'API que vous avez téléchargé vers le serveur pour la ressource d'API (reportez-vous à Création d'une ressource d'API avec une description d'API). Le fichier de description d'API fournit certaines valeurs initiales pour la spécification de déploiement d'API, que vous pouvez modifier et étendre lors de la création du déploiement d'API. En particulier, un routage par défaut est créé pour chaque chemin et méthode associée dans la description d'API.
Afin d'utiliser la console pour créer un déploiement d'API à partir d'une ressource d'API existante en utilisant une spécification de déploiement d'API dérivée d'un fichier de description d'API, procédez comme suit :
- Sur la page de liste Indicateurs, sélectionnez le nom de la ressource d'API à déployer. Si vous avez besoin d'aide pour trouver la page de liste, reportez-vous à Liste des ressources d'API.
- (Facultatif) Sur la page Détails d'API, sélectionnez Spécification du déploiement d'API dans la liste Ressources afin de vérifier qu'une spécification de déploiement d'API valide a été créée pour la ressource d'API à partir d'un fichier de description d'API téléchargé vers le serveur. Si aucune spécification de déploiement d'API n'est disponible, reportez-vous à Création d'une ressource d'API avec une description d'API
- Sur la page Détails d'API, sélectionnez Déployer la passerelle d'API afin d'utiliser les boîtes de dialogue de la console pour créer un déploiement d'API.
Certaines valeurs initiales des propriétés de spécification de déploiement d'API affichées dans les boîtes de dialogue de la console sont dérivées du fichier de description d'API.
La section Informations sur l'API affiche les détails relatifs à la ressource d'API à partir de laquelle créer le déploiement d'API.
- Dans la section Passerelle, sélectionnez la passerelle d'API sur laquelle créer le déploiement d'API. S'il n'existe aucune passerelle d'API appropriée, sélectionnez Créer une passerelle pour en créer une (reportez-vous à Création d'une passerelle d'API).
-
Dans la section Informations de base, indiquez les éléments suivants :
- Nom : nom du nouveau déploiement d'API. Evitez de saisir des informations confidentielles.
-
Préfixe de chemin : chemin vers lequel déployer tous les routages contenus dans la spécification de déploiement d'API.
Par exemple :
/v1
/v2
/test/20191122
Le préfixe de chemin de déploiement que vous indiquez présente les caractéristiques suivantes :
- Il doit être précédé d'une barre oblique (
/
). Il peut également s'agir d'une simple barre oblique. - Il peut contenir plusieurs barres obliques (à condition qu'elles ne soient pas adjacentes), mais il ne doit pas se terminer par une barre oblique.
- Il peut inclure des caractères alphanumériques en majuscules et minuscules.
- Il peut inclure les caractères spéciaux
$ - _ . + ! * ' ( ) , % ; : @ & =
. - Il ne peut pas inclure de paramètres ni de caractères génériques.
Notez également que si un déploiement d'API comporte une barre oblique unique comme préfixe de chemin de déploiement, il s'agit du seul déploiement d'API autorisé sur une passerelle d'API donnée. Vous ne pouvez pas créer un déploiement d'API avec une barre oblique unique comme préfixe de chemin de déploiement s'il existe déjà un autre déploiement d'API sur la même passerelle d'API.
- Compartiment : compartiment dans lequel créer le déploiement d'API.
-
(Facultatif) Dans la section Stratégies de demande d'API, indiquez éventuellement les détails de la stratégie de demande de façon à prendre en charge les fonctionnalités suivantes :
- Mutual-TLS : sélectionnez Activer mTLS et entrez les détails d'une stratégie de demande mTLS (reportez-vous à Ajout de la prise en charge de mTLS aux déploiements d'API).
- Authentification : sélectionnez Ajouter et saisissez les détails d'une stratégie de demande d'authentification (voir Ajout de l'authentification et de l'autorisation aux déploiements d'API).
- CORS : sélectionnez Ajouter et saisissez les détails d'une stratégie de demande CORS (reportez-vous à Ajout de la prise en charge CORS aux déploiements d'API).
- Limitation de débit : sélectionnez Ajouter et saisissez les détails d'une stratégie de demande de limitation de débit (reportez-vous à Limitation du nombre de demandes aux back-ends de passerelle d'API).
-
(Facultatif) Dans la section Stratégies de journalisation d'API, indiquez éventuellement un niveau de journal d'exécution pour enregistrer des informations sur le traitement réalisé au sein de la passerelle d'API. Reportez-vous à Ajout de la journalisation aux déploiements d'API.
-
(Facultatif) Sélectionnez Afficher les options avancées et indiquez éventuellement :
- Balises : si vous disposez des droits d'accès nécessaires pour créer une ressource, vous disposez également de droits d'accès nécessaires pour lui appliquer des balises à format libre. Pour appliquer une balise defined, vous devez disposer des droits d'accès permettant d'utiliser l'espace de noms de balise. Pour plus d'informations sur le balisage, reportez-vous à Balises de ressource. Si vous n'êtes pas certain d'appliquer des balises, ignorez cette option ou demandez à un administrateur. Vous pouvez appliquer des balises ultérieurement.
-
Sélectionnez Suivant pour vérifier et saisir les détails des routages dans le déploiement d'API.
Par défaut, un routage est créé pour chaque chemin et méthode associée présents dans la description d'API. Initialement, chacun de ces routages par défaut est créé avec un back-end de réponse par défaut. Le code de statut HTTP, le contenu du corps de réponse et l'en-tête sont obtenus à partir des détails de la description d'API. Si la description d'API n'inclut pas d'informations de réponse pour un chemin particulier et sa méthode associée, un back-end de réponse par défaut est créé pour ce routage avec 501 comme code de statut HTTP.
-
Vérifiez chaque routage par défaut, en modifiant la configuration si nécessaire pour répondre à vos besoins, et en ajoutant des stratégies de demande, de réponse et de journalisation :
-
Chemin : chemin pour les appels d'API utilisant les méthodes répertoriées vers le service back-end. Le chemin d'accès que vous spécifiez doit remplir les conditions suivantes :
- Il est relatif au préfixe de chemin de déploiement.
- Il doit être précédé d'une barre oblique (/). Il peut également consister en une unique barre oblique.
- Il peut contenir plusieurs barres obliques (à condition qu'elles ne soient pas adjacentes), ainsi que se terminer par une barre oblique.
- Il peut inclure des caractères alphanumériques en majuscules et minuscules.
- Il peut inclure les caractères spéciaux
$ - _ . + ! * ' ( ) , % ; : @ & =
. - Il peut inclure des paramètres et des caractères génériques (reportez-vous à Ajout de paramètres de chemin et de caractères génériques aux chemins de routage).
- Méthodes : méthodes acceptées par le service back-end, séparées par des virgules. Par exemple,
GET, PUT
. - Type : type du service back-end prenant l'une des valeurs suivantes :
- HTTP : pour un back-end HTTP, vous devez également spécifier une URL et des détails d'expiration. Vous devez aussi indiquer si la vérification SSL doit être désactivée (reportez-vous à Ajout d'une URL HTTP ou HTTPS en tant que back-end de passerelle d'API).
- Oracle Functions : pour un back-end OCI Functions, vous devez également indiquer l'application et la fonction (reportez-vous à Ajout d'une fonction dans OCI Functions en tant que back-end de passerelle d'API).
- Réponse par défaut : pour un back-end de réponse par défaut, vous devez également indiquer le code de statut HTTP, le contenu du corps de la réponse et des champs d'en-tête HTTP (reportez-vous à Ajout de réponses par défaut en tant que back-end de passerelle d'API).
- Afficher les stratégies de demande de routage et Afficher les stratégies de réponse de routage : vérifiez et éventuellement mettez à jour les stratégies de demande et de réponse qui s'appliquent au routage. Reportez-vous à Ajout de stratégies de demande et de réponse aux spécifications de déploiement d'API.
- Afficher les stratégies de journalisation de routage : vérifiez et éventuellement mettez à jour la stratégie de journalisation applicable au routage. Reportez-vous à Ajout de la journalisation aux déploiements d'API.
-
- (Facultatif) Sélectionnez Autre routage pour entrer les détails d'autres routages, en plus de ceux créés par défaut à partir de la description d'API.
- Sélectionnez Suivant afin de vérifier les détails saisis pour le nouveau déploiement d'API.
-
Sélectionnez Créer pour créer le déploiement d'API.
La création du déploiement d'API peut prendre quelques minutes. Pendant sa création, le déploiement d'API présente l'état Création en cours sur la page Détails de la passerelle. Une fois créé, le nouveau déploiement d'API présente l'état Actif.
-
Si vous avez dépassé le délai d'attente de quelques minutes et que le déploiement d'API ne présente toujours pas l'état Actif (ou si l'opération de création du déploiement d'API a échoué), procédez comme suit :
- Sélectionnez le nom du déploiement d'API, puis sélectionnez Demandes de travail pour afficher un aperçu de l'opération de création du déploiement d'API.
- Sélectionnez l'opération Créer un déploiement pour afficher des informations supplémentaires sur celle-ci (y compris les messages d'erreur, les messages journaux et le statut des ressources associées).
- Si l'opération de création du déploiement d'API a échoué et que vous ne pouvez pas diagnostiquer la cause du problème à partir des informations de la demande de travail, reportez-vous à Dépannage d'API Gateway.
- (Facultatif) Vérifiez que l'API a été déployée en l'appelant (reportez-vous à Appel d'une API déployée sur une passerelle d'API).
Utilisation de l'interface de ligne de commande
Pour créer un déploiement d'API à l'aide de l'interface de ligne de commande, procédez comme suit :
- 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).
-
Ouvrez une invite de commande et exécutez
oci api-gateway deployment create
pour créer le déploiement :oci api-gateway deployment create --compartment-id <compartment-ocid> --display-name <api-name> --gateway-id <gateway-ocid> --path-prefix "/<deployment-path-prefix>" --specification file:///<filename>
où :
<compartment-ocid>
est l'OCID du compartiment dans lequel créer le déploiement d'API.<api-name>
est le nom du nouveau déploiement d'API. Evitez de saisir des informations confidentielles.<gateway-ocid>
est l'OCID de la passerelle existante vers laquelle déployer l'API. Pour déterminer l'OCID de la passerelle d'API, reportez-vous à Liste des passerelles d'API.-
/<deployment-path-prefix>
est un chemin vers lequel déployer tous les routages contenus dans la spécification de déploiement d'API.Le préfixe de chemin de déploiement que vous indiquez présente les caractéristiques suivantes :
- Il doit être précédé d'une barre oblique (
/
) dans le fichier JSON. Il peut s'agir d'une seule et même barre oblique. - Il peut contenir plusieurs barres obliques (à condition qu'elles ne soient pas adjacentes), mais il ne doit pas se terminer par une barre oblique.
- Il peut inclure des caractères alphanumériques en majuscules et minuscules.
- Il peut inclure les caractères spéciaux
$ - _ . + ! * ' ( ) , % ; : @ & =
. - Il ne peut pas inclure de paramètres ni de caractères génériques.
Notez également que si un déploiement d'API comporte une barre oblique unique comme préfixe de chemin de déploiement, il s'agit du seul déploiement d'API autorisé sur une passerelle d'API donnée. Vous ne pouvez pas créer un déploiement d'API avec une barre oblique unique comme préfixe de chemin de déploiement s'il existe déjà un autre déploiement d'API sur la même passerelle d'API.
- Il doit être précédé d'une barre oblique (
<filename>
est la spécification de déploiement d'API, qui inclut le chemin, les méthodes et une définition de back-end. Reportez-vous à Création d'une spécification de déploiement d'API.
Par exemple :
oci api-gateway deployment create --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --display-name "Marketing Deployment" --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --path-prefix "/marketing" --specification file:///Users/jdoe/work/deployment.json
La réponse à la commande inclut les éléments suivants :
- OCID du déploiement d'API.
-
Nom de l'hôte sur lequel le déploiement d'API a été créé, sous la forme d'un nom de domaine au format
<gateway-identifier>.apigateway.<region-identifier>.oci.customer-oci.com
, où :<gateway-identifier>
est la chaîne de caractères qui identifie la passerelle d'API. Par exemple,lak...sjd
(abrégé pour des raisons de lisibilité).<region-identifier>
est l'identificateur de la région dans laquelle le déploiement d'API a été créé. Reportez-vous à Disponibilité par région.
Par exemple,
lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com
.Le nom d'hôte sera le nom du domaine à utiliser lors de l'appel d'une API déployée sur la passerelle d'API.
- Etat de cycle de vie (par exemple, ACTIVE, FAILED).
- ID de la demande de travail utilisée pour créer le déploiement 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 le déploiement d'API soit actif (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 deployment create --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --display-name "Marketing Deployment" --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --path-prefix "/marketing" --specification file:///Users/jdoe/work/deployment.json --wait-for-state ACTIVE
Vous ne pouvez pas utiliser le déploiement d'API tant qu'il n'a pas été créé par la demande de travail et qu'il n'est pas actif.
-
(Facultatif) Pour afficher le statut du déploiement d'API, saisissez la commande suivante :
oci api-gateway deployment get --deployment-id <deployment-ocid>
-
(Facultatif) Pour afficher le statut de la demande de travail qui crée le déploiement d'API, saisissez ce qui suit :
oci api-gateway work-request get --work-request-id <work-request-ocid>
-
(Facultatif) Pour afficher les journaux de la demande de travail qui crée le déploiement d'API, saisissez ce qui suit :
oci api-gateway work-request-log list --work-request-id <work-request-ocid>
-
(Facultatif) Si la demande de travail qui crée le déploiement 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>
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.
Utilisation de l'API
Pour plus d'informations sur l'utilisation de l'API et la signature des demandes, reportez-vous à la documentation relative à l'API REST et à Informations d'identification de sécurité. Pour plus d'informations sur les kits SDK, reportez-vous à Kits SDK et interface de ligne de commande.
Utilisez l'opération CreateDeployment pour créer un déploiement d'API.