GetLoadBalancerAttribute - - Centre de documentation Alibaba Cloud

Consulte les détails d'une instance Network Load Balancer (NLB) spécifiée.

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.

nlb:GetLoadBalancerAttribute

get

*LoadBalancer

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
LoadBalancerId	string	Oui	L'identifiant de l'instance Network Load Balancer (NLB).	nlb-83ckzc8d4xlp8o****
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides :	false
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Non	L'identifiant de la région de l'instance Network Load Balancer (NLB).	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object	Réponse.
RequestId	string	L'identifiant de la requête.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RegionId	string	L'identifiant de la région de l'instance NLB.	cn-hangzhou
LoadBalancerId	string	L'identifiant de l'instance NLB.	nlb-83ckzc8d4xlp8o****
LoadBalancerName	string	Le nom de l'instance NLB.	NLB1
LoadBalancerType	string	Le type d'équilibrage de charge. Seul network est renvoyé, ce qui indique un Network Load Balancer (NLB).	network
AddressType	string	Le type d'adresse réseau IPv4 de l'instance NLB. Valeurs valides :	Internet
AddressIpVersion	string	La version du protocole. Valeurs valides :	ipv4
Ipv6AddressType	string	Le type d'adresse IPv6 de l'instance NLB. Valeurs valides :	Internet
LoadBalancerStatus	string	L'état de l'instance NLB. Valeurs valides :	Active
LoadBalancerBusinessStatus	string	L'état commercial de l'instance NLB. Valeurs valides :	Normal
OperationLocks	array<object>	La liste des états de verrouillage de l'instance NLB. Ce paramètre n'est renvoyé que lorsque LoadBalancerBussinessStatus est Abnormal.
	object	La liste des états de verrouillage de l'instance Network Load Balancer (NLB). Ce paramètre n'est renvoyé que lorsque LoadBalancerBussinessStatus est Abnormal.
LockType	string	Le type de verrouillage. Valeurs valides :	SecurityLocked
LockReason	string	La raison du verrouillage.	Exception commerciale
VpcId	string	L'identifiant du VPC de l'instance NLB.	vpc-bp1b49rqrybk45nio****
CreateTime	string	L'heure de création de la ressource. L'heure est affichée en UTC au format yyyy-MM-ddTHH:mm:ssZ.	2022-07-02T02:49:05Z
ResourceGroupId	string	L'identifiant du groupe de ressources.	rg-atstuj3rtop****
DNSName	string	Le nom de domaine de l'instance NLB.	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
ZoneMappings	array<object>	Les mappages entre les zones et les vSwitches. Un maximum de 10 zones sont renvoyées. Si la région actuelle prend en charge deux zones ou plus, au moins deux zones sont renvoyées.
	array<object>	Les mappages entre les zones et les vSwitches. Un maximum de 10 zones sont renvoyées. Si la région actuelle prend en charge deux zones ou plus, au moins deux zones sont renvoyées.
VSwitchId	string	Le vSwitch dans la zone. Chaque zone utilise un vSwitch et un sous-réseau par défaut.	vsw-bp1rmcrwg3erh1fh8****
ZoneId	string	L'identifiant de la zone. Vous pouvez appeler l'opération DescribeZones pour obtenir la liste des zones la plus récente.	cn-hangzhou-a
LoadBalancerAddresses	array<object>	Les informations d'adresse de l'instance Network Load Balancer (NLB).
	object	Les informations d'adresse de l'instance Network Load Balancer (NLB).
EniId	string	The ID of the ENI.	eni-bp12f1xhs5yal61a****
PrivateIPv4Address	string	The private IPv4 VIP address. The private IPv4 address that the NLB instance uses to provide services.	192.168.3.32
AllocationId	string	The Elastic IP Address (EIP) instance ID.	eip-bp1aedxso6u80u0qf****
PublicIPv4Address	string	The public IPv4 address of the NLB instance.	120.XX.XX.69
Ipv6Address	string	The IPv6 VIP address. The IPv6 address that the NLB instance uses to provide services.	2001:db8:1:1:1:1:1:1
PrivateIPv4HcStatus	string	The health check status of the private IPv4 address of the NLB instance. Valid values: Healthy: healthy. Unhealthy: unhealthy. Remarque This parameter is returned only when the zone status (Status) is Active.	Healthy
PrivateIPv6HcStatus	string	The health check status of the IPv6 address of the NLB instance. Valid values: Healthy: healthy. Unhealthy: unhealthy. Remarque This parameter is returned only when the zone status (Status) is Active.	Healthy
Ipv4LocalAddresses	array	The list of IPv4 local addresses. These are the addresses used for communication between the NLB instance and backend servers.
	string	The IPv4 local address.	192.168.36.16
Ipv6LocalAddresses	array	The list of IPv6 local addresses. These are the addresses used for communication between the NLB instance and backend servers.
	string	The IPv6 local address.	2408:4005:357:ba00:64a2:221f:5685:8854
