GetLoadBalancerAttribute - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetLoadBalancerAttribute	L'opération à effectuer. Définissez la valeur sur GetLoadBalancerAttribute.
LoadBalancerId	String	Oui	nlb-83ckzc8d4xlp8o****	ID de l'instance NLB.
DryRun	Boolean	Non	false	Indique s'il faut effectuer une vérification préalable. Valeurs possibles : true : effectue une vérification préalable. Le système vérifie les paramètres obligatoires, la syntaxe de la requête et les limites. Si la requête échoue à la vérification, un code d'erreur est renvoyé en fonction de la cause de l'échec. Si la requête réussit la vérification, le code d'erreur `DryRunOperation` est renvoyé. false : effectue une vérification préalable et envoie la requête. Si la vérification réussit, un code d'état HTTP 2xx est renvoyé et l'opération est exécutée. Il s'agit de la valeur par défaut.
ClientToken	String	Non	123e4567-e89b-12d3-a456-426655440000	Jeton client à utiliser pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer la valeur, mais assurez-vous qu'elle est unique parmi toutes les requêtes. La valeur ClientToken contient uniquement des caractères ASCII. Remarque Si vous ne définissez pas ce paramètre, le système utilise automatiquement la valeur de RequestId comme valeur de ClientToken. La valeur de RequestId est différente pour chaque requête API.
RegionId	String	Non	cn-hangzhou	ID de la région où l'instance NLB est déployée. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	CEF72CEB-54B6-4AE8-B225-F876FF7BA984	ID de la requête.
RegionId	String	cn-hangzhou	ID de la région où l'instance NLB est déployée.
LoadBalancerId	String	nlb-83ckzc8d4xlp8o****	ID de l'instance NLB.
LoadBalancerName	String	NLB1	Nom de l'instance NLB. Le nom doit comporter entre 2 et 128 caractères et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_) et des tirets (-). Le nom doit commencer par une lettre.
LoadBalancerType	String	network	Type d'instance. Seule la valeur network est renvoyée, ce qui indique une instance NLB.
AddressType	String	Internet	Type d'adresse IPv4 utilisé par l'instance NLB. Valeurs possibles : Internet : L'instance NLB utilise une adresse IP publique. Le nom de domaine de l'instance NLB est résolu vers l'adresse IP publique. Par conséquent, l'instance NLB est accessible via Internet. Intranet : L'instance NLB utilise une adresse IP privée. Le nom de domaine de l'instance NLB est résolu vers l'adresse IP privée. Par conséquent, l'instance NLB est accessible via le réseau privé virtuel (VPC) où elle est déployée.
AddressIpVersion	String	ipv4	Version du protocole. Valeurs possibles : ipv4 : IPv4 DualStack : pile double
Ipv6AddressType	String	Internet	Type d'adresse IPv6 utilisé par l'instance NLB. Valeurs possibles : Internet : L'instance NLB utilise une adresse IP publique. Le nom de domaine de l'instance NLB est résolu vers l'adresse IP publique. Par conséquent, l'instance NLB est accessible via Internet. Intranet : L'instance NLB utilise une adresse IP privée. Le nom de domaine de l'instance NLB est résolu vers l'adresse IP privée. Par conséquent, l'instance NLB est accessible via le VPC où elle est déployée.
LoadBalancerStatus	String	Active	État de l'instance NLB. Valeurs possibles : Inactive : L'instance NLB est désactivée. Les écouteurs des instances NLB à l'état Inactive ne transfèrent pas le trafic. Active : L'instance NLB est en cours d'exécution. Provisioning : L'instance NLB est en cours de création. Configuring : L'instance NLB est en cours de modification. CreateFailed : Échec de la création de l'instance NLB. Dans ce cas, vous n'êtes pas facturé pour l'instance NLB. Vous pouvez uniquement supprimer l'instance NLB.
LoadBalancerBusinessStatus	String	Normal	État commercial de l'instance NLB. Valeurs possibles : Abnormal : L'instance NLB ne fonctionne pas comme prévu. Normal : L'instance NLB fonctionne comme prévu.
OperationLocks	Array of OperationLock		Liste des verrous appliqués aux instances NLB. Ce paramètre est renvoyé si `LoadBalancerBussinessStatus` est défini sur Abnormal.
LockType	String	SecurityLocked	Type de verrouillage. Valeurs possibles : SecurityLocked : L'instance NLB est verrouillée pour des raisons de sécurité. RelatedResourceLocked : L'instance NLB est verrouillée en raison de problèmes d'association. FinancialLocked : L'instance NLB est verrouillée en raison de paiements impayés. ResidualLocked : L'instance NLB est verrouillée car les paiements des ressources associées sont impayés et les ressources ont été libérées.
LockReason	String	Service exceptions.	Raison du verrouillage de l'instance NLB.
VpcId	String	vpc-bp1b49rqrybk45nio****	ID du VPC où l'instance NLB est déployée.
CreateTime	String	2022-07-02T02:49:05Z	Heure de création de la ressource. L'heure est affichée au format UTC `yyyy-MM-ddTHH:mm:ssZ`.
ResourceGroupId	String	rg-atstuj3rtop****	ID du groupe de ressources.
DNSName	String	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com	Nom de domaine de l'instance NLB.
ZoneMappings	Array of ZoneMapping		Liste des zones et des vSwitch dans ces zones. Vous devez spécifier entre 2 et 10 zones.
VSwitchId	String	vsw-bp1rmcrwg3erh1fh8****	ID du vSwitch dans la zone. Par défaut, vous ne pouvez spécifier qu'un seul vSwitch (sous-réseau) pour chaque zone d'une instance NLB.
ZoneId	String	cn-hangzhou-a	ID de la zone. Appelez l'opération DescribeZones pour interroger les zones.
LoadBalancerAddresses	Array of LoadBalancerAddress		Informations sur les adresses IP utilisées par l'instance NLB.
EniId	String	eni-bp12f1xhs5yal61a****	ID de l'interface réseau élastique (ENI).
PrivateIPv4Address	String	192.168.3.32	Adresse IPv4 privée de l'instance NLB.
AllocationId	String	eip-bp1aedxso6u80u0qf****	ID de l'adresse IP élastique (EIP).
PublicIPv4Address	String	120.XX.XX.69	Adresse IPv4 publique de l'instance NLB.
Ipv6Address	String	2001:db8:1:1:1:1:1:1	Adresse IPv6 de l'instance NLB.
BandwidthPackageId	String	cbwp-bp1vevu8h3ieh****	ID du plan de bande passante EIP associé à l'instance NLB orientée Internet.
SecurityGroupIds	Array of String	sg-bp10uag3q0jkxu72****	ID du groupe de sécurité associé à l'instance NLB.
CrossZoneEnabled	Boolean	true	Indique si l'équilibrage de charge inter-zones est activé pour l'instance NLB. Valeurs possibles : true : activé false : désactivé
LoadBalancerBillingConfig	Object		Configuration de la méthode de facturation.
PayType	String	PostPay	Méthode de facturation de l'instance NLB. Seule la valeur PostPay est prise en charge, ce qui indique la méthode de facturation à l'utilisation.
Cps	Integer	100	Nombre maximal de connexions pouvant être créées par seconde sur l'instance NLB. Valeurs possibles : 0 à 1000000. 0 indique que le nombre de connexions est illimité.
DeletionProtectionConfig	Object		Configuration de la fonctionnalité de protection contre la suppression.
Enabled	Boolean	true	Indique si la protection contre la suppression est activée. Valeurs possibles : true : activé false : désactivé
Reason	String	The instance is in the Running state.	Raison de l'activation ou de la désactivation de la fonctionnalité 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 tirets (-). La raison doit commencer par une lettre.
EnabledTime	String	2022-11-02T02:49:05Z	Heure d'activation de la protection contre la suppression. L'heure est affichée au format UTC `yyyy-MM-ddTHH:mm:ssZ`.
ModificationProtectionConfig	Object		Configuration du mode lecture seule pour la configuration.
Status	String	ConsoleProtection	Indique si le mode lecture seule pour la configuration est activé. Valeurs possibles : NonProtection : désactivé. Le paramètre Reason ne peut pas être défini. Si Reason est défini, la valeur est effacée. ConsoleProtection : activé. Dans ce cas, le paramètre Reason est renvoyé. Remarque Si ce paramètre est défini sur ConsoleProtection, vous ne pouvez pas modifier les configurations de l'instance dans la console NLB. Cependant, vous pouvez modifier les configurations de l'instance en appelant des opérations API.
Reason	String	Service guarantee period	Raison de l'activation du mode lecture seule pour la configuration. 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 tirets (-). La raison doit commencer par une lettre. Ce paramètre n'est valide que si le paramètre Status est défini sur ConsoleProtection.
EnabledTime	String	2022-12-02T02:49:05Z	Heure d'activation du mode lecture seule pour la configuration. L'heure est affichée au format UTC `yyyy-MM-ddTHH:mm:ssZ`.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=GetLoadBalancerAttribute
&LoadBalancerId=nlb-83ckzc8d4xlp8o****
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&Common request parameters

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetLoadBalancerAttributeResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <RegionId>cn-hangzhou</RegionId>
    <LoadBalancerId>nlb-83ckzc8d4xlp8o****</LoadBalancerId>
    <LoadBalancerName>NLB1</LoadBalancerName>
    <LoadBalancerType>network</LoadBalancerType>
    <AddressType>Internet</AddressType>
    <AddressIpVersion>ipv4</AddressIpVersion>
    <Ipv6AddressType>Internet</Ipv6AddressType>
    <LoadBalancerStatus>Active</LoadBalancerStatus>
    <LoadBalancerBusinessStatus>Normal</LoadBalancerBusinessStatus>
    <OperationLocks>
        <LockType>SecurityLocked</LockType>
        <LockReason>Service exception. </LockReason>
    </OperationLocks>
    <VpcId>vpc-bp1b49rqrybk45nio****</VpcId>
    <CreateTime>2022-07-02T02:49:05Z</CreateTime>
    <ResourceGroupId>rg-atstuj3rtop****</ResourceGroupId>
    <DNSName>nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com</DNSName>
    <ZoneMappings>
        <VSwitchId>vsw-bp1rmcrwg3erh1fh8****</VSwitchId>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <LoadBalancerAddresses>
            <EniId>eni-bp12f1xhs5yal61a****</EniId>
            <PrivateIPv4Address>192.168.3.32</PrivateIPv4Address>
            <AllocationId>eip-bp1aedxso6u80u0qf****</AllocationId>
            <PublicIPv4Address>120.XX.XX.69</PublicIPv4Address>
            <Ipv6Address>2001:db8:1:1:1:1:1:1</Ipv6Address>
        </LoadBalancerAddresses>
    </ZoneMappings>
    <BandwidthPackageId>cbwp-bp1vevu8h3ieh****</BandwidthPackageId>
    <SecurityGroupIds>sg-bp10uag3q0jkxu72****</SecurityGroupIds>
    <CrossZoneEnabled>true</CrossZoneEnabled>
    <LoadBalancerBillingConfig>
        <PayType>PostPay</PayType>
    </LoadBalancerBillingConfig>
    <Cps>100</Cps>
    <DeletionProtectionConfig>
        <Enabled>true</Enabled>
        <Reason>The instance is in the Running state.</Reason>
        <EnabledTime>2022-11-02T02:49:05Z</EnabledTime>
    </DeletionProtectionConfig>
    <ModificationProtectionConfig>
        <Status>ConsoleProtection</Status>
        <Reason>Service guarantee period</Reason>
        <EnabledTime>2022-12-02T02:49:05Z</EnabledTime>
    </ModificationProtectionConfig>
</GetLoadBalancerAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : "Service 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"
    } ]
  } ],
  "BandwidthPackageId" : "cbwp-bp1vevu8h3ieh****",
  "SecurityGroupIds" : [ "sg-bp10uag3q0jkxu72****" ],
  "CrossZoneEnabled" : true,
  "LoadBalancerBillingConfig" : {
    "PayType" : "PostPay"
  },
  "Cps" : 100,
  "DeletionProtectionConfig" : {
    "Enabled" : true,
    "Reason" : "The instance is in the Running state.",
    "EnabledTime" : "2022-11-02T02:49:05Z"
  },
  "ModificationProtectionConfig" : {
    "Status" : "ConsoleProtection",
    "Reason" : "Service guarantee period",
    "EnabledTime" : "2022-12-02T02:49:05Z"
  }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur de service.