CreateVpcEndpointService - - Centre de documentation Alibaba Cloud

Appelle l'opération CreateVpcEndpointService pour créer un service de point de terminaison.

Description de l'opération

Avant de créer un service de point de terminaison, assurez-vous d'avoir créé une ressource d'équilibrage de charge qui prend en charge PrivateLink. Pour plus d'informations, consultez Créer une instance d'équilibreur de charge.
CreateVpcEndpointService est une opération asynchrone. Après l'envoi d'une requête, le système renvoie un identifiant d'instance pendant que le service de point de terminaison est créé en tant que nœud d'arrière-plan. Vous pouvez appeler GetVpcEndpointServiceAttribute pour interroger l'état de création du service de point de terminaison :
- Si le service de point de terminaison est dans l'état Creating, le service de point de terminaison est en cours de création.
- Si le service de point de terminaison est dans l'état Active, le service de point de terminaison est créé.

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.

privatelink:CreateVpcEndpointService

create

*VpcEndpointService.

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/*

LoadBalancer.

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

LoadBalancer.

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

NatGateway.

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

LoadBalancer.

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région du service de point de terminaison. Vous pouvez appeler DescribeRegions pour obtenir la liste des régions la plus récente.	cn-huhehaote
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer qu'il est unique pour chaque requête. Le jeton ne peut contenir que des caractères ASCII.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	Non	Indique si un test à blanc uniquement doit être effectué, sans exécuter la requête réelle. Valeurs valides : true : effectue uniquement un test à blanc. Le système vérifie si la requête présente des problèmes potentiels, notamment des valeurs de paramètre manquantes, une syntaxe de requête incorrecte et des limites de service. Si la requête échoue au test à blanc, un code d'erreur est renvoyé. Si la requête réussit le test à blanc, le code d'erreur DryRunOperation est renvoyé. false (par défaut) : effectue un test à blanc et exécute la requête réelle. Si la requête réussit le test à blanc, un code d'état HTTP 2xx est renvoyé et l'opération est exécutée.	false
ServiceDescription	string	Non	La description du service de point de terminaison.	This is my EndpointService.
AutoAcceptEnabled	boolean	Non	Indique si les connexions de point de terminaison doivent être acceptées automatiquement. Valeurs valides : true : accepte automatiquement les connexions de point de terminaison. false (par défaut) : n'accepte pas automatiquement les connexions de point de terminaison.	false
Payer	string	Non	Le payeur. Valeurs valides : Endpoint : consommateur du service. EndpointService : fournisseur du service.	Endpoint
ZoneAffinityEnabled	boolean	Non	Indique si l'affinité de zone doit être prise en charge pour le nom de domaine de point de terminaison du service de point de terminaison. Valeurs valides : true : pris en charge. false (par défaut) : non pris en charge.	false
ServiceResourceType	string	Non	Le type de ressource EPS. Valeurs valides : slb : Classic Load Balancer (CLB). alb : Application Load Balancer (ALB). nlb : Network Load Balancer (NLB). gwlb : Gateway Load Balancer (GWLB). Remarque Les écouteurs TCPSSL de NLB ne sont pas pris en charge pour l'accès.	slb
Resource	array<object>	Non	Les ressources de service du service de point de terminaison. Vous pouvez ajouter jusqu'à 10 ressources lors de la création. Après la création, vous pouvez ajouter d'autres ressources au service de point de terminaison.
	object	Non	Les ressources de service du service de point de terminaison.
ResourceType	string	Non	Le type de ressource EPS à ajouter au service de point de terminaison. Vous pouvez ajouter jusqu'à 20 ressources de service à un service de point de terminaison. Valeurs valides : slb : Classic Load Balancer (CLB). alb : Application Load Balancer (ALB). nlb : Network Load Balancer (NLB). gwlb : Gateway Load Balancer (GWLB).	slb
ResourceId	string	Non	L'identifiant de la ressource de service à ajouter au service de point de terminaison.	lb-hp32z1wp5peaoox2q****
ZoneId	string	Non	L'identifiant de la zone.	cn-huhehaote-a
ServiceSupportIPv6 `deprecated`	boolean	Non	Indique si le service de point de terminaison prend en charge IPv6. Valeurs valides : true : pris en charge. false (par défaut) : non pris en charge.	false
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfmy*****
Tag	array<object>	Non	La liste des balises.
	object	Non	La liste des balises.
Key	string	Non	La clé de balise de l'instance. Vous pouvez spécifier jusqu'à 20 clés de balise. La clé de balise ne peut pas être une chaîne vide. La clé de balise peut contenir jusqu'à 64 caractères et ne peut pas commencer par aliyun ou acs:. Elle ne peut pas contenir http:// ou https://.	env
Value	string	Non	La valeur de balise de l'instance. Vous pouvez spécifier jusqu'à 20 valeurs de balise. La valeur de balise peut être une chaîne vide. La valeur de balise peut contenir jusqu'à 128 caractères et ne peut pas commencer par aliyun ou acs:. Elle ne peut pas contenir http:// ou https://.	prod
AddressIpVersion	string	Non	La version du protocole. Valeurs valides : IPv4 : IPv4 (par défaut). DualStack : double pile. Remarque Seuls les services de point de terminaison dont le type de ressource back-end est nlb ou gwlb prennent en charge DualStack. Si le service de point de terminaison prend en charge la double pile, les ressources back-end doivent également prendre en charge la double pile.	IPv4
SupportedRegionList	array	Non	La liste des régions prises en charge par le service de point de terminaison. Les consommateurs de services peuvent créer des connexions de point de terminaison à partir des régions de cette liste.
	string	Non	L'identifiant d'une région prise en charge par le service de point de terminaison.	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object
ServiceBusinessStatus	string	L'état commercial du service de point de terminaison. Valeurs valides : Normal : Normal. FinancialLocked : verrouillage financier.	Normal
RequestId	string	L'identifiant de la requête.	8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceName	string	Le nom de service du service de point de terminaison.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus	string	L'état du service de point de terminaison. Valeurs valides : Creating : en cours de création. Pending : en cours de modification. Active : disponible. Deleting : en cours de suppression.	Active
ServiceDescription	string	La description du service de point de terminaison.	This is my EndpointService.
CreateTime	string	L'heure à laquelle le service de point de terminaison a été créé. L'heure est au format YYYY-MM-DDTHH:mm:ssZ et affichée en UTC.	2022-01-02T19:11:12Z
ServiceDomain	string	Le nom de domaine de service du service de point de terminaison.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
ZoneAffinityEnabled	boolean	Indique si l'affinité de zone est prise en charge pour le nom de domaine de point de terminaison du service de point de terminaison. Valeurs valides : true : pris en charge. false : non pris en charge.	false
AutoAcceptEnabled	boolean	Indique si le service de point de terminaison est configuré pour accepter automatiquement les connexions de point de terminaison. Valeurs valides : true : le service de point de terminaison accepte automatiquement les connexions de point de terminaison. false : le service de point de terminaison n'accepte pas automatiquement les connexions de point de terminaison.	false
ServiceId	string	L'identifiant du service de point de terminaison.	epsrv-hp3vpx8yqxblby3i****
ServiceSupportIPv6 `deprecated`	boolean	Indique si le service de point de terminaison prend en charge IPv6. Valeurs valides : true : pris en charge. false : non pris en charge.	false
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmy*****
AddressIpVersion	string	La version du protocole. Valeurs valides : IPv4 : IPv4. DualStack : double pile.	IPv4
SupportedRegionSet	array<object>	La liste des régions prises en charge par le service de point de terminaison. Les consommateurs de services peuvent créer des connexions de point de terminaison à partir des régions de cette liste.
	object
ServiceRegionId `deprecated`	string	[Deprecated] L'identifiant de la région prise en charge par le service de point de terminaison. Utilisez plutôt SupportedRegionId.
RegionServiceStatus	string	L'état de la région prise en charge par le service de point de terminaison. Valeurs valides : Pending : en cours de modification. Available : disponible. Deleting : en cours de suppression. Failed : échoué. Closed : fermé.	Available
RegionBusinessStatus	string	L'état commercial de la région prise en charge par le service de point de terminaison. Valeurs valides : Normal : Normal. FinancialLocked : verrouillage financier.	Normal
SupportedRegionId	string	L'identifiant d'une région prise en charge par le service de point de terminaison.	cn-hangzhou

Exemples

JSON format

{
  "ServiceBusinessStatus": "Normal",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus": "Active",
  "ServiceDescription": "Ceci est mon service de point de terminaison",
  "CreateTime": "2022-01-02T19:11:12Z",
  "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
  "ZoneAffinityEnabled": false,
  "AutoAcceptEnabled": false,
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****",
  "AddressIpVersion": "IPv4",
  "SupportedRegionSet": [
    {
      "ServiceRegionId": "",
      "RegionServiceStatus": "Available",
      "RegionBusinessStatus": "Normal",
      "SupportedRegionId": "cn-hangzhou"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	EndpointServiceExist	The specified Endpoint Service already exists.	Le service de point de terminaison existe déjà.
400	AlbNotFound	The specified Alb does not exist.	L'instance d'équilibreur de charge ALI n'existe pas.
400	LoadBalancerNotFound	The specified load balancer does not exist.	L'instance d'équilibreur de charge n'existe pas.
400	LoadBalancerNotSupportPrivateLink	The specified SLB does not support PrivateLink.	L'instance d'équilibreur de charge actuelle ne prend pas en charge PrivateLink.
400	GenerateResourceIdFailed	Failed to generate ResourceId.	Échec de la génération d'un identifiant de ressource.
400	QuotaMisMatched	The resource you applied for has exceeded the quota.	Les ressources demandées dépassent le quota.
400	VSwitchNotFound	The specified VSwitch does not exist.
400	EndpointServicePayerForbidden	The parameter EndpointServicePayer is forbidden. The user is not in the whitelist.	Le type de facturation du service de point de terminaison ne figure pas dans la liste blanche.
400	NeedOpenProduct	The product is not activated.	Le service n'a pas été activé.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.	Le service de point de terminaison ne prend pas en charge la zone actuelle.
400	IllegalParamFormat.%s	The param format of %s is illegal.	Le format du %s spécifié n'est pas valide. Vérifiez les contraintes du paramètre et réessayez.
400	MissingParam.%s	The param of %s is missing.	Le paramètre %s est manquant.
400	ResourceNotFound.NatGateway	The specified resource %s is not found.
400	Mismatch.ResourceType	The %s is mismatched for %s and %s.	%s ne correspond pas entre %s et %s.
400	EndpointServiceNotSupportIpv6	The param supportIpv6 of EndpointService is forbidden , resource is not support ipv6.	Le service de point de terminaison ne prend pas en charge IPv6.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.	L'opération n'est pas prise en charge en raison de %s.
400	Conflict.ServiceName	The ServiceName %s is conflict.	Le nom de service %s est en conflit avec un nom de service existant.
400	InvalidParam.PrivateDnsName	The parameter of PrivateDnsName is illegal, which needs to end with aliyun.com, aliyun-inc.com, or aliyuncs.com.
400	OperationDenied.ZoneAffinityNotSupport	The operation is not allowed because of zone affinity not support.	L'opération n'est pas autorisée car l'accès de proximité basé sur le nom de domaine n'est pas pris en charge.
400	OperationDenied.RamPolicyNotSupport	The operation is not allowed because of RamPolicyNotSupport.	L'opération n'est pas autorisée car les stratégies RAM ne sont pas prises en charge.
400	OperationDenied.ResourceTypeNotSupportDualStack	The specified resource type does not support dualstack.	Le type de ressource back-end du service ne prend pas en charge la double pile.
400	OperationDenied.ServiceResourceIpVersionMismatch	The endpoint service and service resource AddressIpVersion do not match.	L'AddressIpVersion du service de point de terminaison ne correspond pas à la ressource back-end.
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.	Le paramètre AddressIpVersion spécifié ne répond pas aux exigences.
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.	L'instance ALB spécifiée n'est pas prise en charge.

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

Notes de version

Consultez Notes de version pour la liste complète.