AttachGatewayDomain - - Centre de documentation Alibaba Cloud

Description de l'opération

Avant d'associer un nom de domaine personnalisé à une passerelle dédiée, activez l'accès au réseau interne (EnableIntranet) ou l'accès au réseau public (EnableInternet) en appelant UpdateGateway. Pour activer l'accès au réseau interne, déterminez d'abord les VpcId et VSwitchIds. Interrogez les ressources existantes en appelant successivement ListGateway, DescribeGateway, DescribeVpcs et DescribeVSwitches. Si nécessaire, appelez CreateVSwitch pour créer un vSwitch, puis appelez UpdateGateway pour finaliser la configuration réseau.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

eas:AttachGatewayDomain

update

*Toutes les ressources.

*

Aucune

Syntaxe de la requête

PUT /api/v2/gateways/{ClusterId}/{GatewayId}/domain/attach HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
ClusterId	string	Oui	La région où se trouve la passerelle dédiée.	cn-shanghai
GatewayId	string	Oui	L'identifiant de la passerelle dédiée. Pour obtenir l'identifiant de la passerelle dédiée, reportez-vous au champ GatewayId dans la réponse de l'opération ListGateway.	gw-1uhcqmsc7x22******

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
CustomDomain	object	Oui	Les informations relatives au nom de domaine personnalisé.
Type	string	Oui	Le type de nom de domaine. Valeurs valides : intranet : Nom de domaine interne. internet : Nom de domaine public.	intranet
CertificateId	string	Non	L'identifiant du certificat SSL associé au nom de domaine. Obtenez l'identifiant du certificat après avoir importé ou acheté un certificat dans le Certificate Management Service.	1473**25
Domain	string	Oui	Le nom de domaine personnalisé.	test.com

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse.
RequestId	string	L'identifiant de la requête.	40325405-579C-4D82****
GatewayId	string	L'identifiant de la passerelle dédiée. Pour obtenir l'identifiant de la passerelle dédiée, reportez-vous au champ GatewayId dans la réponse de l'opération ListGateway.	gw-1uhcqmsc7x22******
Message	string	Le message de réponse.	Mise à jour réussie du point de terminaison personnalisé pour la passerelle gw-1uhcqmsc7x22******

Exemples

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "GatewayId": "gw-1uhcqmsc7x22******",
  "Message": "Mise à jour réussie du point de terminaison personnalisé pour la passerelle gw-1uhcqmsc7x22******"
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.