GetListenerHealthStatus - - Centre de documentation Alibaba Cloud

Consulte l'état du contrôle d'état d'un écouteur d'instance d'équilibreur de charge.

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.

gwlb:GetListenerHealthStatus

get

*Équilibreur de charge.

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadbalancerId}

*Écouteur.

acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ListenerId	string	Oui	L'identifiant de l'écouteur.	lsn-7sixpvm5fc3v0b****
NextToken	string	Non	Indique si un jeton de requête suivant existe. Valeurs valides : Si NextToken est vide, aucune requête suivante n'existe. Si NextToken a une valeur de retour, la valeur indique le jeton pour la requête suivante.	4f1d7cc9f51e18904e8a063603a6b0c3d03bc69f78734254e0b5e8707e68****
MaxResults	integer	Non	Le nombre d'entrées par page dans une requête paginée. Valeurs valides : 1 à 1000. Valeur par défaut : 20.	20
Skip	integer	Non	Le nombre d'entrées à ignorer dans une requête paginée.	10
Filter	array<object>	Non	La liste des conditions de requête dynamique. Vous pouvez ajouter jusqu'à 20 conditions de requête dynamique à la fois.
	object	Non	La condition de requête dynamique.
Name	string	Non	Le nom de la condition de requête dynamique. Vous pouvez spécifier un ou plusieurs noms pour la requête. Valeurs valides : Status : l'état du contrôle d'état. ReasonCode : la raison détaillée lorsque l'état est anormal. ServerId : l'identifiant du serveur back-end. ServerIp : l'adresse IP du serveur back-end. Valeurs valides : Status : état du contrôle d'état. ServerId : identifiant du serveur back-end. ServerIp : adresse IP du serveur back-end. ReasonCode : raison détaillée de l'état anormal.	Status
Values	array	Non	La liste des valeurs pour la condition de requête dynamique. Vous pouvez ajouter jusqu'à 20 valeurs à la fois.
	string	Non	La valeur de la condition de requête dynamique. Pour les valeurs valides, reportez-vous au champ correspondant dans les paramètres de réponse.	Unhealthy

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse.
ListenerHealthStatus	array<object>	La liste des états de contrôle d'état pour les groupes de serveurs associés à l'écouteur.
	array<object>	La structure de l'état de contrôle d'état pour un groupe de serveurs associé à l'écouteur.
ListenerId	string	L'identifiant de l'écouteur.	lsn-sg8aha6pzjavvo****
ServerGroupInfos	array<object>	La liste des informations sur les groupes de serveurs.
	array<object>	Les informations sur le groupe de serveurs.
HealthCheckEnabled	boolean	Indique si le contrôle d'état est activé. Valeurs valides : true : Activé. false : Désactivé.	true
ServerGroupId	string	L'identifiant du groupe de serveurs.	sgp-0vdsbyszro3nr6****
Servers	array<object>	La liste des serveurs back-end.
	array<object>	Le serveur back-end.
Port	integer	Le port du serveur back-end.	6081
Reason	object	La raison détaillée lorsque Status est anormal.
ReasonCode	string	La raison détaillée lorsque Status est anormal. Valeurs valides : CONNECT_TIMEOUT : Le contrôle d'état de l'équilibreur de charge a expiré lors de l'établissement d'une connexion au serveur back-end. CONNECT_FAIL : Le contrôle d'état de l'équilibreur de charge n'a pas réussi à établir une connexion au serveur back-end. RECV_TIMEOUT : Le contrôle d'état de l'équilibreur de charge a expiré lors de l'attente d'acceptation d'une réponse du serveur back-end. CONNECT_INTERRUPT : La connexion du contrôle d'état de l'équilibreur de charge au serveur back-end a rencontré une interruption. HTTP_CODE_NOT_MATCH : Le code de réponse reçu du serveur back-end lors du contrôle d'état HTTP de l'équilibreur de charge ne correspondait pas au code de retour attendu. HTTP_INVALID_HEADER : La réponse reçue du serveur back-end lors du contrôle d'état HTTP de l'équilibreur de charge présentait une erreur de format.	CONNECT_TIMEOUT
ServerId	string	L'identifiant du serveur back-end.	i-2ze4rnh8yj9kif3z****
ServerIp	string	L'adresse IP du serveur back-end.	192.168.0.XXX
Status	string	L'état du contrôle d'état du serveur back-end. Valeurs valides : Initial : Initialisation en cours. L'instance d'équilibreur de charge a un contrôle d'état configuré, mais aucune donnée n'est disponible. Unhealthy : Non sain. Le serveur back-end a signalé consécutivement un état non sain. Unused : Non utilisé. Unavailable : Non activé. Le contrôle d'état n'est pas activé. Healthy : Sain. Le contrôle d'état est normal.	Healthy
MaxResults	integer	Le nombre d'entrées par page dans une requête paginée. Valeurs valides : 1 à 1000. Valeur par défaut : 20.	20
NextToken	string	Indique si un jeton de requête suivant existe. Valeurs valides : Si NextToken est vide, aucune requête suivante n'existe. Si NextToken a une valeur de retour, la valeur indique le jeton pour la requête suivante.	U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****
RequestId	string	L'identifiant de la requête.	0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A
TotalCount	integer	Le nombre total d'entrées retournées sous les conditions de requête actuelles.	31

Exemples

JSON format

{
  "ListenerHealthStatus": [
    {
      "ListenerId": "lsn-sg8aha6pzjavvo****",
      "ServerGroupInfos": [
        {
          "HealthCheckEnabled": true,
          "ServerGroupId": "sgp-0vdsbyszro3nr6****",
          "Servers": [
            {
              "Port": 6081,
              "Reason": {
                "ReasonCode": "CONNECT_TIMEOUT"
              },
              "ServerId": "i-2ze4rnh8yj9kif3z****",
              "ServerIp": "192.168.0.XXX",
              "Status": "Healthy"
            }
          ]
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "U12WEI6Ro2ol3wA54rBNSwdC5+lYy6q5SjIQEvc1wz5mjZxV+YjsHRdXV8XauY1BpOQIvwX63E0en54H3D****",
  "RequestId": "0ED4F222-36A0-5470-8A9A-AAB4E96BAC1A",
  "TotalCount": 31
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalParam.FilterValue	The param of %s is illegal.	La valeur de la condition de requête dynamique n'est pas valide.
400	IllegalParam.FilterName	The param of %s is illegal.	Le nom de la condition de requête dynamique n'est pas valide.
404	ResourceNotFound.Listener	The specified resource of %s is not found.	La ressource d'écouteur spécifiée n'existe pas.

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

Notes de version

Consultez Notes de version pour la liste complète.