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

Consulta os endereços IP elásticos (EIPs) criados em uma região especificada.

Descrição da operação

Esta operação consulta as informações sobre endereços IP elásticos (EIPs) criados em uma região especificada, incluindo a largura de banda de pico, o método de cobrança e o tipo de instância atualmente anexado. Se você pular páginas com frequência durante a paginação profunda, o código de erro Throttling.DeepPageSkip poderá ser retornado. Reduza a frequência de consulta ou use a paginação sequencial.

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:DescribeEipAddresses

list

*Address

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

vpc:tag

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.	cn-hangzhou
IncludeReservationData	boolean	Não	Especifica se deve incluir dados de assinatura inativos. Valores válidos: false (padrão): Não inclui dados de assinatura inativos. true: Inclui dados de assinatura inativos.	false
Status	string	Não	O status do EIP. Valores válidos: Associating: O EIP está sendo associado. Unassociating: O EIP está sendo desassociado. InUse: O EIP está alocado. Available: O EIP está disponível. Releasing: O EIP está sendo liberado.	Available
EipAddress	string	Não	O endereço IP do EIP a ser consultado. Você pode inserir até 50 endereços EIP. Separe vários endereços IP com vírgulas (,). Nota Se você especificar EipAddress e AllocationId, poderá inserir até 50 endereços EIP para EipAddress e até 50 IDs de instância EIP para AllocationId.	47.75.XX.XX
AllocationId	string	Não	O ID do EIP a ser consultado. Você pode inserir até 50 IDs de instância EIP. Separe vários IDs de instância com vírgulas (,). Nota Se você especificar EipAddress e AllocationId, poderá inserir até 50 IDs de instância EIP para AllocationId e até 50 endereços EIP para EipAddress.	eip-2zeerraiwb7ujxscd****
SegmentInstanceId	string	Não	O ID da instância do EIP contíguo.	eipsg-t4nr90yik5oy38xdy****
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o EIP pertence.	rg-acfmxazb4pcdvf****
PageNumber	integer	Não	O número da página da lista. Valor padrão: 1.	10
PageSize	integer	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	10
ISP	string	Não	O tipo de linha. Valores válidos: BGP (padrão): Linha BGP (multi-ISP). Os EIPs BGP (multi-ISP) são suportados em todas as regiões. BGP_PRO: Linha BGP (multi-ISP) Pro. Os EIPs BGP (multi-ISP) Pro são suportados apenas nas regiões de Hong Kong (China), Cingapura, Japão (Tóquio), Malásia (Kuala Lumpur), Filipinas (Manila), Indonésia (Jacarta) e Tailândia (Bangkok). Para obter mais informações sobre as linhas BGP (multi-ISP) e BGP (multi-ISP) Pro, consulte Tipos de linha de EIP. Se você for um usuário incluído na lista de permissões para largura de banda de ISP único, 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 Alibaba Finance Cloud na região da China (Hangzhou), este parâmetro é obrigatório. Defina o valor como BGP_FinanceCloud.	BGP
Filter.1.Key	string	Não	A chave de filtro usada ao consultar recursos. Defina o valor como CreationStartTime, que especifica a hora de início da criação do recurso.	CreationStartTime
Filter.2.Key	string	Não	A chave de filtro usada ao consultar recursos. Defina o valor como CreationEndTime, que especifica a hora de término da criação do recurso.	CreationEndTime
Filter.1.Value	string	Não	O valor de filtro usado ao consultar recursos. Especifique a hora em UTC no formato `YYYY-MM-DDThh:mmZ`.	2023-01-01T01:00Z
Filter.2.Value	string	Não	O valor de filtro usado ao consultar recursos. Especifique a hora em UTC no formato `YYYY-MM-DDThh:mmZ`.	2023-01-06T02:00Z
LockReason	string	Não	O tipo de bloqueio. Valores válidos: financial: O EIP está bloqueado devido a um pagamento em atraso. security: O EIP está bloqueado por motivos de segurança.	financial
AssociatedInstanceType	string	Não	O tipo de instância de serviço de nuvem a ser anexada ao EIP. Valores válidos: EcsInstance (padrão): uma instância ECS em uma VPC. SlbInstance: uma instância CLB em uma VPC. Nat: um gateway NAT. HaVip: um endereço IP virtual de alta disponibilidade. NetworkInterface: uma controladora de interface de rede elástica secundária (NIC). IpAddress: um endereço IP. Nota Você pode anexar apenas um EIP a cada instância ECS, instância CLB, endereço IP virtual de alta disponibilidade ou endereço IP por vez. Você pode anexar vários EIPs a um gateway NAT. O número de EIPs que podem ser anexados a uma controladora de interface de rede elástica secundária (NIC) depende do padrão de anexo do EIP. Para obter mais informações, consulte Visão geral dos endereços IP elásticos.	EcsInstance
AssociatedInstanceId	string	Não	O ID da instância do serviço de nuvem.	i-2zebb08phyccdvf****
ChargeType	string	Não	O método de cobrança do EIP. Valores válidos: PostPaid: pós-pago. PrePaid: assinatura.	PostPaid
DryRun	boolean	Não	Especifica se deve apenas pré-verificar a solicitação. Valores válidos: true: envia uma solicitação de verificação e não consulta o status do recurso. O sistema verifica se os parâmetros obrigatórios foram especificados, se o formato da solicitação é válido e se os limites do serviço foram atendidos. Se a solicitação falhar na verificação, o erro correspondente será retornado. Se a solicitação passar na verificação, o código de erro `DryRunOperation` será retornado. false (padrão): envia uma solicitação regular. Depois que a solicitação passar na verificação, o sistema retornará um código de status HTTP 2xx e executará a operação.	false
EipName	string	Não	O nome do EIP. O nome deve ter de 1 a 128 caracteres e deve começar com uma letra ou um caractere chinês. Pode conter dígitos, sublinhados (_) e hifens (-).	EIP-01
Tag	array<object>	Não	As tags usadas para filtrar EIPs.
	object	Não	As tags usadas para filtrar EIPs.
