AllocateEipAddress - Elastic IP Address: Central de Documentação do Alibaba Cloud

Solicita um elastic IP address (EIP).

Descrição da operação

Certifique-se de estar familiarizado com os métodos de cobrança e preços dos EIPs antes de chamar esta operação. Para mais informações, consulte Visão geral da cobrança.

Após a chamada desta operação, um EIP no estado Available é alocado aleatoriamente na região especificada. Os EIPs suportam apenas ICMP, TCP e UDP na camada de transporte. IGMP e SCTP não são suportados.

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

vpc:AllocateEipAddress

create

*Address.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do EIP. Você pode chamar a operação DescribeRegions para consultar o ID da região. Valores válidos: cn-beijing : cn-beijing.	cn-hangzhou
Bandwidth	string	Não	A largura de banda máxima do EIP. Unidade: Mbit/s. Se InstanceChargeType estiver definido como PostPaid e InternetChargeType estiver definido como PayByBandwidth, os valores válidos de Bandwidth são de 1 a 500. Se InstanceChargeType estiver definido como PostPaid e InternetChargeType estiver definido como PayByTraffic, os valores válidos de Bandwidth são de 1 a 200. Se InstanceChargeType estiver definido como PrePaid, os valores válidos de Bandwidth são de 1 a 1000. Valor padrão: 5 Mbit/s.	5
Period	integer	Não	A duração da assinatura. Se PricingCycle estiver definido como Month, os valores válidos de Period são de 1 a 9. Se PricingCycle estiver definido como Year, os valores válidos de Period são de 1 a 5. Este parâmetro é obrigatório se InstanceChargeType estiver definido como PrePaid. Este parâmetro não é obrigatório se InstanceChargeType estiver definido como PostPaid.	1
ISP	string	Não	O tipo de linha. Valores válidos: BGP (padrão): Linha BGP (multi-ISP). Todas as regiões suportam EIPs de linha BGP (multi-ISP). BGP_PRO: Linha BGP (multi-ISP) Pro. Apenas as seguintes regiões suportam EIPs de linha BGP (multi-ISP) Pro: Hong Kong (China), Singapura, Japão (Tóquio), Malásia (Kuala Lumpur), Filipinas (Manila), Indonésia (Jacarta) e Tailândia (Bangkok). Para mais informações sobre linhas BGP (multi-ISP) e linhas BGP (multi-ISP) Pro, consulte Tipos de linha de EIP. Se você for um usuário da lista de permissões de largura de banda single-ISP, também poderá selecionar os seguintes tipos: ChinaTelecom: China Telecom ChinaUnicom: China Unicom ChinaMobile: China Mobile ChinaTelecom_L2: China Telecom L2 ChinaUnicom_L2: China Unicom L2 ChinaMobile_L2: China Mobile L2 Se você for um usuário do Finance Cloud da China (Hangzhou), este campo é obrigatório. Defina o valor como BGP_FinanceCloud.	BGP
ActivityId	integer	Não	O ID da atividade especial. Você não precisa configurar este parâmetro.	123456
Netmode	string	Não	O tipo de rede. O valor é definido como public (padrão), que especifica a rede pública.	public
AutoPay	boolean	Não	Especifica se o pagamento automático deve ser ativado. Valores válidos: false (padrão): O pagamento automático está desativado. Após a geração de um pedido, acesse o Centro de Pedidos para concluir o pagamento. true: O pagamento automático está ativado. O pedido é pago automaticamente. Este parâmetro é obrigatório se InstanceChargeType estiver definido como PrePaid. Este parâmetro é opcional se InstanceChargeType estiver definido como PostPaid.	false
PricingCycle	string	Não	O ciclo de cobrança da assinatura. Valores válidos: Month (padrão): Cobrança mensal. Year: Cobrança anual. Este parâmetro é obrigatório se InstanceChargeType estiver definido como PrePaid. Este parâmetro é opcional se InstanceChargeType estiver definido como PostPaid.	Month
InstanceChargeType	string	Não	O método de cobrança do EIP. Valores válidos: PrePaid: Assinatura. PostPaid (padrão): Pay-as-you-go. Se InstanceChargeType estiver definido como PrePaid, InternetChargeType deve ser definido como PayByBandwidth. Se InstanceChargeType estiver definido como PostPaid, InternetChargeType pode ser definido como PayByBandwidth ou PayByTraffic.	PostPaid
InternetChargeType	string	Não	O método de medição do EIP. Valores válidos: PayByBandwidth (padrão): Pagamento por largura de banda. PayByTraffic: Pagamento por transferência de dados. Se InstanceChargeType estiver definido como PrePaid, InternetChargeType deve ser definido como PayByBandwidth. Se InstanceChargeType estiver definido como PostPaid, InternetChargeType pode ser definido como PayByBandwidth ou PayByTraffic.	PayByTraffic
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmxazffggds****
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Gere um valor a partir do seu cliente para garantir a unicidade entre diferentes solicitações. ClientToken suporta apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usa o RequestId da solicitação de API como o ClientToken. O RequestId pode ser diferente para cada solicitação de API.	0c593ea1-3bea-11e9-b96b-88e9fe637760
Name	string	Não	O nome da instância do EIP. O nome deve ter de 0 a 128 caracteres e não pode começar com `http://` ou `https://`. Nota Este parâmetro não é suportado quando você cria uma instância de EIP por assinatura.	EIP1
Description	string	Não	A descrição da instância do EIP. A descrição deve ter de 0 a 256 caracteres e não pode começar com `http://` ou `https://`. Nota Este parâmetro não é suportado quando você cria uma instância de EIP por assinatura.	test
SecurityProtectionTypes	array	Não	O nível de proteção de segurança. Se este parâmetro for deixado vazio, o valor padrão é Anti-DDoS Basic. Se este parâmetro for definido como AntiDDoS_Enhanced, o valor indica Anti-DDoS (Enhanced). Você pode especificar no máximo um nível de proteção de segurança.	AntiDDoS_Enhanced
	string	Não	O nível de proteção de segurança. Se este parâmetro for deixado vazio, o valor padrão é Anti-DDoS Basic. Se este parâmetro for definido como AntiDDoS_Enhanced, o valor indica Anti-DDoS (Enhanced).	AntiDDoS_Enhanced
