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

Cria uma instância de Network Load Balancer (NLB) em uma região especificada.

Descrição da operação

Ao criar uma instância NLB, a função vinculada ao serviço AliyunServiceRoleForNlb é automaticamente criada e atribuída a você.
CreateLoadBalancer é uma operação assíncrona. Depois que você envia uma solicitação, o sistema retorna um ID de instância e executa a tarefa em segundo plano. Você pode chamar GetLoadBalancerAttribute para consultar o status de uma instância NLB.
- Se uma instância NLB estiver no estado Provisioning, a instância NLB está sendo criada.
- Se uma instância NLB estiver no estado Active, a instância NLB está criada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

nlb:CreateLoadBalancer

create

*LoadBalancer

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

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

EipAddress

acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

nlb:AddressType

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
LoadBalancerType	string	Não	O tipo da instância do Server Load Balancer (SLB). Defina o valor como network, que indica uma instância NLB.	network
LoadBalancerName	string	Não	O nome da instância NLB. Deve ter de 2 a 128 caracteres, pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-), e deve começar com uma letra.	NLB1
AddressType	string	Sim	O tipo de endereços IPv4 usados para a instância NLB. Valores válidos: Internet: os nós de uma instância NLB voltada para a Internet possuem endereços IP públicos. O nome DNS de uma instância NLB voltada para a Internet pode ser resolvido publicamente para os endereços IP públicos dos nós. Portanto, as instâncias NLB voltadas para a Internet podem rotear solicitações de clientes pela Internet. Intranet: os nós de uma instância NLB voltada para a rede interna possuem apenas endereços IP privados. O nome DNS de uma instância NLB voltada para a rede interna pode ser resolvido publicamente para os endereços IP privados dos nós. Portanto, as instâncias NLB voltadas para a rede interna podem rotear solicitações apenas de clientes com acesso à virtual private cloud (VPC) da instância NLB. Nota Para ativar um endereço IPv6 público para uma instância NLB de pilha dupla, chame a operação EnableLoadBalancerIpv6Internet.	Internet
AddressIpVersion	string	Não	A versão dos endereços IP usados para a instância NLB. Valores válidos: ipv4 (padrão) DualStack	ipv4
VpcId	string	Sim	O ID da VPC onde você deseja criar a instância NLB.	vpc-bp1b49rqrybk45nio****
ZoneMappings	array<object>	Sim	Os mapeamentos entre zonas e vSwitches. Uma instância NLB pode ser implantada em até 10 zonas. Se a região oferecer suporte a duas ou mais zonas, você deverá especificar pelo menos duas zonas.
	object	Não	O mapeamento entre a zona e o vSwitch. Uma instância NLB pode ser implantada em até 10 zonas. Se a região oferecer suporte a duas ou mais zonas, você deverá especificar pelo menos duas zonas.
VSwitchId	string	Sim	O ID do vSwitch na zona. Você pode especificar apenas um vSwitch (sub-rede) em cada zona de uma instância NLB. Uma instância NLB pode ser implantada em até 10 zonas. Se a região oferecer suporte a duas ou mais zonas, você deverá especificar pelo menos duas zonas.	vsw-sersdf****
ZoneId	string	Sim	O ID da zona onde a instância NLB está implantada. Uma instância NLB pode ser implantada em até 10 zonas. Se a região oferecer suporte a duas ou mais zonas, especifique pelo menos duas zonas. Você pode chamar a operação DescribeZones para consultar a lista de zonas mais recente.	cn-hangzhou-a
PrivateIPv4Address	string	Não	O endereço IP virtual (VIP) privado da versão IPv4. O endereço IPv4 privado que a instância NLB usa para fornecer serviços externos.	192.168.10.1
AllocationId	string	Não	O ID do elastic IP (EIP) associado à instância NLB voltada para a Internet. Cada zona recebe um EIP. Uma instância NLB pode ser implantada em até 10 zonas. Se a região oferecer suporte a duas ou mais zonas, especifique pelo menos duas zonas.	eip-bp1aedxso6u80u0qf****
Ipv6Address	string	Não	O VIP da versão IPv6. O endereço IPv6 que a instância NLB usa para fornecer serviços externos.	2408:400a:d5:3080:b409:840a:ca:e8e5
Ipv4LocalAddresses	array	Não	Os endereços IPv4 locais. Os endereços IP que a instância NLB usa para se comunicar com os servidores de back-end. O número de endereços IP deve ser um número par, que deve ser no mínimo 2 e no máximo 8.
	string	Não	O endereço IPv4 local.	192.168.10.2