Key	string	Não	A chave da tag. Você pode inserir até 20 chaves de tag. Se você especificar este parâmetro, ele não poderá 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://`.	FinanceDept
Value	string	Não	O valor da tag. Você pode inserir até 20 valores de tag. Se você especificar este parâmetro, ele poderá ser uma string vazia. Um valor de tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	FinanceJoshua
SecurityProtectionEnabled	boolean	Não	Especifica se o Anti-DDoS (Enhanced) está ativado. Valores válidos: false: O Anti-DDoS (Enhanced) está desativado. true: O Anti-DDoS (Enhanced) está ativado.	false
PublicIpAddressPoolId	string	Não	O ID do pool de endereços IP ao qual o EIP a ser consultado pertence.	pippool-2vc0kxcedhquybdsz****
ServiceManaged	boolean	Não	Especifica se a instância é uma instância gerenciada. Valores válidos: true: A instância é uma instância gerenciada. false: A instância não é uma instância gerenciada. Se você não especificar este parâmetro, todas as instâncias serão consultadas por padrão.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A lista de informações retornadas.
PageSize	integer	O número de entradas por página.	10
RequestId	string	O ID da solicitação.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumber	integer	O número da página atual.	10
TotalCount	integer	O número total de entradas.	1
EipAddresses	object
EipAddress	array<object>	Os detalhes dos EIPs.
	array<object>	Os detalhes dos EIPs.
