CreateVpcEndpoint - - Centre de documentation Alibaba Cloud

Crée un point de terminaison.

Description de l'opération

CreateVpcEndpoint est une opération asynchrone. Après l'envoi d'une requête, le système renvoie un identifiant d'instance, mais le point de terminaison n'est pas encore créé. La tâche en arrière-plan est toujours en cours. Vous pouvez appeler GetVpcEndpointAttribute pour interroger l'état de création du point de terminaison :

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:CreateVpcEndpoint

create

*VpcEndpoint

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

*SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

privatelink:VpcEndpointServiceId

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région du point de terminaison.	cn-huhehaote
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête.	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 :	false
EndpointName	string	Non	Le nom du point de terminaison.	test
EndpointType	string	Non	Le type de point de terminaison. Valeurs valides :	Interface
ZonePrivateIpAddressCount	integer	Non	Le nombre d'adresses IP privées pour l'ENI dans chaque zone. Définissez la valeur sur 1.	1
EndpointDescription	string	Non	La description du point de terminaison.	Ceci est mon point de terminaison
VpcId	string	Oui	Le VPC auquel le point de terminaison appartient.	vpc-hp356stwkxg3fn2xe****
ServiceId	string	Non	Le service de point de terminaison associé au point de terminaison.	epsrv-hp3xdsq46ael67lo****
ServiceName	string	Non	Le nom du service de point de terminaison associé au point de terminaison.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
Zone	array<object>	Non	Les zones du point de terminaison.
	object	Non	L'identifiant de la zone dans la région actuelle.
VSwitchId	string	Non	Le vSwitch dans la zone où vous souhaitez créer une interface réseau élastique (ENI) de point de terminaison.	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	Non	La zone du point de terminaison.	cn-huhehaote-b
ip	string	Non	L'adresse IPv4 de l'interface réseau élastique (ENI) du point de terminaison dans la zone de point de terminaison spécifiée.	192.168.XX.XX
Ipv6Address	string	Non	L'adresse IPv6 de l'interface réseau élastique (ENI) du point de terminaison dans la zone de point de terminaison spécifiée.	2408:4005:34d:**:a58b:62a3:6b55:**
SecurityGroupId	array	Non	Les groupes de sécurité associés à l'interface réseau élastique (ENI) du point de terminaison.	sg-hp33bw6ynvm2yb0e****
	string	Non	Le groupe de sécurité associé à l'interface réseau élastique (ENI) du point de terminaison. Le groupe de sécurité contrôle la communication des données du VPC vers l'interface réseau élastique (ENI) du point de terminaison.	sg-bp1fg655nh68xyz9****
ProtectedEnabled	boolean	Non	Indique si la protection gérée doit être activée. Ce paramètre prend effet uniquement lorsque la requête est effectuée à l'aide du Security Token Service (STS). Valeurs valides :	false
Tag	array<object>	Non	Les balises.
	object	Non	Les balises.