PublicIpAddressPoolId	string	Não	O ID do pool de endereços IP. O EIP é alocado a partir do pool de endereços IP especificado. O recurso de pool de endereços IP não está habilitado por padrão. Para usar este recurso, solicite a cota de privilégio de pool de endereços IP no Centro de Cotas. Para mais informações, consulte Aumentar uma cota no Centro de Cotas.	pippool-2vc0kxcedhquybdsz****
Zone	string	Não	A zona do EIP. Se o pool de endereços IP especificado por PublicIpAddressPoolId for do tipo CloudBox, este parâmetro assume como padrão a zona do pool de endereços IP. Para obter informações sobre como visualizar o tipo de negócio de um pool de endereços IP, consulte ListPublicIpAddressPools.	ap-southeast-1-lzdvn-cb
IpAddress	string	Não	O endereço IP do EIP que você deseja solicitar. Você precisa especificar apenas um entre IpAddress e InstanceId. Se nenhum for especificado, o sistema aloca um EIP aleatoriamente.	192.0.XX.XX
InstanceId	string	Não	O ID da instância do EIP que você deseja solicitar. Você precisa especificar apenas um entre IpAddress e InstanceId. Se nenhum for especificado, o sistema aloca um EIP aleatoriamente.	eip-25877c70gddh****
Tag	array<object>	Não	As tags do recurso.
	object	Não
Key	string	Não	A chave da tag do recurso. Você pode especificar até 20 chaves de tag. A chave da tag não pode ser uma string vazia. Uma chave de tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	TestKey
Value	string	Não	O valor da tag. Especifique o valor no formato Tag.N.Value. Valores válidos de N: 1 a 20. O valor da tag não pode ser uma string vazia. O valor da tag pode ter até 128 caracteres. Não pode começar com aliyun ou acs: e não pode conter http:// ou https://.	FinanceJoshua

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
OrderId	integer	O ID do pedido. Este parâmetro é retornado se InstanceChargeType (o método de cobrança do EIP) estiver definido como PrePaid (assinatura). Se AutoPay (pagamento automático) não estiver ativado, acesse o Centro de Pedidos para concluir o pagamento.	10
ResourceGroupId	string	O ID do grupo de recursos. Este parâmetro é retornado apenas se InstanceChargeType estiver definido como PostPaid.	rg-acfmxazfdgdg****
EipAddress	string	O EIP alocado. Este parâmetro é retornado apenas se InstanceChargeType estiver definido como PostPaid.	192.0.XX.XX
AllocationId	string	O ID da instância do EIP.	eip-25877c70gddh****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "OrderId": 10,
  "ResourceGroupId": "rg-acfmxazfdgdg****",
  "EipAddress": "192.0.XX.XX",
  "AllocationId": "eip-25877c70gddh****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	QuotaExceeded.Eip	Elastic IP address quota exceeded