Status	string	L'état de la zone. Valeurs valides :	Active
BandwidthPackageId	string	L'identifiant de l'instance Internet Shared Bandwidth associée à l'instance NLB orientée Internet.	cbwp-bp1vevu8h3ieh****
SecurityGroupIds	array	Les identifiants des groupes de sécurité associés à l'instance NLB.
	string	Les identifiants des groupes de sécurité associés à l'instance NLB.	sg-bp10uag3q0jkxu72****
CrossZoneEnabled	boolean	Indique si la fonctionnalité interzones est activée pour l'instance NLB. Valeurs valides :	true
LoadBalancerBillingConfig	object	La configuration de facturation de l'instance d'équilibrage de charge.
PayType	string	Le type de facturation de l'instance NLB.	PostPay
Cps	integer	Le nombre maximal de nouvelles connexions par seconde que l'instance NLB peut traiter par zone (VIP). Valeurs valides : 0 à 1000000.	100
DeletionProtectionConfig	object	La configuration de protection contre la suppression.
Enabled	boolean	L'état de la protection contre la suppression. Valeurs valides :	true
Reason	string	La raison du changement de l'état de protection contre la suppression. La raison doit comporter entre 2 et 128 caractères et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_) et des traits d'union (-). La raison doit commencer par une lettre ou un caractère chinois.	Instance en cours d'exécution
EnabledTime	string	L'heure à laquelle la protection contre la suppression a été activée. L'heure est affichée en UTC au format yyyy-MM-ddTHH:mm:ssZ.	2022-11-02T02:49:05Z
ModificationProtectionConfig	object	La configuration de protection contre la modification.
Status	string	L'état de la protection contre la modification de l'instance Network Load Balancer (NLB). Valeurs valides :	ConsoleProtection
Reason	string	La raison de l'activation de la protection contre la modification. La raison doit comporter entre 2 et 128 caractères et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_) et des traits d'union (-). La raison doit commencer par une lettre ou un caractère chinois.	Période de protection de l'activité
EnabledTime	string	L'heure à laquelle la protection contre la modification a été activée. L'heure est affichée en UTC au format yyyy-MM-ddTHH:mm:ssZ.	2022-12-02T02:49:05Z
Tags	array<object>	La liste des balises.
	object	La liste des balises.
TagKey	string	La clé de balise de l'instance.	CléTest
TagValue	string	La valeur de balise de l'instance.	ValeurTest

Exemples

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "RegionId": "cn-hangzhou",
  "LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
  "LoadBalancerName": "NLB1",
  "LoadBalancerType": "network",
  "AddressType": "Internet",
  "AddressIpVersion": "ipv4",
  "Ipv6AddressType": "Internet",
  "LoadBalancerStatus": "Active",
  "LoadBalancerBusinessStatus": "Normal",
  "OperationLocks": [
    {
      "LockType": "SecurityLocked",
      "LockReason": "Business exception."
    }
  ],
  "VpcId": "vpc-bp1b49rqrybk45nio****",
  "CreateTime": "2022-07-02T02:49:05Z",
  "ResourceGroupId": "rg-atstuj3rtop****",
  "DNSName": "nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com",
  "ZoneMappings": [
    {
      "VSwitchId": "vsw-bp1rmcrwg3erh1fh8****",
      "ZoneId": "cn-hangzhou-a",
      "LoadBalancerAddresses": [
        {
          "EniId": "eni-bp12f1xhs5yal61a****",
          "PrivateIPv4Address": "192.168.3.32",
          "AllocationId": "eip-bp1aedxso6u80u0qf****",
          "PublicIPv4Address": "120.XX.XX.69",
          "Ipv6Address": "2001:db8:1:1:1:1:1:1",
          "PrivateIPv4HcStatus": "Healthy",
          "PrivateIPv6HcStatus": "Healthy",
          "Ipv4LocalAddresses": [
            "192.168.36.16"
          ],
          "Ipv6LocalAddresses": [
            "2408:4005:357:ba00:64a2:221f:5685:8854"
          ]
        }
      ],
      "Status": "Active"
    }
  ],
  "BandwidthPackageId": "cbwp-bp1vevu8h3ieh****",
  "SecurityGroupIds": [
    "sg-bp10uag3q0jkxu72****"
  ],
  "CrossZoneEnabled": true,
  "LoadBalancerBillingConfig": {
    "PayType": "PostPay"
  },
  "Cps": 100,
  "DeletionProtectionConfig": {
    "Enabled": true,
    "Reason": "Instance running.",
    "EnabledTime": "2022-11-02T02:49:05Z"
  },
  "ModificationProtectionConfig": {
    "Status": "ConsoleProtection",
    "Reason": "Business protection period.",
    "EnabledTime": "2022-12-02T02:49:05Z"
  },
  "Tags": [
    {
      "TagKey": "KeyTest",
      "TagValue": "ValueTest"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	DuplicatedParam.%s	The param of %s is duplicated.
400	OperationFailed.GetXipFailed	Operation failed because GetXipFailed.	The operation failed because the instance is still being created.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	The specified load balancer resource was not found. Please check the input parameters.

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

Notes de version

Consultez Notes de version pour la liste complète.