Ipv6LocalAddresses	array	Não	Os endereços IPv6 locais. Os endereços IP que a instância NLB usa para se comunicar com os servidores de back-end. O número de endereços IP deve ser um número par, que deve ser no mínimo 2 e no máximo 8.
	string	Não	O endereço IPv6 local.	2408:400a:d5:3080:b409:840a:ca:e8e6
BandwidthPackageId	string	Não	O ID da instância de Internet Shared Bandwidth associada à instância NLB voltada para a Internet.	cbwp-bp1vevu8h3ieh****
LoadBalancerBillingConfig	object	Não	As configurações de faturamento da instância NLB.
PayType	string	Não	O método de faturamento da instância NLB. Defina o valor como PostPay, que especifica o método de faturamento pay-as-you-go.	PostPay
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual a instância pertence.	rg-atstuj3rtop****
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run sem realmente fazer a solicitação. Valores válidos: true: realiza apenas um dry run. O sistema verifica a solicitação quanto a possíveis problemas, incluindo valores de parâmetros ausentes, sintaxe de solicitação incorreta e limites de serviço. Se a solicitação falhar na verificação, uma mensagem de erro especificando o problema é retornada. Se a solicitação for aprovada, o código de erro `DryRunOperation` é retornado. false (padrão): verifica a solicitação e executa a operação. Se a solicitação passar na verificação, um código de status HTTP 2xx é retornado e a operação é executada.	false
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token. Certifique-se de que o token seja único entre diferentes solicitações. Apenas caracteres ASCII são permitidos. Nota Se você não especificar este parâmetro, o valor de RequestId será usado.** O valor de RequestId** é diferente para cada solicitação.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Não	O ID da região onde a instância NLB está implantada. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
DeletionProtectionConfig	object	Não	A configuração do recurso de proteção contra exclusão.
Enabled	boolean	Não	Especifica se o recurso de proteção contra exclusão deve ser ativado. Valores válidos: true false (padrão)	false
Reason	string	Não	O motivo pelo qual o recurso de proteção contra exclusão está ativado ou desativado. O motivo deve ter de 2 a 128 caracteres, pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-), e deve começar com uma letra.	Instance is running
ModificationProtectionConfig	object	Não	A configuração do modo de somente leitura de configuração.
Status	string	Não	Especifica se o modo de somente leitura de configuração deve ser ativado. Valores válidos: NonProtection: não ativa o modo de somente leitura de configuração. Você não pode definir o parâmetro Reason. Se o parâmetro Reason estiver definido, o valor será limpo. ConsoleProtection: ativa o modo de somente leitura de configuração. Você pode definir o parâmetro Reason. Nota Se o parâmetro estiver definido como ConsoleProtection, o modo de somente leitura de configuração será ativado. Você não pode modificar as configurações da instância NLB no console do NLB. No entanto, você pode chamar operações de API para modificar as configurações da instância NLB.	ConsoleProtection
Reason	string	Não	O motivo para ativar o modo de somente leitura de configuração. O motivo deve ter de 2 a 128 caracteres, pode conter letras, dígitos, pontos (.), sublinhados (_) e hifens (-), e deve começar com uma letra. Nota Este parâmetro entra em vigor apenas quando Status está definido como ConsoleProtection.	Business protection period
Tag	array<object>	Não	As tags.
	object	Não	A tag.
