DescribeEndpointGroup - - Centre de documentation Alibaba Cloud

Consulte les détails d'un groupe de points de terminaison spécifié.

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.

ga:DescribeEndpointGroup

get

*EndpointGroup.

acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointGroupId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de l'instance Alibaba Cloud Global Accelerator (GA). Seule la région cn-hangzhou est prise en charge.	cn-hangzhou
EndpointGroupId	string	Oui	L'identifiant du groupe de points de terminaison que vous souhaitez interroger.	epg-bp14sz7ftcwwjgrdm****

Éléments de réponse

Élément	Type	Description	Exemple
	object	La liste des informations de réponse.
HealthCheckIntervalSeconds	integer	L'intervalle entre les vérifications de l'état, en secondes.	3
TrafficPercentage	integer	Le pourcentage de trafic routé vers différents groupes de points de terminaison lorsqu'un écouteur possède plusieurs groupes de points de terminaison.	100
EndpointGroupId	string	L'identifiant du groupe de points de terminaison.	epg-bp14sz7ftcwwjgrdm****
Description	string	La description du groupe de points de terminaison.	group1
EndpointGroupIpList	array	La liste des adresses IP des points de terminaison actifs dans le groupe de points de terminaison. Important Pour les groupes de points de terminaison qui utilisent le routage de retour à l'origine via un réseau privé, la console affiche uniquement les adresses de retour à l'origine du réseau privé et n'affiche plus les adresses de réseau public. Si le type de connectivité réseau du service backend dans le groupe de points de terminaison change, par exemple d'un réseau privé à un réseau public, ou à un réseau hybride public et privé, surveillez rapidement les changements d'adresses de retour à l'origine et effectuez la synchronisation de la liste ACL du service backend.
	string	Une adresse IP de point de terminaison actif dans le groupe de points de terminaison.	101.XX.XX.22
EndpointGroupUnconfirmedIpList	array	La liste des nouvelles adresses IP du groupe de points de terminaison en attente de confirmation après la mise à niveau de l'instance Alibaba Cloud Global Accelerator (GA).
	string	La liste des nouvelles adresses IP du groupe de points de terminaison en attente de confirmation après la mise à niveau de l'instance Alibaba Cloud Global Accelerator (GA).	101.XX.XX.22
RequestId	string	L'identifiant de la requête.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
HealthCheckPath	string	Le chemin de vérification de l'état.	/healthcheck
ThresholdCount	integer	Le nombre de vérifications de l'état consécutives ayant échoué, requis pour marquer un point de terminaison comme non sain.	3
Name	string	Le nom du groupe de points de terminaison.	group1
EndpointGroupRegion	string	L'identifiant de la région à laquelle le groupe de points de terminaison appartient.	cn-hangzhou
State	string	L'état du groupe de points de terminaison. Valeurs valides : init : Initialisation. active : Normal. updating : Mise à jour. deleting : Suppression.	active
HealthCheckProtocol	string	Le protocole de vérification de l'état. Valeurs valides : tcp ou TCP : protocole TCP. http ou HTTP : protocole HTTP. https ou HTTPS : protocole HTTPS.	tcp
HealthCheckPort	integer	Le port de vérification de l'état.	20
EndpointConfigurations	array<object>	Les configurations des points de terminaison.
	object	Les configurations des points de terminaison.
