GetListenerHealthStatus - - Centre de documentation Alibaba Cloud

Consulte l'état du contrôle de santé d'un écouteur et de ses règles de transfert.

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.

alb:GetListenerHealthStatus

get

*Équilibreur de charge.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ListenerId	string	Oui	L'identifiant de l'écouteur de l'instance.	lsn-o4u54y73wq7b******
IncludeRule	boolean	Non	Indique si les résultats de la vérification d'état des règles de transfert doivent être inclus. Valeurs valides : true : Inclut les résultats. false (par défaut) : N'inclut pas les résultats.	true
NextToken	string	Non	Indique s'il existe un jeton pour la requête suivante. Valeurs valides :\n- Pour la première requête ou lorsqu'il n'y a pas de requête suivante, laissez ce paramètre vide.\n- S'il existe une requête suivante, définissez ce paramètre sur la valeur NextToken renvoyée par l'appel d'API précédent.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	Non	Le nombre maximal d'entrées à renvoyer par page dans une requête paginée. Valeurs valides : 1 à 30. Valeur par défaut : 20.	20

Éléments de réponse

Élément	Type	Description	Exemple
	object	Consulte l'état du contrôle de santé d'un écouteur et les règles de transfert de ses configurations correspondantes.
ListenerHealthStatus	array<object>	La liste des états de contrôle de santé des groupes de serveurs associés à l'écouteur.
	array<object>	La structure de l'état de contrôle de santé des groupes de serveurs associés à l'écouteur.
ListenerId	string	L'identifiant de l'écouteur de l'instance.	lsn-o4u54y73wq7b******
ListenerPort	integer	Le port de l'écouteur.	80
ListenerProtocol	string	Le protocole de l'écouteur.	http
ServerGroupInfos	array<object>	Les informations du groupe de serveurs.
	array<object>	Les informations du groupe de serveurs.
HealthCheckEnabled	string	L'état du contrôle de santé. Valeurs valides : on : le contrôle de santé est activé.	on
NonNormalServers	array<object>	La liste des serveurs backend dans un état anormal.
	array<object>	La liste des serveurs backend dans un état anormal.
Port	integer	Le port du serveur backend.	90
Reason	object	La raison de l'état anormal.
ActualResponse	string	Le code de réponse réel renvoyé par le serveur backend, tel que 302. Remarque Cette valeur n'est renvoyée que lorsque ReasonCode est RESPONSE_MISMATCH.	302
ExpectedResponse	string	Le code de réponse attendu du serveur backend. Valeurs valides : HTTP_2xx, HTTP_3xx, HTTP_4xx et HTTP_5xx. Plusieurs codes de réponse sont séparés par des virgules (,). Remarque Cette valeur n'est renvoyée que lorsque ReasonCode est RESPONSE_MISMATCH.	HTTP_2xx
ReasonCode	string	La raison détaillée lorsque Status est anormal. Actuellement, seuls les écouteurs et les règles de transfert HTTP et HTTPS prennent en charge l'affichage des raisons de l'état anormal : CONNECT_TIMEOUT : le contrôle de santé du Server Load Balancer (SLB) a expiré lors de l'établissement d'une connexion au serveur backend. CONNECT_FAILED : le contrôle de santé du SLB n'a pas réussi à établir une connexion au serveur backend. RECV_RESPONSE_FAILED : le contrôle de santé du SLB n'a pas réussi à recevoir une réponse du serveur backend. RECV_RESPONSE_TIMEOUT : le contrôle de santé du SLB a expiré lors de la réception d'une réponse du serveur backend. SEND_REQUEST_FAILED : le contrôle de santé du SLB n'a pas réussi à envoyer une requête au serveur backend. SEND_REQUEST_TIMEOUT : le contrôle de santé du SLB a expiré lors de l'envoi d'une requête au serveur backend. RESPONSE_FORMAT_ERROR : le contrôle de santé du SLB a reçu une réponse dans un format incorrect de la part du serveur backend. RESPONSE_MISMATCH : le code de réponse reçu du serveur backend lors du contrôle de santé du SLB ne correspondait pas au code de réponse attendu.	RESPONSE_MISMATCH
ServerId	string	L'identifiant du serveur backend.	i-uf62h8v******
ServerIp	string	L'adresse IP du serveur backend.	192.168.8.10
Status	string	L'état du contrôle de santé. Valeurs valides : Initial : en cours d'initialisation. L'instance SLB a un contrôle de santé configuré, mais aucune donnée n'est disponible. Unhealthy : non sain. Le serveur backend a signalé de manière continue un état non sain. Unused : non utilisé. Le poids du serveur backend est de 0, ou l'équilibrage de charge interzones est désactivé et le serveur backend n'est pas dans la même zone que l'instance Application Load Balancer (ALB). Unavailable : non activé. Le contrôle de santé n'est pas activé.	Initial
ServerGroupId	string	L'identifiant du groupe de serveurs associé.	sgp-8ilqs4axp6******
ActionType	string	Le type d'utilisation du groupe de serveurs. Valeurs valides : ForwardGroup : transférer vers le groupe de serveurs. TrafficMirror : dupliquer le trafic vers le groupe de serveurs.	TrafficMirror
ServerCount	integer	Le nombre de serveurs dans le groupe de serveurs.	1
RequestId	string	L'identifiant de la requête.	CEF72CEB-54B6-4AE8-B225-F876F******
RuleHealthStatus	array<object>	La liste des états de santé des règles de transfert.
	array<object>	La structure de l'état de santé d'une règle de transfert.