ReservationActiveTime	string	O período de vigência da renovação, no formato `YYYY-MM-DDThh:mm:ssZ`.	2021-05-23T16:00:00Z
Status	string	O status do EIP. Valores válidos: Associating: associando Unassociating: desassociando InUse: alocado Available: disponível Releasing: liberando	Available
ReservationOrderType	string	O tipo de pedido de renovação. Valores válidos: RENEWCHANGE: renovação com alteração de especificação TEMP_UPGRADE: upgrade temporário UPGRADE: upgrade	RENEWCHANGE
AllocationTime	string	A hora de criação do EIP, no formato `YYYY-MM-DDThh:mm:ssZ`.	2021-04-23T01:37:38Z
Netmode	string	O tipo de rede. Apenas public é retornado, o que indica a Internet.	public
ChargeType	string	O modelo de cobrança do EIP. Valores válidos: PostPaid: método de cobrança pay-as-you-go. PrePaid: assinatura.	PostPaid
Description	string	A descrição do EIP.	abc
Mode	string	O modo de associação. Valores válidos: NAT: modo NAT (modo normal) MULTI_BINDED: modo de múltiplos EIPs para ENI BINDED: modo de EIP para ENI	NAT
SegmentInstanceId	string	O ID da instância do EIP contíguo. Este parâmetro é retornado apenas quando o EIP é um EIP contíguo.	eipsg-t4nr90yik5oy38xd****
ReservationInternetChargeType	string	O tipo de cobrança da renovação. Valores válidos: PayByBandwidth: cobrança por largura de banda PayByTraffic: cobrança por transferência de dados	PayByBandwidth
BandwidthPackageId	string	O ID da instância do Internet Shared Bandwidth à qual o EIP está adicionado.	cbwp-bp1ego3i4j07ccdvf****
IpAddress	string	O endereço IP do EIP.	47.75.XX.XX
Bandwidth	string	A largura de banda máxima do EIP. Unidade: Mbit/s.	5
ReservationBandwidth	string	A largura de banda da renovação. Unidade: Mbit/s.	12
EipBandwidth	string	A largura de banda do EIP antes de ser adicionado a uma instância do Internet Shared Bandwidth ou após ser removido de uma instância do Internet Shared Bandwidth. Unidade: Mbit/s.	101
Name	string	O nome do EIP.	EIP-01
PrivateIpAddress	string	O endereço IP privado da instância da interface de rede elástica (NIC) secundária à qual o EIP está anexado.	192.168.XX.XX
InstanceRegionId	string	O ID da região do recurso associado.	cn-hangzhou
DeletionProtection	boolean	Indica se a proteção contra exclusão está ativada. Valores válidos: true: ativada false: desativada	true
InstanceId	string	O ID da instância associada.	i-bp15zckdt37cdvf****
SecondLimited	boolean	Indica se o limitador de largura de banda secundário está configurado. Valores válidos: true: configurado false: não configurado	false
InstanceType	string	O tipo da instância anexada. Valores válidos: EcsInstance: uma instância ECS em uma VPC SlbInstance: uma instância CLB em uma VPC Nat: um NAT gateway HaVip: um endereço IP virtual de alta disponibilidade NetworkInterface: uma interface de rede elástica (NIC) secundária IpAddress: um endereço IP	EcsInstance
HDMonitorStatus	string	Indica se o monitoramento em nível de segundo está ativado para o EIP. Valores válidos: false: desativado true: ativado	false
RegionId	string	O ID da região do EIP.	cn-hangzhou
BandwidthPackageBandwidth	string	A largura de banda da instância do Internet Shared Bandwidth à qual o EIP está adicionado. Unidade: Mbit/s.	50
ServiceManaged	integer	Indica se a instância é uma instância gerenciada. Valores válidos: 1: sim 0: não	0
ExpiredTime	string	O horário de expiração, no formato `YYYY-MM-DDThh:mm:ssZ`.	2021-05-23T02:00:00Z
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmxazcdxs****
AllocationId	string	O ID da instância do EIP.	eip-2zeerraiwb7ujcdvf****
InternetChargeType	string	O método de cobrança do EIP. Valores válidos: PayByBandwidth: cobrança por largura de banda PayByTraffic: cobrança por transferência de dados	PayByBandwidth
BusinessStatus	string	O status do serviço do EIP. Valores válidos: Normal: normal OperationLock: bloqueado Unactivated: não ativado	Normal
BandwidthPackageType	string	O tipo da largura de banda. Apenas CommonBandwidthPackage (Internet Shared Bandwidth) é retornado.	CommonBandwidthPackage
HasReservationData	string	Indica se existem dados de renovação. Valores válidos: false: não existem dados de renovação true: existem dados de renovação. Este valor é retornado apenas quando o parâmetro de solicitação IncludeReservationData é definido como true e existem dados de assinatura inativos.	false
ISP	string	O tipo de linha. Valores válidos: BGP: linha BGP (multi-ISP). Os EIPs de linhas BGP (multi-ISP) são suportados em todas as regiões. BGP_PRO: linha BGP (multi-ISP) Pro. Os EIPs de linhas BGP (multi-ISP) Pro são suportados apenas nas regiões de Hong Kong (China), Cingapura, Japão (Tóquio), Malásia (Kuala Lumpur), Filipinas (Manila), Indonésia (Jacarta) e Tailândia (Bangkok). Para obter mais informações sobre as linhas BGP (multi-ISP) e 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 de ISP único, os seguintes valores também poderão ser retornados: 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 Alibaba Finance Cloud na região da China (Hangzhou), BGP_FinanceCloud será retornado.	BGP
OperationLocks	object
LockReason	array<object>	Os detalhes do bloqueio.
	object	Os detalhes do bloqueio.