Key	string	Non	La clé de la balise.	env
Value	string	Non	La valeur de la balise.	prod
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfmy*****
PolicyDocument	string	Non	La stratégie d'accès RAM. Pour plus d'informations sur la définition de la stratégie, consultez Éléments de stratégie.	{
AddressIpVersion	string	Non	La version du protocole. Valeurs valides :	IPv4
ZoneAffinityEnabled	boolean	Non	Indique si l'affinité de zone doit être prise en charge pour le nom de domaine du point de terminaison lors de la connexion au service. Valeurs valides :	false
ServiceRegionId	string	Non	L'identifiant de la région du service de point de terminaison. La valeur par défaut est la région actuelle, c'est-à-dire la région où vous créez un point de terminaison.	cn-huhehaote
CrossRegionBandwidth	integer	Non	La valeur de la bande passante interrégionale. Ce paramètre est requis uniquement lorsque le point de terminaison et le service de point de terminaison se trouvent dans des régions différentes. Unité : Mbps. Valeurs valides :	1000

Éléments de réponse

Élément	Type	Description	Exemple
	object
EndpointDomain	string	Le nom de domaine du point de terminaison.	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com
RequestId	string	L'identifiant de la requête.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
CreateTime	string	L'heure à laquelle le point de terminaison a été créé.	2022-01-02T19:11:12Z
EndpointBusinessStatus	string	L'état commercial du point de terminaison. Valeurs valides :	Normal
EndpointDescription	string	La description du point de terminaison.	Ceci est mon point de terminaison
ServiceId	string	L'identifiant du service de point de terminaison associé au point de terminaison.	epsrv-hp3vpx8yqxblby3i****
EndpointStatus	string	L'état du point de terminaison. Valeurs valides :	Active
VpcId	string	Le VPC auquel le point de terminaison appartient.	vpc-hp356stwkxg3fn2xe****
EndpointName	string	Le nom du point de terminaison.	test
ServiceName	string	Le nom du service de point de terminaison associé au point de terminaison.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidth	integer	La bande passante de connexion du point de terminaison. Unité : Mbps.	200
EndpointId	string	L'identifiant du point de terminaison.	ep-hp33b2e43fays7s8****
ConnectionStatus	string	L'état de connexion du point de terminaison. Valeurs valides :	Disconnected
AddressIpVersion	string	La version du protocole. Valeurs valides :	IPv4
ZoneAffinityEnabled	boolean	Indique si l'affinité de zone doit être prise en charge pour le nom de domaine du point de terminaison lors de la connexion au service. Valeurs valides :	false
ServiceRegionId	string	L'identifiant de la région du service de point de terminaison.	cn-huhehaote
CrossRegionBandwidth	integer	La valeur de la bande passante interrégionale du point de terminaison. Ce paramètre s'applique uniquement lorsque le point de terminaison et le service de point de terminaison se trouvent dans des régions différentes. Unité : Mbps.	1000

Exemples

JSON format

{
  "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "CreateTime": "2022-01-02T19:11:12Z",
  "EndpointBusinessStatus": "Normal",
  "EndpointDescription": "This is my Endpoint.",
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus": "Active",
  "VpcId": "vpc-hp356stwkxg3fn2xe****",
  "EndpointName": "test",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth": 200,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "ConnectionStatus": "Disconnected",
  "AddressIpVersion": "IPv4",
  "ZoneAffinityEnabled": false,
  "ServiceRegionId": "cn-huhehaote",
  "CrossRegionBandwidth": 1000
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	EndpointExist	The specified Endpoint already exists.	The specified Endpoint already exists.
400	EndpointZoneDuplicated	The zone is duplicated for the Endpoint.	The zone is duplicated for the Endpoint.
400	EndpointServiceNotFound	The specified Service does not exist.	The specified Service does not exist.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.	The specified endpoint service does not support the zone.
400	VSwitchNotFound	The specified VSwitch does not exist.
400	SecurityGroupNotFound	The specified security group does not exist.	The specified security group does not exist.
400	VpcTunnelNotFound	The specified VPC tunnel does not exist.	The specified VPC tunnel does not exist.
400	VpcNotFound	The specified VPC does not exist.	The specified VPC does not exist.
400	GenerateResourceIdFailed	Failed to generate ResourceId.	Failed to generate ResourceId.
400	QuotaMisMatched	The resource you applied for has exceeded the quota.	The resource you applied for has exceeded the quota.
400	EndpointMustContainSecurityGroup	The specified endpoint must have at least one security group.	The specified endpoint must have at least one security group.
400	EndpointDuplicated	The endpoint of the service already exists and cannot be created again.
400	EndpointServiceDeleted	The specified Service is already deleted.	The specified Service is already deleted.
400	EndpointServiceResourceNotFound	The specified service resource is not found.
400	SecurityGroupTypeNotSupport	The specified security group type is not supported.
400	EniIpUnavailable	The specified IP address is unavailable.	The specified IP address is unavailable.
400	EndpointServiceNotAuthorized	The specified endpoint service is not authorized to user.	The specified endpoint service is not authorized to user.
400	SecurityGroupTypeOnlySingleTypeSupporteded	The specified security group only support one type.
400	QuotaExceeded.IpQuotaPerEp	The quota of %s is exceeded, usage %s/%s.
400	Mismatch.EndpointType	The %s is mismatched for %s and %s.
400	IncorrectStatus.VpcEndpointService	The status of %s [%s] is incorrect.
400	CheckServiceLinkRoleError	The ServiceLink role check error.	ServiceLinkRole check error
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.	The number of vSwitch IP addresses is insufficient.
400	VSwitchStatusNotAllowed	The specified vswitch status is not Available.	The status of the vSwitch is not available.
400	QuotaExceeded.epZonePerEndpoint	The quota of %s is exceeded, usage %s/%s.	The number of endpoints in a zone has reached the upper limit.
400	QuotaExceeded.totalEpPerVpc	The quota of %s is exceeded, usage %s/%s.	The number of VPC endpoints has reached the upper limit.
400	QuotaExceeded.totalIdleEndpoint	The quota of %s is exceeded, usage %s/%s.	The total number of idle endpoints has reached the upper limit.
400	OperationDenied.EndpointPolicyNotSupport	The operation is not allowed because of EndpointPolicyNotSupport.
400	OperationDenied.PrivateDomainStatusNotSupport	The operation is not allowed because of %s.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	DependencyViolation.PrivateDnsName	The specified resource of %s depends on %s, so the operation cannot be completed.
400	GatewayLoadBalancerNotSupportSecurityGroup	The gateway load balancer not support security group.	The gateway load balancer type does not support setting a security group.
400	GatewayLoadBalancerZoneCountDeny	The GatewayLoadBalancer zone count not support	The number of available zones does not meet the limit and cannot be operated.
400	OperationDenied.EndpointTypeNotSupportDualstack	The specified endpoint type does not support dualstack, only the Interface and GatewayLoadBalancer types support dual stack.	The specified endpoint type does not support dualstack, only the Interface and GatewayLoadBalancer types support dual stack.
400	OperationDenied.EndpointServiceNotSupportDualstack	The specified endpoint service does not support dualstack.	The specified endpoint service does not support dualstack.
400	OperationDenied.VSwitchNotSupportDualstack	The specified VSwitch does not support dualstack.	The specified VSwitch does not support dualstack.
400	OperationDenied.AddressIpVersionNotSupportSpecifyIpv6	The AddressIpVersion of the endpoint does not support specifying IPv6 address.	The AddressIpVersion of the endpoint does not support specifying an IPv6 address.
400	IllegalParam.Ip	The specified parameter IP is invalid.	The specified parameter IP is invalid.
400	IllegalParam.Ipv6Address	The specified parameter Ipv6Address is invalid.	The specified parameter Ipv6Address is invalid.
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.	The specified parameter AddressIpVersion does not meet the requirements.
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.	the specified alb instance is not supported.

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

Notes de version

Consultez Notes de version pour la liste complète.