GetLoadBalancerAttribute - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetLoadBalancerAttribute	Operação a ser executada. Defina o valor como GetLoadBalancerAttribute.
LoadBalancerId	String	Sim	nlb-83ckzc8d4xlp8o****	ID da instância NLB.
DryRun	Boolean	Não	false	Especifica se deve haver execução de simulação. Valores válidos: true: executa a simulação. O sistema verifica os parâmetros obrigatórios, a sintaxe da solicitação e os limites. Se a solicitação falhar na simulação, o sistema retorna um código de erro correspondente à causa da falha. Caso a solicitação passe na simulação, o sistema retorna o código de erro `DryRunOperation`. false: executa a simulação e envia a solicitação. Se a solicitação passar na simulação, o sistema retorna um código de status HTTP 2xx e executa a operação. Este é o valor padrão.
ClientToken	String	Não	123e4567-e89b-12d3-a456-426655440000	Token de cliente usado para garantir a idempotência da solicitação. Gere o valor por meio do cliente, mas garanta que ele seja único entre todas as solicitações. O valor de ClientToken contém apenas caracteres ASCII. Nota Se você não definir este parâmetro, o sistema usará automaticamente o valor de RequestId como ClientToken. O valor de RequestId difere em cada solicitação de API.
RegionId	String	Não	cn-hangzhou	ID da região onde a instância NLB está implantada. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	CEF72CEB-54B6-4AE8-B225-F876FF7BA984	ID da solicitação.
RegionId	String	cn-hangzhou	ID da região onde a instância NLB está implantada.
LoadBalancerId	String	nlb-83ckzc8d4xlp8o****	ID da instância NLB.
LoadBalancerName	String	NLB1	Nome da instância NLB. O nome deve ter de 2 a 128 caracteres e pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra.
LoadBalancerType	String	network	Tipo da instância. Apenas network é retornado, indicando uma instância NLB.
AddressType	String	Internet	Tipo de endereço IPv4 usado pela instância NLB. Valores válidos: Internet: a instância NLB usa um endereço IP público. O nome de domínio da instância NLB resolve para o endereço IP público, permitindo acesso pela Internet. Intranet: a instância NLB usa um endereço IP privado. O nome de domínio da instância NLB resolve para o endereço IP privado, permitindo acesso pela Virtual Private Cloud (VPC) onde ela está implantada.
AddressIpVersion	String	ipv4	Versão do protocolo. Valores válidos: ipv4: IPv4 DualStack: pilha dupla
Ipv6AddressType	String	Internet	Tipo de endereço IPv6 usado pela instância NLB. Valores válidos: Internet: a instância NLB usa um endereço IP público. O nome de domínio da instância NLB resolve para o endereço IP público, permitindo acesso pela Internet. Intranet: a instância NLB usa um endereço IP privado. O nome de domínio da instância NLB resolve para o endereço IP privado, permitindo acesso pela VPC onde ela está implantada.
LoadBalancerStatus	String	Active	Status da instância NLB. Valores válidos: Inactive: a instância NLB está desativada. Listeners de instâncias NLB no estado Inactive não encaminham tráfego. Active: a instância NLB está em execução. Provisioning: a instância NLB está sendo criada. Configuring: a instância NLB está sendo modificada. CreateFailed: falha ao criar a instância NLB. Nesse caso, não há cobrança pela instância NLB. Você só pode excluí-la.
LoadBalancerBusinessStatus	String	Normal	Status operacional da instância NLB. Valores válidos: Abnormal: a instância NLB não funciona conforme o esperado. Normal: a instância NLB funciona conforme o esperado.
OperationLocks	Array of OperationLock		Lista de bloqueios da instância NLB. Este parâmetro é retornado se `LoadBalancerBussinessStatus` estiver definido como Abnormal.
LockType	String	SecurityLocked	Tipo de bloqueio. Valores válidos: SecurityLocked: a instância NLB está bloqueada por motivos de segurança. RelatedResourceLocked: a instância NLB está bloqueada devido a problemas de associação. FinancialLocked: a instância NLB está bloqueada devido a pagamentos atrasados. ResidualLocked: a instância NLB está bloqueada porque os pagamentos dos recursos associados estão atrasados e os recursos foram liberados.
LockReason	String	Exceções de serviço.	Motivo do bloqueio da instância NLB.
VpcId	String	vpc-bp1b49rqrybk45nio****	ID da VPC onde a instância NLB está implantada.
CreateTime	String	2022-07-02T02:49:05Z	Horário de criação do recurso. Exibido em UTC no formato `yyyy-MM-ddTHH:mm:ssZ`.
ResourceGroupId	String	rg-atstuj3rtop****	ID do grupo de recursos.
DNSName	String	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com	Nome de domínio da instância NLB.
ZoneMappings	Array of ZoneMapping		Lista de zonas e vSwitches nessas zonas. Especifique de 2 a 10 zonas.
VSwitchId	String	vsw-bp1rmcrwg3erh1fh8****	ID do vSwitch na zona. Por padrão, especifique apenas um vSwitch (sub-rede) para cada zona de uma instância NLB.
ZoneId	String	cn-hangzhou-a	ID da zona. Chame a operação DescribeZones para consultar as zonas.
LoadBalancerAddresses	Array of LoadBalancerAddress		Informações sobre os endereços IP usados pela instância NLB.
EniId	String	eni-bp12f1xhs5yal61a****	ID da elastic network interface (ENI).
PrivateIPv4Address	String	192.168.3.32	Endereço IPv4 privado da instância NLB.
AllocationId	String	eip-bp1aedxso6u80u0qf****	ID do elastic IP address (EIP).
PublicIPv4Address	String	120.XX.XX.69	Endereço IPv4 público da instância NLB.
Ipv6Address	String	2001:db8:1:1:1:1:1:1	Endereço IPv6 da instância NLB.
BandwidthPackageId	String	cbwp-bp1vevu8h3ieh****	ID do plano de largura de banda EIP associado à instância NLB voltada para a Internet.
SecurityGroupIds	Array of String	sg-bp10uag3q0jkxu72****	ID do grupo de segurança associado à instância NLB.
CrossZoneEnabled	Boolean	true	Indica se o balanceamento de carga entre zonas está ativado para a instância NLB. Valores válidos: true: ativado false: desativado
LoadBalancerBillingConfig	Object		Configuração do método de faturamento.
PayType	String	PostPay	Método de faturamento da instância NLB. Apenas PostPay é suportado, indicando o método de pagamento conforme o uso.
Cps	Integer	100	Número máximo de conexões criáveis por segundo na instância NLB. Valores válidos: 0 a 1000000. 0 indica número ilimitado de conexões.
DeletionProtectionConfig	Object		Configuração do recurso de proteção contra exclusão.
Enabled	Boolean	true	Indica se a proteção contra exclusão está ativada. Valores válidos: true: ativada false: desativada
Reason	String	A instância está no estado Running.	Motivo da ativação ou desativação da proteção contra exclusão. O motivo deve ter de 2 a 128 caracteres e pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra.
EnabledTime	String	2022-11-02T02:49:05Z	Horário de ativação da proteção contra exclusão. Exibido em UTC no formato `yyyy-MM-ddTHH:mm:ssZ`.
ModificationProtectionConfig	Object		Configuração do modo somente leitura de configuração.
Status	String	ConsoleProtection	Indica se o modo somente leitura de configuração está ativado. Valores válidos: NonProtection: desativado. Não é possível definir o parâmetro Reason. Se Reason estiver definido, o valor será limpo. ConsoleProtection: ativado. Neste caso, o parâmetro Reason é retornado. Nota Se este parâmetro estiver definido como ConsoleProtection, não será possível modificar as configurações da instância no console NLB. No entanto, é possível modificar as configurações da instância chamando operações de API.
Reason	String	Período de garantia de serviço	Motivo da ativação do modo somente leitura de configuração. O motivo deve ter de 2 a 128 caracteres e pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra. Este parâmetro é válido apenas se o parâmetro Status estiver definido como ConsoleProtection.
EnabledTime	String	2022-12-02T02:49:05Z	Horário de ativação do modo somente leitura de configuração. Exibido em UTC no formato `yyyy-MM-ddTHH:mm:ssZ`.

Exemplos

Solicitações de exemplo

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

Respostas de sucesso de exemplo

Formato XML

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>

Formato JSON

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"
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro de serviço.