LockReason	string	O tipo de bloqueio. Valores válidos: financial: bloqueado devido a pagamentos em atraso security: bloqueado devido a motivos de segurança sharedPool: bloqueado devido a pagamentos em atraso do pool de endereços IP compartilhados	financial
Tags	object
Tag	array<object>	A lista de tags do EIP.
	object	A lista de tags do EIP.	"Tag": [ { "Value": "000", "Key": "yyy" }, { "Value": "111","Key": "kkk" }
Key	string	A chave da tag do EIP.	KeyTest
Value	string	O valor da tag do EIP.	ValueTest
SecurityProtectionTypes	object
SecurityProtectionType	array	O nível de proteção de segurança. Valores válidos: Um valor vazio indica o Anti-DDoS Basic. AntiDDoS_Enhanced: Anti-DDoS (Enhanced)
	string	O nível de proteção de segurança. Valores válidos: Um valor vazio indica o Anti-DDoS Basic. AntiDDoS_Enhanced: Anti-DDoS (Enhanced)	AntiDDoS_Enhanced
PublicIpAddressPoolId	string	O ID do pool de endereços IP ao qual o EIP pertence.	pippool-2vc0kxcedhquybdsz****
VpcId	string	O ID da VPC que tem o recurso de gateway IPv4 ativado e reside na mesma região que o EIP. Quando o EIP está anexado a um endereço IP, o sistema pode ativar o acesso à rede pública para o endereço IP anexado com base nas configurações de roteamento desta VPC. Nota Este parâmetro é retornado quando InstanceType é definido como IpAddress, o que significa que o EIP está anexado a um endereço IP.	vpc-bp15zckdt37pq72zv****
Zone	string	A zona do EIP. Este parâmetro é retornado apenas quando o tipo de serviço do EIP é CloudBox.	ap-southeast-1-lzdvn-cb
BizType	string	O tipo de serviço do EIP. Valores válidos: CloudBox: CloudBox. Este tipo é suportado apenas para usuários do CloudBox. Default: o valor padrão, que indica um tipo padrão.	CloudBox
ServiceID	integer	O ID da conta gerenciada para o serviço em nuvem.	18726XXXXXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "PageNumber": 10,
  "TotalCount": 1,
  "EipAddresses": {
    "EipAddress": [
      {
        "ReservationActiveTime": "2021-05-23T16:00:00Z",
        "Status": "Available",
        "ReservationOrderType": "RENEWCHANGE",
        "AllocationTime": "2021-04-23T01:37:38Z",
        "Netmode": "public",
        "ChargeType": "PostPaid",
        "Description": "abc",
        "Mode": "NAT",
        "SegmentInstanceId": "eipsg-t4nr90yik5oy38xd****",
        "ReservationInternetChargeType": "PayByBandwidth",
        "BandwidthPackageId": "cbwp-bp1ego3i4j07ccdvf****",
        "IpAddress": "47.75.XX.XX",
        "Bandwidth": "5",
        "ReservationBandwidth": "12",
        "EipBandwidth": "101",
        "Name": "EIP-01",
        "PrivateIpAddress": "192.168.XX.XX",
        "InstanceRegionId": " cn-hangzhou",
        "DeletionProtection": true,
        "InstanceId": "i-bp15zckdt37cdvf****",
        "SecondLimited": false,
        "InstanceType": "EcsInstance",
        "HDMonitorStatus": "false",
        "RegionId": "cn-hangzhou",
        "BandwidthPackageBandwidth": "50",
        "ServiceManaged": 0,
        "ExpiredTime": "2021-05-23T02:00:00Z",
        "ResourceGroupId": "rg-acfmxazcdxs****",
        "AllocationId": "eip-2zeerraiwb7ujcdvf****",
        "InternetChargeType": "PayByBandwidth",
        "BusinessStatus": "Normal",
        "BandwidthPackageType": "CommonBandwidthPackage",
        "HasReservationData": "false",
        "ISP": "BGP",
        "OperationLocks": {
          "LockReason": [
            {
              "LockReason": "financial"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "KeyTest",
              "Value": "ValueTest"
            }
          ]
        },
        "SecurityProtectionTypes": {
          "SecurityProtectionType": [
            "AntiDDoS_Enhanced"
          ]
        },
        "PublicIpAddressPoolId": "pippool-2vc0kxcedhquybdsz****",
        "VpcId": "vpc-bp15zckdt37pq72zv****",
        "Zone": "ap-southeast-1-lzdvn-cb",
        "BizType": "CloudBox",
        "ServiceID": 0
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidIAssociatedInstanceType.ValueNotSupported	The specified value of AssociatedInstanceType is not supported.	O valor de AssociatedInstanceType é inválido. Verifique se o parâmetro está correto.
400	InvalidChargeType.ValueNotSupported	The specified ChargeType is not supported.
400	InvalidAliuid	User Id is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	O ID do grupo de recursos não existe.
400	InstanceType.Invalid	InstanceType is not null
400	InstanceIdLength.Exceed	InstanceId length is exceed
400	InvalidTagKey	The tag keys are not valid.	O índice da tag é inválido.
400	InvalidTagValue	The tag values are not valid.	O valor da tag é inválido.
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.	A funcionalidade de grupo de recursos não está ativada.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	O parâmetro OwnerAccount especificado é inválido.
400	Throttling.DeepPageSkip	Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination.	O throttling é acionado porque o número de saltos de página na paginação profunda atingiu o limite. Reduza a frequência de saltos de página na paginação profunda ou use a paginação sequencial.
404	InvalidFilterValue	The specified FilterValue is not supported.
404	Forbidden.RegionNotFound	Specified region is not found during access authentication.
404	InvalidFilterKey.NotFound	The specified Filterkey is not supported.
404	InvalidLockReason.NotFound	The specified LockReason is not found

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.