Type	string	Le type de point de terminaison. Valeurs valides : Domain : nom de domaine personnalisé. Ip : adresse IP personnalisée. IpTarget : adresse IP privée personnalisée. PublicIp : adresse IP publique Alibaba Cloud. ECS : instance ECS Alibaba Cloud. SLB : instance SLB Alibaba Cloud. ALB : instance ALB Alibaba Cloud. OSS : instance OSS Alibaba Cloud. ENI : interfaces réseau élastiques (ENI) Alibaba Cloud, qui agissent comme un contrôleur d'interface réseau (NIC). NLB : instance NLB Alibaba Cloud.	Ip
EnableClientIPPreservation	boolean	Indique si la préservation de l'adresse IP du client est activée en utilisant la méthode de récupération automatique. Valeurs valides : true : la préservation de l'adresse IP du client est activée. false : la préservation de l'adresse IP du client est désactivée.	false
Weight	integer	Le poids du point de terminaison.	255
ProbeProtocol	string	Le protocole de sondage de latence. Valeurs valides : tcp : TCP. icmp : ICMP.	tcp
Endpoint	string	L'adresse IP, le nom de domaine ou l'identifiant d'instance du point de terminaison.	120.XX.XX.21
EnableProxyProtocol	boolean	Indique si la préservation de l'adresse IP du client est activée en utilisant le Proxy Protocol. Valeurs valides : true : la préservation de l'adresse IP du client est activée en utilisant le Proxy Protocol. false : la préservation de l'adresse IP du client n'est pas activée en utilisant le Proxy Protocol.	false
ProbePort	integer	Le port de sondage pour la surveillance de la latence.	80
SubAddress	string	L'adresse IP privée de l'interface réseau élastique (ENI).	172.168.XX.XX
VpcId	string	L'identifiant du cloud privé virtuel (VPC).	vpc-hp30gtnxkfxj1l2xt****
VSwitchIds	array	La liste des vSwitches dans le VPC.
	string	L'identifiant du vSwitch.	vsw-bp1nx4sxxe1nnr1ja****
Provider	string	Le fournisseur de configuration.	BAILIAN
ApiKeys	array	Les clés API dans la configuration du point de terminaison.
	string	La première clé API dans la configuration du point de terminaison.	sk-*******
PortOverrides	array<object>	Les relations de mappage de ports.
	object	Les relations de mappage de ports.
ListenerPort	integer	Le port de l'écouteur.	443
EndpointPort	integer	Le port du point de terminaison.	80
EndpointRequestProtocol	string	Le protocole du service backend. Cela fait référence au protocole réseau, et non aux conditions d'utilisation. Valeurs valides : HTTP HTTPS	HTTP
EndpointProtocolVersion	string	La version du protocole du service backend. Cela fait référence à la version du protocole réseau, et non aux conditions d'utilisation. Valeurs valides : HTTP1.1 HTTP2	HTTP2
EndpointGroupType	string	Le type de groupe de points de terminaison. Valeurs valides : default : groupe de points de terminaison par défaut. virtual : groupe de points de terminaison virtuel.	default
ForwardingRuleIds	array	Les identifiants des règles de transfert associées au groupe de points de terminaison.
	string	Les identifiants des règles de transfert associées au groupe de points de terminaison.	frule-bp19a3t3yzr21q3****
AcceleratorId	string	L'identifiant d'instance de l'Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
ListenerId	string	L'identifiant d'instance de l'écouteur.	lsr-bp1bpn0kn908w4nbw****
SlsRegion	string	La région de Simple Log Service.	cn-hangzhou
SlsProjectName	string	Le nom du projet Simple Log Service.	pn-01
SlsLogStoreName	string	Le nom du Logstore Simple Log Service.	lsn-01
AccessLogSwitch	string	L'état de liaison des journaux. Valeurs valides : on : lié. off : non lié. binding : liaison en cours. unbinding : dissociation en cours.	on
EnableAccessLog	boolean	Indique si la journalisation des accès est activée. Valeurs valides : true : la journalisation des accès est activée. false : la journalisation des accès est désactivée.	true
HealthCheckEnabled	boolean	Indique si les vérifications de l'état sont activées. Valeurs valides : true : les vérifications de l'état sont activées. false : les vérifications de l'état sont désactivées.	true
ServiceId	string	L'identifiant du fournisseur de services auquel l'instance gérée appartient. Remarque Ce paramètre n'est valide que lorsque le paramètre ServiceManaged est défini sur True.	ALB
ServiceManaged	boolean	Indique si l'instance est une instance gérée. Valeurs valides : true : l'instance est une instance gérée. false : l'instance n'est pas une instance gérée.	true
ServiceManagedInfos	array<object>	La liste des stratégies d'action que les utilisateurs peuvent exécuter sur cette instance gérée. Remarque Ce paramètre n'est valide que lorsque le paramètre ServiceManaged est défini sur True. Lorsqu'une instance est à l'état géré, les opérations des utilisateurs sur l'instance sont restreintes et certaines opérations sont interdites.
	object	La liste des stratégies d'action que les utilisateurs peuvent exécuter sur l'instance gérée.