400	InsufficientBalance	Your account does not have enough balance.
400	InvalidParameter	Specified value of "InternetChargeType" is not valid
400	ReserveIpFail	Reserve eip failed.
400	InvalidRegion.NotSupport	The specified region does not support.
400	InvalidBandwidth.Malformed	The specified Bandwidth is invalid.
400	INSTANCE_TYPE_NOT_SUPPORT	The instance type is invalid.
400	QueryParameter.Illegal	query parameter illegal
400	QuotaExceeded.LargeSpecEip	Elastic IP address with large spec quota exceeded.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	O ID do grupo de recursos não existe.
400	OperationFailed.InsufficientEIP	Eip resource is not enough.
400	FrequentPurchase.EIP	eip frequent purchase
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	O parâmetro OwnerAccount especificado é inválido.
400	ResourceNotFound.PublicIpAddressPool	The specified resource of PublicIpAddressPool is not found.
400	ResourceNotEnough.PublicIpAddressPool	The specified resource of PublicIpAddressPool is not enough.
400	Mismatch.IpAndPublicIpAddressPool	The Ip and PublicIpAddressPool are mismatched.
400	OperationDenied.NotOpenDdosOriginProtectService	The operation is not allowed because of you do not open Ddos Origin Protection Service	O EIP com Anti-DDoS (Enhanced) ativado não pode ser criado porque o serviço Anti-DDoS Origin não foi adquirido.
400	IncorrectStatus.PublicIpAddressPool	The status of PublicIpAddressPool is incorrect.	O EIP não pode ser alocado porque o status do pool de endereços IP é inválido.
400	IllegalParam.Isp	The param of %s is illegal.	O EIP não pode ser alocado porque o parâmetro ISP é inválido.
400	ExclusiveParam.ZoneAndPublicIpAddressPoolId	The Zone and PublicIpAddressPoolId parameters are mutually exclusive.	Os parâmetros Zone e PublicIpAddressPoolId não podem ser especificados ao mesmo tempo.
400	IllegalParam.Zone	The specified zone is invalid.	O parâmetro Zone é inválido.
400	OperationFailed.AllocateUnfamiliarIp	The operation failed because only IP addresses used within the last seven days can be allocated.	A solicitação de EIP especificada permite apenas solicitar um endereço IP que foi usado nos últimos 7 dias.
400	Ip.Allocated	The reserve ip has been allocated.	O endereço IP reservado já foi atribuído.
400	IncorrectStatus.Ip	The status of ip is incorrect.	O endereço IP está em um estado incorreto.
400	UnsupportedFeature.AllocateEipAddressWithZone	The feature of AllocateEipAddressWithZone is not supported.	A zona especificada não suporta a criação de instâncias na região atual.
400	ResourceNotFound.Ip	The specified ip is not found.	O endereço IP especificado não foi encontrado.
400	OperationFailed.ResourceNotEnough	The resources you have applied for are insufficient.	Os recursos solicitados são insuficientes. Para continuar a solicitação, abra um ticket.
400	IllegalParam.Bandwidth	The param of bandwidth is illegal.	A largura de banda especificada é inválida.
400	OperationFailed.IpIsLocked	The operation is failed because of ip is locked.	A solicitação falhou porque o endereço IP está bloqueado.
400	Mismatch.EipSecurityProtectionTypeAndPoolSecurityProtectionType	The EipSecurityProtectionType and PoolSecurityProtectionType are mismatched.	O tipo de proteção de segurança do EIP não corresponde ao tipo de proteção de segurança do pool de endereços.
400	IllegalParam.SecurityProtectionTypes	The param of securityProtectionTypes is illegal.	O parâmetro SecurityProtectionTypes especificado é inválido.
400	IllegalParam.ServiceLocation	The param of serviceLocation is illegal.	O parâmetro ServiceLocation é inválido.
400	UnsupportedFeature.Isp	The feature of Isp is not supported.	O ISP especificado não é suportado.
400	ExclusiveParam.ZoneAndIpAddress	The specified param Zone and IpAddress or InstanceId are mutually exclusive.	O parâmetro Zone especificado entra em conflito com o parâmetro IpAddress ou InstanceId.
400	InvalidDescription.Malformed	The Description is illeagl.	O formato da descrição do recurso especificado é inválido. A descrição deve ter de 2 a 256 caracteres e não pode começar com http:// ou https://.
400	InvalidName.Malformed	The attribute name is illegal.	O formato do nome especificado é inválido.
400	OperationFailed.UpgradeCdtServiceFirst	The operation is failed because of cdt is not upgraded.	O tipo de instância que você especificou requer uma atualização de cobrança do Cloud Data Transfer (CDT). Atualize o CDT e tente novamente.
400	OperationFailed.TokenExpired	The operation is failed because of TokenExpired.	O token de alocação de EIP especificado expirou.
400	QuotaExceeded.LocalISPBasicEip	The quota for Local ISP Provider EIP has been exceeded.	A cota de EIP do LocalISPBasic foi excedida.
400	QuotaExceeded.LocalISPEip	The quota for Local ISP EIPs has been exceeded.	A cota do LocalISP foi excedida.
403	Forbidden	User not authorized to operate on the specified resource.	Você não tem permissão para operar no recurso especificado. Solicite a permissão necessária e tente novamente.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.