GetLoadBalancerAttribute - - Centre de documentation Alibaba Cloud

Consulte les détails d'une instance 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:GetLoadBalancerAttribute

get

*LoadBalancer

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
LoadBalancerId	string	Oui	L'identifiant de l'instance GWLB.	gwlb-9njtjmqt7zfcqm****

Éléments de réponse

Élément	Type	Description	Exemple
	object
AddressIpVersion	string	La version du protocole. Valeurs valides : Ipv4 : IPv4.	IPv4
CreateTime	string	L'heure de création de la ressource. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.	2024-07-08T10:12:58Z
LoadBalancerBusinessStatus	string	L'état commercial de l'instance GWLB. Valeurs valides : Normal : fonctionnement normal FinancialLocked : verrouillé en raison de paiements en souffrance	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 et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_) et des traits d'union (-). Le nom doit commencer par une lettre.	gwlb
LoadBalancerStatus	string	L'état de l'instance GWLB. Valeurs valides : Active : l'instance GWLB est en cours d'exécution. Inactive : l'instance GWLB est désactivée. Les écouteurs des instances GWLB à l'état Inactive ne transfèrent pas le trafic. Provisioning : l'instance GWLB est en cours de création. Configuring : l'instance GWLB est en cours de modification.	Active
RequestId	string	L'identifiant de la requête.	B6DC5DDC-9560-59BF-80FA-ED1E5CB417DF
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfmx7pmxcy****
Tags	array<object>	Les balises.
	object	Les informations sur la balise.
Key	string	La clé de la balise. La clé de la balise ne peut pas être une chaîne vide. La clé de la balise peut comporter jusqu'à 128 caractères. La clé de la balise ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.	testTagKey
Value	string	La valeur de la balise. La valeur de la balise peut comporter jusqu'à 256 caractères et ne peut pas contenir `http://` ou `https://`.	testTagValue
VpcId	string	L'identifiant du VPC.	vpc-k1aajsbwbaq4todet****
ZoneMappings	array<object>	Les mappages entre les zones et les vSwitches. Vous devez spécifier au moins une zone. Vous pouvez spécifier jusqu'à 20 zones. Si la région prend en charge deux zones ou plus, spécifiez au moins deux zones.
	array<object>	Les informations sur les zones et les vSwitches.
LoadBalancerAddresses	array<object>	Les adresses de l'instance GWLB.
	object	Les détails sur les adresses de l'instance GWLB.
EniId	string	The ID of the elastic network interface (ENI) used by the GWLB instance.	eni-bp1iahwz3rzgvltz****
PrivateIpv4Address	string	The private IPv4 address.	192.168.XX.XX
VSwitchId	string	Le vSwitch dans la zone. Vous ne pouvez spécifier qu'un seul vSwitch (sous-réseau) dans chaque zone d'une instance GWLB.	vsw-uf6v8l7d2f1k53xrl****
ZoneId	string	L'identifiant de la zone.	cn-hangzhou-j
TrafficMode	string	Le mode de traitement du trafic. Valeurs valides : LoadBalance : mode d'équilibrage de charge. Le GWLB transfère le trafic vers les serveurs back-end. ByPass : mode de contournement. Le GWLB renvoie directement le trafic vers le point de terminaison GWLB sans le transférer aux serveurs back-end.	LoadBalance

Exemples

JSON format

{
  "AddressIpVersion": "IPv4",
  "CreateTime": "2024-07-08T10:12:58Z",
  "LoadBalancerBusinessStatus": "Normal",
  "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
  "LoadBalancerName": "gwlb",
  "LoadBalancerStatus": "Active",
  "RequestId": "B6DC5DDC-9560-59BF-80FA-ED1E5CB417DF",
  "ResourceGroupId": "rg-acfmx7pmxcy****",
  "Tags": [
    {
      "Key": "testTagKey",
      "Value": "testTagValue"
    }
  ],
  "VpcId": "vpc-k1aajsbwbaq4todet****",
  "ZoneMappings": [
    {
      "LoadBalancerAddresses": [
        {
          "EniId": "eni-bp1iahwz3rzgvltz****",
          "PrivateIpv4Address": "192.168.XX.XX"
        }
      ],
      "VSwitchId": "vsw-uf6v8l7d2f1k53xrl****",
      "ZoneId": "cn-hangzhou-j"
    }
  ],
  "TrafficMode": "LoadBalance"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.
400	MissingParam.LoadBalancerId	The param of LoadBalancerId is missing.	Load balancing ID parameter missing

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

Notes de version

Consultez Notes de version pour la liste complète.