Action	string	Le nom de l'action de stratégie gérée. Valeurs valides : Create : créer une instance. Update : mettre à jour l'instance actuelle. Delete : supprimer l'instance actuelle. Associate : référencer ou être référencé par l'instance actuelle. UserUnmanaged : retirer l'instance de la gestion. CreateChild : créer une ressource enfant sous l'instance actuelle.	Update
ChildType	string	Le type de ressource enfant. Valeurs valides : Listener : ressource d'écouteur. IpSet : ressource de région d'accélération. EndpointGroup : ressource de groupe de points de terminaison. ForwardingRule : ressource de règle de transfert. Endpoint : ressource de point de terminaison. EndpointGroupDestination : ressource de mappage de protocole de groupe de points de terminaison sous un écouteur de routage personnalisé. EndpointPolicy : ressource de stratégie d'accès de point de terminaison sous un écouteur de routage personnalisé. Remarque Ce paramètre n'est valide que lorsque le paramètre Action est défini sur CreateChild.	Listener
IsManaged	boolean	Indique si l'action de stratégie gérée est gérée. Valeurs valides : true : l'action de stratégie gérée est gérée. Les utilisateurs n'ont pas les autorisations nécessaires pour effectuer l'opération spécifiée par Action sur l'instance gérée. false : l'action de stratégie gérée n'est pas gérée. Les utilisateurs peuvent effectuer l'opération spécifiée par Action sur l'instance gérée.	false
Tags	array<object>	Les balises du groupe de points de terminaison.
	object	Les balises du groupe de points de terminaison.
Key	string	La clé de balise du groupe de points de terminaison.	test-key
Value	string	La valeur de balise du groupe de points de terminaison.	test-value
HealthCheckHost	string	Le nom de domaine pour les vérifications de l'état.	www.taobao.com
AccessLogRecordCustomizedHeadersEnabled	boolean	Indique si les journaux d'accès contiennent des champs d'en-tête personnalisés. Valeurs valides : true : oui. false (par défaut) : non. Remarque Vous ne pouvez définir ce paramètre sur true que lorsque le commutateur de journal d'accès AccessLogEnabled pour l'instance est activé.
AccessLogRecordCustomizedHeaderList	array	La liste des noms de champs d'en-tête personnalisés contenus dans les journaux d'accès.
	string	La liste des noms de champs d'en-tête personnalisés contenus dans les journaux d'accès.	['sda', 'dsaasdd', 'dsada']
EndpointIpVersion	string	Le protocole d'adresse IP backend. Valeurs valides : IPv4 (par défaut) : GA utilise uniquement des adresses IPv4 pour communiquer avec le service de point de terminaison. IPv6 : GA utilise uniquement des adresses IPv6 pour communiquer avec le service de point de terminaison. ProtocolAffinity : le protocole IP utilisé par GA pour communiquer avec le service de point de terminaison est le même que le protocole IP utilisé dans les requêtes client.	IPv4
EndpointPrivateIpList	array<object>	La liste des adresses IP privées des nœuds backend.
	object