Key	string	Não	A chave da tag. A chave da tag pode ter até 64 caracteres, não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`. A chave da tag pode conter letras, dígitos e os seguintes caracteres especiais: _ . : / = + - @ Você pode especificar até 20 tags em cada chamada.	env
Value	string	Não	O valor da tag. O valor da tag pode ter até 128 caracteres, não pode começar com `acs:` ou `aliyun` e não pode conter `http://` ou `https://`. O valor da tag pode conter letras, dígitos e os seguintes caracteres especiais: _ . : / = + - @ Você pode especificar até 20 tags em cada chamada.	product

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Resposta.
RequestId	string	O ID da solicitação.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
LoadbalancerId	string	O ID da instância NLB.	nlb-83ckzc8d4xlp8o****
OrderId	integer	O ID do pedido da instância NLB.	20230000

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	OperationDenied.OnlyPayByTrafficSupported	The operation is not allowed because of OnlyPayByTrafficSupported.
400	OperationFailed.%s	The operation failed because of %s.	Failed to call the API operation due to %.
400	Mismatch.ZoneIdAndVswitchId	The ZoneIdAndVswitchId is mismatched for %s and %s.
400	QuotaExceeded.%s	The quota of %s is exceeded, usage %s/%s.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Request validation has been passed with DryRun flag set.
400	OperationDenied.OnlyPostPaidSupported	The operation is not allowed because of OnlyPostPaidSupported.
400	OperationFailed.DuplicateZones.	The operation failed because of Can not Specify duplicate zones.
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.	The specified virtual switch (vSwitch) IP resources are insufficient.
400	DuplicatedParam.AllocationId	The param of AllocationId is duplicated.
400	ResourceInConfiguring.VswitchId	The specified resource of VswitchId is being configured, please try again later.	The specified resource of VswitchId is being configured, please try again later.
400	IllegalParam	The param of %s is illegal.
400	OperationFailed.UnpaidBill	The operation failed because of UnpaidBill.
400	OperationDenied.ServiceLinkedRoleNotExist	The operation is not allowed because of ServiceLinkedRoleNotExist.	The operation is not allowed because of ServiceLinkedRoleNotExist.Please check if the necessary permissions are granted in RAM for the NLB.
400	ResourceAlreadyAssociated.AllocationId	The specified resource of %s is already associated.
400	OperationFailed.vSwitchNotSupportIpv6	The operation failed because of vSwitchNotSupportIpv6.
400	InvalidZones	The current zone list is illegal.	The Availability Zone used in Zone maping is illegal.
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.	The quota is insufficient, currently used %s/%s. Please modify the quota size in the quota center.
400	ResourceInUse.IP	The specified resource of IP is in use.
400	OperationFailed.CreateOrderError	Operation failed because CreateOrderError.	The operation failed because the order creation failed.
400	OperationFailed.NotExist.ResourceGroup	Operation failed because ResourceGroup not exist.	The specified resource group does not exist.
400	IllegalParam.loadBalancerName	Param loadBalancerName is illegal.	The instance name is invalid. Check the parameters.
400	SystemBusy	System is busy, please try again later.
400	MissingParam.%s	The parameter of %s is missing.
400	IllegalParam.DeletionProtectionConfig	DeletionProtectionConfig reason is illegal.	The reason parameter for changing the delete protection status is invalid.
400	IllegalParam.ModificationProtectionConfig	ModificationProtectionConfig reason is illegal.	ModificationProtectionConfig reason is illegal.
400	Throttling.User	Request was denied due to api flow control.	Request was denied due to api flow control.
403	UnauthorizedZone	The specified zone of %s is not authorized.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.
403	UnauthorizedRegion	The specified region of %s is not authorized.
404	ResourceNotFound.VSwitch	The specified resource of vSwitch is not found.	The specified vSwitch resource was not found. Please check the input parameters.
404	ResourceNotFound.Vpc	The specified resource of Vpc is not found.	The specified VPC resource was not found. Please check the input parameters.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.