Associez votre nom de domaine HTTPS à un groupe d'API dans API Gateway et téléchargez un certificat SSL pour ce domaine. Vous pouvez ensuite appeler les API du groupe via le nom de domaine HTTPS.
Remarques sur l'utilisation
Les noms de domaine indépendants que vous souhaitez associer aux groupes d'API doivent répondre aux exigences suivantes :
Si vous souhaitez associer un nom de domaine indépendant à un groupe d'API dans une région située en Chine continentale, vous devez demander un numéro ICP pour le domaine dans le système de dépôt ICP d'Alibaba Cloud, ou ajouter Alibaba Cloud en tant que fournisseur de services aux informations de dépôt ICP (Internet Content Provider) du domaine.
Avant d'associer un nom de domaine indépendant à un groupe d'API, ajoutez un enregistrement CNAME pour mapper le nom de domaine indépendant au nom de domaine de second niveau du groupe d'API.
Le nom de domaine indépendant que vous souhaitez associer ne doit pas déjà être lié à un groupe d'API hébergé sur API Gateway par d'autres utilisateurs. Si le nom de domaine indépendant a été associé par d'autres utilisateurs, une vérification est requise lors de la tentative d'association. Si vous devez appeler les API du groupe d'API via HTTPS, importez ou téléchargez un certificat SSL pour le nom de domaine indépendant.
Par défaut, API Gateway fournit un nom de domaine public de second niveau pour chaque groupe d'API. Lorsqu'un client utilise le nom de domaine public de second niveau pour initier des appels d'API, le nombre d'appels d'API quotidiens est limité. La limite est de 100 appels d'API dans la région Chine (Hong Kong) et les régions hors de Chine continentale, et de 1 000 appels d'API dans les régions situées en Chine continentale. Si vous souhaitez publier des API dans un environnement de production, vous devez associer un nom de domaine indépendant au groupe d'API auquel les API appartiennent. Le nombre d'appels d'API n'est pas limité pour les noms de domaine indépendants.
Procédure
Suivez les étapes ci-dessous pour associer un nom de domaine HTTPS à un groupe d'API et télécharger un certificat SSL.
-
Résolution de nom de domaine : ajoutez un enregistrement CNAME ou TXT pour mapper votre nom de domaine indépendant public ou interne au nom de domaine de second niveau public ou interne fourni par le groupe d'API. Pour plus d'informations, consultez la section Résolution de nom de domaine.
Résolution de nom de domaine public : utilisez Alibaba Cloud DNS (DNS) pour mapper votre nom de domaine public au nom de domaine de second niveau public fourni par API Gateway pour le groupe d'API. Pour plus d'informations, consultez la section Résolution de nom de domaine public.
Résolution de nom de domaine interne : utilisez Alibaba Cloud DNS pour mapper votre nom de domaine interne au nom de domaine de second niveau interne fourni par API Gateway pour le groupe d'API. Pour plus d'informations, consultez la section Résolution de nom de domaine interne.
Association de nom de domaine : sur la page Group Details de la console API Gateway, associez votre nom de domaine indépendant au groupe d'API. Pour plus d'informations, consultez la section Association de nom de domaine.
Téléchargement d'un certificat SSL : configurez un certificat SSL pour le nom de domaine afin de pouvoir utiliser ce domaine pour appeler des API via HTTPS. Pour plus d'informations, consultez la section Télécharger un certificat SSL.
Résolution de nom de domaine
Résolution de nom de domaine public
Connectez-vous à la console API Gateway. Dans le volet de navigation de gauche, choisissez Manage APIs > API Groups et sélectionnez une région.
Sur la page API Groups, cliquez sur le groupe d'API cible. Dans la section Basic Information, recherchez le nom de domaine public de second niveau.
Connectez-vous à la console DNS. Choisissez Public DNS > Authoritative DNS Resolution. Cliquez sur l'onglet Authoritative Domain Names, puis cliquez sur le nom de domaine pour ouvrir l'onglet DNS Settings.
Sur l'onglet DNS Settings, cliquez sur Add DNS Record. Définissez Record Type sur CNAME, Hostname sur le préfixe du nom de domaine, et Record Value sur le nom de domaine public de second niveau. Cliquez sur OK.
Résolution de nom de domaine interne
Connectez-vous à la console API Gateway. Dans le volet de navigation de gauche, choisissez Manage APIs > API Groups et sélectionnez une région.
Sur la page API Groups, cliquez sur le groupe d'API cible. Dans la section Basic Information, recherchez le nom de domaine VPC interne.
Connectez-vous à la console DNS. Cliquez sur Private DNS (PrivateZone). Dans le coin supérieur droit de la page Private DNS (PrivateZone), cliquez sur Configuration Mode. Sur l'onglet User Defined Zones, cliquez sur Add New Zone.
-
Dans le panneau Add Built-in Authoritative Zone, spécifiez Built-in Authoritative Zone et Alibaba Cloud VPC, puis cliquez sur OK.
Pour Domain Type, sélectionnez Built-in Authoritative Acceleration Zone. Cette option est recommandée pour obtenir la latence de résolution la plus faible.
RemarquePour Built-in Authoritative Zone, saisissez le nom de domaine personnalisé (interne) associé au groupe d'API. Ce nom de domaine est utilisé uniquement pour private DNS (PrivateZone) dans les VPC.
Cliquez sur le nom de la zone pour ouvrir l'onglet Resource Records Settings. Cliquez sur Add Record. Dans le panneau Add Record, définissez Record Type sur CNAME, Hostname sur le préfixe du nom de domaine, et Record Value sur le nom de domaine VPC interne. Cliquez sur OK.
Sur l'instance Elastic Compute Service (ECS) déployée dans le VPC associé à la zone privée, l'enregistrement de la zone privée remplace l'enregistrement DNS public.
Dans les VPC, l'enregistrement DNS public de la zone privée n'est pas affecté. Ajoutez des enregistrements DNS pour vos zones privées afin d'éviter que les zones privées dont les enregistrements DNS sont vides n'écrasent l'enregistrement DNS public. Sinon, des erreurs de résolution DNS se produisent. Pour plus d'informations, consultez la rubrique Activer Alibaba Cloud DNS PrivateZone.
Association de nom de domaine
Connectez-vous à la console API Gateway. Dans le volet de navigation de gauche, choisissez Manage APIs > API Groups et sélectionnez une région.
Sur la page API Groups, cliquez sur le groupe d'API à associer au nom de domaine pour accéder à la page Group Details. Dans la section Independent Domains, cliquez sur Bind Domain Name.
-
Dans la boîte de dialogue Bind Domain Name, configurez les paramètres suivants et cliquez sur Confirm.
Paramètre
Description
Nom de domaine
Saisissez le nom de domaine à associer au groupe d'API.
Environnement
L'environnement associé au nom de domaine. Valeurs possibles :
-
Test : vous pouvez uniquement appeler les API de l'environnement de test.
-
Pre : vous pouvez uniquement appeler les API de l'environnement de préproduction.
-
Production : vous pouvez uniquement appeler les API de l'environnement de production.
-
Default (X-Ca-Stage) : vous pouvez appeler toutes les API des environnements mentionnés ci-dessus. Lorsque vous appelez une API, ajoutez le paramètre X-Ca-Stage à l'en-tête de votre requête pour spécifier l'environnement dans lequel vous souhaitez appeler l'API.
Type de réseau
Internet : vous pouvez uniquement appeler des API via Internet. Internal Network : vous pouvez uniquement appeler des API via les réseaux internes.
-
Vous n'avez pas besoin de vérifier la propriété d'un nom de domaine interne. Si le nom de domaine entre en conflit avec un nom de domaine associé à un autre groupe d'API appartenant à la même instance que le groupe d'API actuel, l'association du nom de domaine actuel au groupe d'API échoue.
Une fois le nom de domaine associé au groupe d'API, vous ne pouvez pas modifier le type de réseau du nom de domaine. Si la configuration est incorrecte, supprimez le nom de domaine et associez-le à nouveau au groupe d'API.
FAQ sur l'association de nom de domaine
Pourquoi l'association de nom de domaine échoue-t-elle ?
Le nom de domaine est déjà associé à un autre groupe d'API sur la même instance, ou un nom de domaine générique entre en conflit avec un nom de domaine unique. Dissociez d'abord le nom de domaine conflictuel.
Le nom de domaine est associé à un groupe d'API appartenant à un autre utilisateur, ou un conflit de nom de domaine générique existe. Effectuez la vérification de la propriété du nom de domaine avant l'association.
Télécharger un certificat SSL
Après avoir associé un nom de domaine à un groupe d'API, vous pouvez appeler des API via HTTP par défaut. Pour appeler des API via HTTPS, téléchargez un certificat SSL pour le nom de domaine. API Gateway prend en charge deux méthodes : l'importation automatique depuis Alibaba Cloud Certificate Management Service et le téléchargement manuel d'un certificat provenant d'un autre fournisseur.
Générer un certificat SSL
Pour générer un certificat SSL gratuit via Alibaba Cloud Certificate Management Service :
Connectez-vous à la console Alibaba Cloud SSL Certificates.
Sur la page d'achat de certificat, achetez le certificat et associez-le au nom de domaine. Pour plus d'informations, consultez la rubrique Prise en main du service SSL Certificates. Après avoir demandé un certificat SSL, accédez à la page Group Details du groupe d'API dans la console API Gateway.
Importer ou télécharger un certificat SSL
Après avoir obtenu un certificat SSL, importez-le ou téléchargez-le pour le nom de domaine associé au groupe d'API.
Importer un certificat SSL
Si vous avez acheté un certificat via Alibaba Cloud Certificate Management Service, importez-le pour le nom de domaine associé :
Connectez-vous à la console API Gateway. Dans le volet de navigation de gauche, choisissez Manage APIs > API Groups et sélectionnez une région.
Sur la page API Groups, cliquez sur le groupe d'API souhaité pour accéder à la page Group Details. Dans la section Independent Domains, vous pouvez afficher les noms de domaine associés au groupe d'API. Recherchez le nom de domaine pour lequel vous souhaitez importer le certificat SSL et cliquez sur Select Certificate dans la colonne SSL Certificate.
Dans la boîte de dialogue Select Certificate, cliquez sur Search for Certificate. Ensuite, sélectionnez le certificat requis dans les résultats de recherche et cliquez sur Synchronize Certificate.
Télécharger un certificat SSL
Si votre certificat SSL provient d'un fournisseur tiers, téléchargez-le sur API Gateway :
Connectez-vous à la console API Gateway. Dans le volet de navigation de gauche, choisissez Manage APIs > API Groups et sélectionnez une région.
Sur la page API Groups, cliquez sur le groupe d'API souhaité pour accéder à la page Group Details. Dans la section Independent Domains, vous pouvez afficher les noms de domaine associés au groupe d'API. Recherchez le nom de domaine pour lequel vous souhaitez importer le certificat SSL et cliquez sur Select Certificate dans la colonne SSL Certificate.
Dans la boîte de dialogue Select Certificate, cliquez sur Add Certificate.
Dans la boîte de dialogue Create Certificate, saisissez et téléchargez le contenu du certificat comme indiqué, puis cliquez sur Confirm.
Une fois le certificat téléchargé, accédez à la page Group Details. Vous constatez que le lien Select Certificate du nom de domaine dans la section Independent Domains est remplacé par Update Certificate. Une fois le certificat téléchargé, vous pouvez utiliser le nom de domaine pour appeler des API via HTTPS.