PrivateIp	string	L'adresse IP privée.	172.16.49.***
VSwitchId	string	L'identifiant du vSwitch dans le VPC.	gsw-bp1rsfd2frym**
CIDR	string	Le bloc CIDR dans la liste des adresses IP des points de terminaison privés.	10.0.0.0/24
HealthCheckSuccessCodes	string	Les codes d'état de réussite pour les vérifications de l'état.	http_2xx,http_3xx
HealthCheckMethod	string	La méthode de vérification de l'état.	GET
ProxyTunnel	object	La configuration du tunnel proxy.
ConnectAuthPrefix	string	Le préfixe d'authentification de connexion.	prefix-auth
ConnectAuthSuffix	string	Le suffixe d'authentification de connexion.	suffix-auth
ConnectSessionHashHdr	string	L'en-tête de hachage de session de connexion.	X-Session-Hash
ConnectTunnelTimeout	integer	Le délai d'expiration du tunnel de connexion.	5000
TunnelServerPort	integer	Le port du serveur de tunnel.	8443
TunnelServerType	string	Le type de serveur de tunnel.	domain
TunnelServer	string	La configuration du serveur de tunnel.	tunnel.example.com

Exemples

JSON format

{
  "HealthCheckIntervalSeconds": 3,
  "TrafficPercentage": 100,
  "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
  "Description": "group1",
  "EndpointGroupIpList": [
    "101.XX.XX.22"
  ],
  "EndpointGroupUnconfirmedIpList": [
    "101.XX.XX.22"
  ],
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "HealthCheckPath": "/healthcheck",
  "ThresholdCount": 3,
  "Name": "group1",
  "EndpointGroupRegion": "cn-hangzhou",
  "State": "active",
  "HealthCheckProtocol": "tcp",
  "HealthCheckPort": 20,
  "EndpointConfigurations": [
    {
      "Type": "Ip",
      "EnableClientIPPreservation": false,
      "Weight": 255,
      "ProbeProtocol": "tcp",
      "Endpoint": "120.XX.XX.21",
      "EnableProxyProtocol": false,
      "ProbePort": 80,
      "SubAddress": "172.168.XX.XX",
      "VpcId": "vpc-hp30gtnxkfxj1l2xt****",
      "VSwitchIds": [
        "vsw-bp1nx4sxxe1nnr1ja****"
      ],
      "Provider": "BAILIAN",
      "ApiKeys": [
        "sk-*******"
      ]
    }
  ],
  "PortOverrides": [
    {
      "ListenerPort": 443,
      "EndpointPort": 80
    }
  ],
  "EndpointRequestProtocol": "HTTP",
  "EndpointProtocolVersion": "HTTP2",
  "EndpointGroupType": "default",
  "ForwardingRuleIds": [
    "frule-bp19a3t3yzr21q3****"
  ],
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "SlsRegion": "cn-hangzhou",
  "SlsProjectName": "pn-01",
  "SlsLogStoreName": "lsn-01",
  "AccessLogSwitch": "on",
  "EnableAccessLog": true,
  "HealthCheckEnabled": true,
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ],
  "Tags": [
    {
      "Key": "test-key",
      "Value": "test-value"
    }
  ],
  "HealthCheckHost": "www.taobao.com",
  "AccessLogRecordCustomizedHeadersEnabled": false,
  "AccessLogRecordCustomizedHeaderList": [
    "['sda', 'dsaasdd', 'dsada']"
  ],
  "EndpointIpVersion": "IPv4",
  "EndpointPrivateIpList": [
    {
      "PrivateIp": "172.16.49.***",
      "VSwitchId": "gsw-bp1rsfd2frym**",
      "CIDR": "10.0.0.0/24"
    }
  ],
  "HealthCheckSuccessCodes": "http_2xx,http_3xx",
  "HealthCheckMethod": "GET",
  "ProxyTunnel": {
    "ConnectAuthPrefix": "prefix-auth",
    "ConnectAuthSuffix": "suffix-auth",
    "ConnectSessionHashHdr": "X-Session-Hash",
    "ConnectTunnelTimeout": 5000,
    "TunnelServerPort": 8443,
    "TunnelServerType": "domain",
    "TunnelServer": "tunnel.example.com"
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

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

Notes de version

Consultez Notes de version pour la liste complète.