GetListenerHealthStatus - - Centre de documentation Alibaba Cloud

Consulte l'état du contrôle de santé d'un écouteur de Gateway Load Balancer (GWLB).

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

*LoadBalancer

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

*Listener

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	Le jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Valeurs valides : Si NextToken est vide, il n'y a pas de page suivante. Si une valeur de NextToken est renvoyée, cette valeur indique le jeton à utiliser pour la requête suivante.	4f1d7cc9f51e18904e8a063603a6b0c3d03bc69f78734254e0b5e8707e68****
MaxResults	integer	Non	Le nombre d'entrées par page. Valeurs valides : 1 à 1000. Valeur par défaut : 20.	20
Skip	integer	Non	Le nombre d'entrées à ignorer lors de l'appel.	10
Filter	array<object>	Non	Les conditions de filtrage. Vous pouvez spécifier jusqu'à 20 conditions de filtrage.
	object	Non	La condition de filtrage.
Name	string	Non	Le nom de la condition de filtrage. Vous pouvez filtrer par un ou plusieurs noms de conditions de filtrage. Le nom doit respecter les exigences suivantes : Status : l'état de santé. ReasonCode : la cause d'un serveur non sain. ServerId : l'identifiant du serveur back-end. ServerIp : l'adresse IP du serveur back-end.	Status
Values	array	Non	Les valeurs de la condition de filtrage. Vous pouvez spécifier jusqu'à 20 valeurs de condition.
	string	Non	La valeur de la condition de filtrage. Les valeurs valides varient en fonction du nom de la condition de filtrage spécifié dans la réponse.	Unhealthy

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
ListenerHealthStatus	array<object>	L'état du contrôle de santé des groupes de serveurs associés à l'écouteur.
	array<object>	L'état du contrôle de santé des groupes de serveurs associés à l'écouteur.
ListenerId	string	L'identifiant de l'écouteur.	lsn-sg8aha6pzjavvo****
ServerGroupInfos	array<object>	Les informations sur les groupes de serveurs.
	array<object>	Les informations sur le groupe de serveurs.
HealthCheckEnabled	boolean	Indicates whether the health check feature is enabled. Valid values: true false	true
ServerGroupId	string	The server group ID.	sgp-0vdsbyszro3nr6****
Servers	array<object>	The backend servers.
	array<object>	The backend server.
Port	integer	The backend port.	6081
Reason	object	The reason why Status indicates an unhealthy status.
ReasonCode	string	The reason why Status indicates an unhealthy status. Valid values: CONNECT_TIMEOUT: The GWLB instance failed to connect to the backend server within the specified period of time. CONNECT_FAILED: The GWLB instance failed to connect to the backend server. RECV_RESPONSE_TIMEOUT: The GWLB instance failed to receive a response from the backend server within the specified period of time. CONNECT_INTERRUPT: The connection between the health check and the backend server was interrupted. HTTP_CODE_NOT_MATCH: The HTTP status code from the backend server is not the expected one. HTTP_INVALID_HEADER: The format of the response from the backend servers is invalid.	CONNECT_TIMEOUT
ServerId	string	The backend server ID.	i-2ze4rnh8yj9kif3z****
ServerIp	string	The IP address of the server.	192.168.0.XXX
Status	string	The health status of the backend server. Valid values: Initial: Health checks are configured for the GWLB instance, but no data is found. Unhealthy: The backend server consecutively fails health checks. Unused: The backend server is not in use. Unavailable: Health checks are disabled. Healthy: The backend server is healthy.	Healthy
MaxResults	integer	Le nombre d'entrées par page. Valeurs valides : 1 à 1000. Valeur par défaut : 20.	20
NextToken	string	Un jeton de pagination. Il peut être utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Valeurs valides : Si NextToken est vide, il n'y a pas de page suivante. Si une valeur de NextToken est renvoyée, cette valeur indique le jeton à utiliser 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 renvoyées.	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.	The parameter of FilterValue is illegal.
400	IllegalParam.FilterName	The param of %s is illegal.	The parameter of FilterName is illegal.
404	ResourceNotFound.Listener	The specified resource of %s is not found.	The specified resource of %s is not found.

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

Notes de version

Consultez Notes de version pour la liste complète.