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

Observações de uso

Ao criar uma instância NLB, o sistema cria e atribui automaticamente a função vinculada ao serviço AliyunServiceRoleForNlb a você.
A operação CreateLoadBalancer é assíncrona. Após o envio da solicitação, o sistema retorna um ID de instância e executa a tarefa em segundo plano. Para consultar o status de uma instância NLB, chame a operação GetLoadBalancerAttribute.
- Se a instância NLB estiver no estado Provisioning, ela está sendo criada.
- Se a instância NLB estiver no estado Active, a criação foi concluída com sucesso.

Depuração

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	CreateLoadBalancer	A operação a ser executada. Defina o valor como CreateLoadBalancer.
LoadBalancerType	String	Não	network	O tipo da instância. Defina o valor como network, que especifica uma instância NLB.
LoadBalancerName	String	Não	NLB1	O nome da instância NLB. O valor deve ter de 2 a 128 caracteres e pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra.
AddressType	String	Sim	Internet	O 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 apenas por meio da Virtual Private Cloud (VPC) onde a instância está implantada. Nota Para ativar o IPv6 público em uma instância NLB dual-stack, chame a operação EnableLoadBalancerIpv6Internet.
AddressIpVersion	String	Não	ipv4	A versão do protocolo. Valores válidos: ipv4: IPv4. Este é o valor padrão. DualStack: pilha dupla
VpcId	String	Sim	vpc-bp1b49rqrybk45nio****	O ID da VPC onde a instância NLB está implantada.
ZoneMappings.N.VSwitchId	String	Sim	vsw-sersdf****	O vSwitch na zona. Especifique apenas um vSwitch (sub-rede) por zona em uma instância NLB. Adicione pelo menos duas zonas. O limite máximo é de 10 zonas.
ZoneMappings.N.ZoneId	String	Sim	cn-hangzhou-a	O ID da zona da instância NLB. Adicione pelo menos duas zonas. O limite máximo é de 10 zonas. Chame a operação DescribeZones para consultar a lista de zonas mais recente.
ZoneMappings.N.PrivateIPv4Address	String	Não	192.168.10.1	O endereço IP privado. Adicione pelo menos duas zonas. O limite máximo é de 10 zonas.
ZoneMappings.N.AllocationId	String	Não	eip-bp1aedxso6u80u0qf****	O ID do Elastic IP Address (EIP) associado à instância NLB voltada para a Internet. Especifique um EIP para cada zona. Adicione pelo menos duas zonas. O limite máximo é de 10 zonas.
BandwidthPackageId	String	Não	cbwp-bp1vevu8h3ieh****	O ID do plano de largura de banda de EIP associado à instância NLB voltada para a Internet.
LoadBalancerBillingConfig.PayType	String	Não	PostPay	O método de faturamento da instância NLB. Defina o valor como PostPay, que especifica o método de pagamento conforme o uso.
ResourceGroupId	String	Não	rg-atstuj3rtop****	O ID do grupo de recursos.
DryRun	Boolean	Não	false	Indica se deve ser executada uma simulação (dry run). Valores válidos: true: executa uma 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 retornará uma mensagem de erro. Se passar, o sistema retornará o código de erro `DryRunOperation`. false: executa uma simulação e envia a solicitação. Se a solicitação passar na simulação, o sistema retornará um código de status HTTP 2xx e executará a operação. Este é o valor padrão.
ClientToken	String	Não	123e4567-e89b-12d3-a456-426655440000	O token do cliente usado para garantir a idempotência da solicitação. Use o cliente para gerar o valor, 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 valor de ClientToken. O valor de RequestId é diferente para cada solicitação de API.
RegionId	String	Não	cn-hangzhou	O 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.
DeletionProtectionConfig.Enabled	Boolean	Não	false	Indica se a proteção contra exclusão deve ser ativada. Valores válidos: true: sim false (padrão): não
DeletionProtectionConfig.Reason	String	Não	The instance is in the Running state.	O motivo para ativar ou desativar a proteção contra exclusão. O valor deve ter de 2 a 128 caracteres e pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra.
ModificationProtectionConfig.Status	String	Não	ConsoleProtection	Indica se o modo somente leitura de configuração deve ser ativado. Valores válidos: NonProtection: não ativa o modo somente leitura de configuração. Não é possível definir o parâmetro Reason. Caso esteja definido, o valor será limpo. ConsoleProtection: ativa o modo somente leitura de configuração. É possível definir o parâmetro Reason. Nota Se você definir este parâmetro como ConsoleProtection, não poderá modificar as configurações da instância no console NLB. No entanto, ainda é possível modificá-las chamando operações de API.
ModificationProtectionConfig.Reason	String	Não	Service guarantee period	O motivo para ativar o modo somente leitura de configuração. O valor deve ter de 2 a 128 caracteres e pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-). Deve começar com uma letra. Nota Este parâmetro só tem efeito quando Status está definido como ConsoleProtection.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	CEF72CEB-54B6-4AE8-B225-F876FF7BA984	O ID da solicitação.
LoadbalancerId	String	nlb-83ckzc8d4xlp8o****	O ID da instância NLB.
OrderId	Long	20230000	O ID do pedido da instância NLB.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=CreateLoadBalancer
&LoadBalancerType=network
&LoadBalancerName=NLB1
&AddressType=Internet
&AddressIpVersion=ipv4
&VpcId=vpc-bp1b49rqrybk45nio****
&ZoneMappings=[{"VSwitchId":"vsw-sersdf****","ZoneId":"cn-hangzhou-a","PrivateIPv4Address":"192.168.10.1","AllocationId":"eip-bp1aedxso6u80u0qf****"}]
&BandwidthPackageId=cbwp-bp1vevu8h3ieh****
&LoadBalancerBillingConfig={"PayType":"PostPay"}
&ResourceGroupId=rg-atstuj3rtop****
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&DeletionProtectionConfig={"Enabled":false,"Reason":"The instance is in the Running state."}
&ModificationProtectionConfig={"Status":"ConsoleProtection","Reason":"Service guarantee period"}
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<CreateLoadBalancerResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <LoadbalancerId>nlb-83ckzc8d4xlp8o****</LoadbalancerId>
    <OrderId>20230000</OrderId>
</CreateLoadBalancerResponse>

Formato JSON

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

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "LoadbalancerId" : "nlb-83ckzc8d4xlp8o****",
  "OrderId" : 20230000
}

Códigos de erro

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