RuleId	string	L'identifiant de la règle de transfert.	rule-hp34s2h0xx1ht4nwo****
ServerGroupInfos	array<object>	La liste des groupes de serveurs.
	array<object>	La structure du groupe de serveurs.
HealthCheckEnabled	string	L'état du contrôle de santé. Valeurs valides : on : le contrôle de santé est activé.	on
NonNormalServers	array<object>	La liste des serveurs backend dans un état anormal.
	array<object>	La liste des serveurs backend dans un état anormal.
Port	integer	Le port du serveur backend.	90
Reason	object	La raison de l'état anormal.
ActualResponse	string	Le code de réponse réel renvoyé par le serveur backend, tel que 302. Remarque Cette valeur n'est renvoyée que lorsque ReasonCode est RESPONSE_MISMATCH.	302
ExpectedResponse	string	Le code de réponse attendu du serveur backend. Valeurs valides : HTTP_2xx, HTTP_3xx, HTTP_4xx et HTTP_5xx. Plusieurs codes de réponse sont séparés par des virgules (,). Remarque Cette valeur n'est renvoyée que lorsque ReasonCode est RESPONSE_MISMATCH.	HTTP_2xx
ReasonCode	string	La raison détaillée lorsque Status est anormal. Actuellement, seuls les écouteurs et les règles de transfert HTTP et HTTPS prennent en charge l'affichage des raisons de l'état anormal : CONNECT_TIMEOUT : le contrôle de santé du Server Load Balancer (SLB) a expiré lors de l'établissement d'une connexion au serveur backend. CONNECT_FAILED : le contrôle de santé du SLB n'a pas réussi à établir une connexion au serveur backend. RECV_RESPONSE_FAILED : le contrôle de santé du SLB n'a pas réussi à recevoir une réponse du serveur backend. RECV_RESPONSE_TIMEOUT : le contrôle de santé du SLB a expiré lors de la réception d'une réponse du serveur backend. SEND_REQUEST_FAILED : le contrôle de santé du SLB n'a pas réussi à envoyer une requête au serveur backend. SEND_REQUEST_TIMEOUT : le contrôle de santé du SLB a expiré lors de l'envoi d'une requête au serveur backend. RESPONSE_FORMAT_ERROR : le contrôle de santé du SLB a reçu une réponse dans un format incorrect de la part du serveur backend. RESPONSE_MISMATCH : le code de réponse reçu du serveur backend lors du contrôle de santé du SLB ne correspondait pas au code de réponse attendu.	RESPONSE_MISMATCH
ServerId	string	L'identifiant du serveur backend.	i-uf62h8v******
ServerIp	string	L'adresse IP du groupe de serveurs backend.	192.168.2.11
Status	string	L'état du contrôle de santé. Valeurs valides : Initial : en cours d'initialisation. L'instance SLB a un contrôle de santé configuré, mais aucune donnée n'est disponible. Unhealthy : non sain. Le serveur backend a signalé de manière continue un état non sain. Unused : non utilisé. Le poids du serveur backend est de 0, ou l'équilibrage de charge interzones est désactivé et le serveur backend n'est pas dans la même zone que l'instance ALB. Unavailable : non activé. Le contrôle de santé n'est pas activé.	Initial
ServerGroupId	string	L'identifiant du groupe de serveurs associé.	sgp-8ilqs4axp6******
ActionType	string	Le type d'utilisation du groupe de serveurs.	TrafficMirror
ServerCount	integer	Le nombre de serveurs dans le groupe de serveurs.	1
NextToken	string	Indique si un jeton de requête suivante existe. Valeurs valides : Si NextToken est vide, aucune requête suivante n'existe. Si NextToken est renvoyé, la valeur indique le jeton pour la requête suivante.	FFmyTO70tTpLG6I3FmYAXGKPd****

Exemples

JSON format

{
  "ListenerHealthStatus": [
    {
      "ListenerId": "lsn-o4u54y73wq7b******",
      "ListenerPort": 80,
      "ListenerProtocol": "http",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": "on",
          "NonNormalServers": [
            {
              "Port": 90,
              "Reason": {
                "ActualResponse": "302",
                "ExpectedResponse": "HTTP_2xx",
                "ReasonCode": "RESPONSE_MISMATCH"
              },
              "ServerId": "i-uf62h8v******",
              "ServerIp": "192.168.8.10",
              "Status": "Initial"
            }
          ],
          "ServerGroupId": "sgp-8ilqs4axp6******",
          "ActionType": "TrafficMirror",
          "ServerCount": 1
        }
      ]
    }
  ],
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876F******",
  "RuleHealthStatus": [
    {
      "RuleId": "rule-hp34s2h0xx1ht4nwo****",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": "on",
          "NonNormalServers": [
            {
              "Port": 90,
              "Reason": {
                "ActualResponse": "302",
                "ExpectedResponse": "HTTP_2xx",
                "ReasonCode": "RESPONSE_MISMATCH"
              },
              "ServerId": "i-uf62h8v******",
              "ServerIp": "192.168.2.11",
              "Status": "Initial"
            }
          ],
          "ServerGroupId": "sgp-8ilqs4axp6******",
          "ActionType": "TrafficMirror",
          "ServerCount": 1
        }
      ]
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
403	Forbidden.LoadBalancer	Authentication is failed for %s.	Échec de l'authentification pour l'opération d'équilibrage de charge.
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.	La ressource %s n'existe pas.
404	ResourceNotFound.Listener	The specified resource %s is not found.	L'écouteur n'existe pas.

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

Notes de version

Consultez Notes de version pour la liste complète.