GetVpcEndpointAttribute - - Centre de documentation Alibaba Cloud

Consulte les attributs d'un 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:GetVpcEndpointAttribute

get

*VpcEndpoint.

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

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 dont vous souhaitez consulter les attributs. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste des régions la plus récente.	cn-huhehaote
EndpointId	string	Oui	L'identifiant du point de terminaison dont vous souhaitez consulter les attributs.	ep-hp33b2e43fays7s8****

Éléments de réponse

Élément	Type	Description	Exemple
	object
Payer	string	Le payeur. Valeurs valides : Endpoint : le consommateur du service. EndpointService : le fournisseur du service.	Endpoint
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.	8D8992C1-6712-423C-BAC5-E5E817484C6B
CreateTime	string	L'heure de création du point de terminaison.	2021-09-24T18:00:07Z
ResourceOwner	boolean	Indique si le point de terminaison et le service de point de terminaison appartiennent au même compte Alibaba Cloud. Valeurs valides : true : le point de terminaison et le service de point de terminaison appartiennent au même compte. false : le point de terminaison et le service de point de terminaison appartiennent à des comptes différents.	true
EndpointBusinessStatus	string	L'état commercial du point de terminaison. Valeurs valides : Normal : normal. FinancialLocked : verrouillage financier.	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 auquel le point de terminaison est associé.	epsrv-hp3vpx8yqxblby3i****
EndpointStatus	string	L'état du point de terminaison. Valeurs valides : Creating : en cours de création. Active : disponible. Pending : en cours de modification. Deleting : en cours de suppression.	Active
VpcId	string	L'identifiant du cloud privé virtuel (VPC) auquel le point de terminaison appartient.	vpc-fdfhkjafhjvcvdjf****
EndpointName	string	Le nom du point de terminaison.	test
ZonePrivateIpAddressCount	integer	Le nombre d'adresses IP privées attribuées à l'interface réseau élastique (ENI) du point de terminaison dans chaque zone. La valeur est fixée à 1.	1
EndpointType	string	Le type de point de terminaison. Valeurs valides : Interface : point de terminaison d'interface. Reverse : point de terminaison inverse. GatewayLoadBalancer : point de terminaison Gateway Load Balancer (GWLBe).	Interface
ServiceName	string	Le nom du service de point de terminaison auquel le point de terminaison est associé.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidth	integer	La bande passante de la connexion du point de terminaison. Unité : Mbps.	1024
EndpointId	string	L'identifiant du point de terminaison.	ep-hp33b2e43fays7s8****
RegionId	string	L'identifiant de la région du point de terminaison.	cn-huhehaote
ConnectionStatus	string	L'état de la connexion du point de terminaison. Valeurs valides : Pending : en cours de modification. Connecting : en cours de connexion. Connected : connecté. Disconnecting : en cours de déconnexion. Disconnected : déconnecté. Deleting : en cours de suppression. ServiceDeleted : le service de point de terminaison correspondant a été supprimé.	Connected
ZoneAffinityEnabled	boolean	Indique si l'affinité de zone est activée pour que le nom de domaine du point de terminaison soit résolu vers le service connecté. Valeurs valides : true : activée. false : désactivée.	true
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmz7nocpei***
PolicyDocument	string	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.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "oss:List", "oss:PutObject", "oss:GetObject" ], "Resource": [ "acs:oss:oss-::pvl-policy-test/policy-test.txt" ], "Principal": { "RAM": [ "acs:ram::14199xxxxxx:" ] } } ] }
AddressIpVersion	string	La version du protocole. Valeurs valides : IPv4 : IPv4. DualStack : double pile.	IPv4
ServiceRegionId	string	L'identifiant de la région du service de point de terminaison auquel le point de terminaison est associé.	cn-hangzhou
CrossRegionBandwidth	integer	La bande passante interrégionale du point de terminaison. Unité : Mbps.	1000
ProtectedEnabled	boolean	Indique si la protection gérée est activée. Ce paramètre ne prend effet que lorsque la méthode d'appel STS est utilisée. Valeurs valides : true : activée. Une fois la protection gérée activée, seul l'utilisateur ayant créé le point de terminaison peut le modifier ou le supprimer en utilisant STS. false : désactivée.

Exemples

JSON format

{
  "Payer": "Endpoint",
  "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "CreateTime": "2021-09-24T18:00:07Z",
  "ResourceOwner": true,
  "EndpointBusinessStatus": "Normal",
  "EndpointDescription": "Ceci est mon point de terminaison",
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus": "Active",
  "VpcId": "vpc-fdfhkjafhjvcvdjf****",
  "EndpointName": "test",
  "ZonePrivateIpAddressCount": 1,
  "EndpointType": "Interface",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth": 1024,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "RegionId": "cn-huhehaote",
  "ConnectionStatus": "Connected",
  "ZoneAffinityEnabled": true,
  "ResourceGroupId": "rg-acfmz7nocpei***",
  "PolicyDocument": "{\n  \"Version\": \"1\",\n  \"Statement\": [\n    {\n      \"Effect\": \"Allow\",\n      \"Action\": [\n        \"oss:List*\",\n        \"oss:PutObject\",\n        \"oss:GetObject\"\n      ],\n      \"Resource\": [\n        \"acs:oss:oss-*:*:pvl-policy-test/policy-test.txt\"\n      ],\n      \"Principal\": {\n        \"RAM\": [\n          \"acs:ram::14199xxxxxx:*\"\n        ]\n      }\n    }\n  ]\n}",
  "AddressIpVersion": "IPv4",
  "ServiceRegionId": "cn-hangzhou",
  "CrossRegionBandwidth": 1000,
  "ProtectedEnabled": false
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	EndpointNotFound	The specified Endpoint does not exist.	Le point de terminaison n'a pas été trouvé.
400	EndpointConnectionNotFound	The specified endpoint connection does not exist.	La connexion du point de terminaison n'a pas été trouvée.

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

Notes de version

Consultez Notes de version pour la liste complète.