ListLoadBalancers - Server Load Balancer - Centre de documentation Alibaba Cloud

Répertorie les instances 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:ListLoadBalancers

list

LoadBalancer

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

LoadBalancer

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

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ZoneIds	array	Non	La liste des identifiants de zone. Vous pouvez interroger jusqu'à 20 identifiants de zone à la fois.
	string	Non	L'identifiant de la zone.	cn-beijing-h
VpcIds	array	Non	La liste des identifiants de cloud privé virtuel (VPC). Vous pouvez interroger jusqu'à 20 identifiants de VPC à la fois.
	string	Non	L'identifiant du VPC.	vpc-bp1xuejaht4o7yhh2****
AddressIpVersion	string	Non	La version du protocole. Valeur valide : Ipv4 : IPv4. Valeurs valides : IPv4 : IPv4 DualStack : Double pile.	Ipv4
LoadBalancerStatus	string	Non	L'état de l'instance GWLB. Valeurs valides : Active : L'instance est en cours d'exécution. Inactive : L'instance est arrêtée. Dans cet état, l'écouteur de l'instance ne transfère pas le trafic. Provisioning : L'instance est en cours de création. Configuring : L'instance est en cours de modification.	Active
LoadBalancerBusinessStatus	string	Non	L'état commercial de l'instance GWLB. Valeurs valides : Normal : L'instance fonctionne normalement. FinancialLocked : L'instance est verrouillée en raison d'un paiement en retard.	Normal
LoadBalancerNames	array	Non	La liste des noms d'instances GWLB. Vous pouvez interroger jusqu'à 20 noms d'instances à la fois.
	string	Non	Le nom de l'instance GWLB.	testGwlbName
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-aek2htf5qsyrn****
LoadBalancerIds	array	Non	La liste des identifiants d'instances GWLB. Vous pouvez interroger jusqu'à 20 identifiants d'instances à la fois.
	string	Non	L'identifiant de l'instance GWLB.	gwlb-cp6prgqy40hols****
TrafficMode	string	Non	Le mode de trafic. Valeurs valides : LoadBalance : L'instance est en mode d'équilibrage de charge. ByPass : L'instance est en mode de contournement.	LoadBalance
Tag	array<object>	Non	La liste des balises. Vous pouvez spécifier jusqu'à 20 balises lors de chaque appel.
	object	Non	L'objet balise.
Key	string	Non	La clé de balise. La clé de balise ne peut pas être une chaîne vide. La clé de balise peut comporter jusqu'à 128 caractères et ne peut pas commencer par `aliyun` ou `acs:`. Elle ne peut pas contenir `http://` ou `https://`.	testTagKey
Value	string	Non	La valeur de balise. La valeur de balise peut comporter jusqu'à 256 caractères et ne peut pas contenir `http://` ou `https://`.	testTagValue
NextToken	string	Non	Le jeton utilisé pour la requête suivante. Valeurs valides : Si NextToken est vide, cela indique qu'aucune requête suivante ne doit être envoyée. Si NextToken a une valeur, cette valeur est le jeton utilisé pour la requête suivante.	WyJyb290IiwibiIsIm4iLDEsMCwxNjg1MDY1NTgyNzYwLCI2NDcwMGY2ZTc2Zjc0MWFiZGEyZjQyNzc4ZDk2MmJkOTk3ZGZmM2Nm****
MaxResults	integer	Non	Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 1 à 1000. Valeur par défaut : 20.	20
Skip	integer	Non	Le nombre d'entrées à ignorer.	1

Éléments de réponse

Élément	Type	Description	Exemple
	object
LoadBalancers	array<object>	La liste des instances GWLB.
	array<object>	L'instance GWLB.
AddressIpVersion	string	La version du protocole. Valeur valide : IPv4 : IPv4.	IPv4
CreateTime	string	L'heure de création de la ressource. L'heure est affichée en UTC et suit le format yyyy-MM-ddTHH:mm:ssZ.	2024-08-05T18:24:07Z
LoadBalancerBusinessStatus	string	L'état commercial de l'instance GWLB. Valeurs valides : Normal : L'instance fonctionne normalement. FinancialLocked : L'instance est verrouillée en raison d'un paiement en retard.	Normal
LoadBalancerId	string	L'identifiant de l'instance GWLB.	gwlb-9njtjmqt7zfcqm****
LoadBalancerName	string	Le nom de l'instance GWLB. Le nom doit comporter de 2 à 128 caractères, commencer par une lettre ou un caractère chinois, et peut contenir des chiffres, des points (.), des traits de soulignement (_) et des traits d'union (-).	testGwlbName
LoadBalancerStatus	string	L'état de l'instance GWLB. Valeurs valides : Active : L'instance est en cours d'exécution. Inactive : L'instance est arrêtée. Dans cet état, l'écouteur de l'instance ne transfère pas le trafic. Provisioning : L'instance est en cours de création. Configuring : L'instance est en cours de modification.	Active
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-aek26jasguy****
Tags	array<object>	La liste des balises.
	object	La balise.
Key	string	The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters in length, and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	testTagKey
Value	string	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length, must start with a letter or a Chinese character, and can contain digits, periods (.), underscores (_), and hyphens (-). The tag value cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	testTagValue
VpcId	string	L'identifiant du VPC.	vpc-uf6eg0vndlsa84n7r****
ZoneMappings	array<object>	La liste des mappages entre les zones et les vSwitchs. Vous devez ajouter au moins une zone et pouvez en ajouter jusqu'à 20. Si la région actuelle prend en charge deux zones ou plus, nous vous recommandons d'ajouter deux zones ou plus.
	array<object>	Le mappage entre une zone et un vSwitch.
LoadBalancerAddresses	array<object>	The list of addresses of the GWLB instance.
	object	The address of the GWLB instance.
EniId	string	The ID of the elastic network interface (ENI).	eni-bp17qv9zbzyqy629****
PrivateIpv4Address	string	The private IPv4 address.	192.168.XX.XX
VSwitchId	string	The vSwitch in the zone. Each zone uses a vSwitch and a subnet by default.	vsw-2zemule5dz7okwqfv****
ZoneId	string	The zone ID. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-g
MaxResults	integer	Le nombre d'entrées renvoyées sur chaque page. Valeurs valides : 1 à 1000. Valeur par défaut : 20.	20
NextToken	string	Le jeton utilisé pour la requête suivante. Valeurs valides : Vous n'avez pas besoin de spécifier ce paramètre pour la première requête ou si aucune requête ultérieure ne doit être envoyée. Si une requête ultérieure doit être envoyée, définissez la valeur sur la valeur NextToken renvoyée par l'appel d'API précédent.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****
RequestId	string	L'identifiant de la requête.	378A80E9-4262-5D8E-8D62-0969E52D7358
TotalCount	integer	Le nombre total d'entrées renvoyées.	100

Exemples

JSON format

{
  "LoadBalancers": [
    {
      "AddressIpVersion": "IPv4",
      "CreateTime": "2024-08-05T18:24:07Z",
      "LoadBalancerBusinessStatus": "Normal",
      "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
      "LoadBalancerName": "testGwlbName",
      "LoadBalancerStatus": "Active",
      "ResourceGroupId": "rg-aek26jasguy****",
      "Tags": [
        {
          "Key": "testTagKey",
          "Value": "testTagValue"
        }
      ],
      "VpcId": "vpc-uf6eg0vndlsa84n7r****",
      "ZoneMappings": [
        {
          "LoadBalancerAddresses": [
            {
              "EniId": "eni-bp17qv9zbzyqy629****",
              "PrivateIpv4Address": "192.168.XX.XX"
            }
          ],
          "VSwitchId": "vsw-2zemule5dz7okwqfv****",
          "ZoneId": "cn-hangzhou-g"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****",
  "RequestId": "378A80E9-4262-5D8E-8D62-0969E52D7358",
  "TotalCount": 100
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.