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

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

Descrição da operação

Esta operação consulta informações sobre EIPs criados em uma região especificada, incluindo a largura de banda máxima, o método de cobrança e o tipo de instância atualmente associada a cada EIP. Se você realizar paginação profunda ou salto de páginas com frequência, o código de erro Throttling.DeepPageSkip poderá ser retornado. Reduza a frequência de consulta ou use 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.	cn-hangzhou
IncludeReservationData	boolean	Não	Especifica se devem ser incluídos dados de assinatura que ainda não entraram em vigor. Valores válidos:	false
Status	string	Não	O status do EIP. Valores válidos:	Available
EipAddress	string	Não	O endereço IP do EIP a ser consultado.	47.75.XX.XX
AllocationId	string	Não	O ID da instância do EIP a ser consultado.	eip-2zeerraiwb7ujxscd****
SegmentInstanceId	string	Não	O ID da instância do grupo de EIPs contíguos.	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 em uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	10
ISP	string	Não	O tipo de linha. Valores válidos:	BGP
Filter.1.Key	string	Não	A chave de filtro para consultar recursos. O valor deve ser CreationStartTime, que especifica a hora de início da criação do recurso.	CreationStartTime
Filter.2.Key	string	Não	A chave de filtro para consultar recursos. O valor deve ser CreationEndTime, que especifica a hora de término da criação do recurso.	CreationEndTime
Filter.1.Value	string	Não	O valor do filtro para consultar recursos. Especifique o valor em UTC no formato `YYYY-MM-DDThh:mmZ`.	2023-01-01T01:00Z
Filter.2.Value	string	Não	O valor do filtro para consultar recursos. Especifique o valor em UTC no formato `YYYY-MM-DDThh:mmZ`.	2023-01-06T02:00Z
LockReason	string	Não	O tipo de bloqueio. Valores válidos:	financial
AssociatedInstanceType	string	Não	O tipo da instância de recurso de nuvem a ser associado. Valores válidos:	EcsInstance
AssociatedInstanceId	string	Não	O ID da instância do recurso de nuvem.	i-2zebb08phyccdvf****
ChargeType	string	Não	O método de cobrança do EIP. Valores válidos:	PostPaid
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run. Valores válidos:	false
EipName	string	Não	O nome do EIP.	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 especificar até 20 chaves de tag. A chave da tag não pode ser uma string vazia.	FinanceDept
Value	string	Não	O valor da tag. Você pode especificar até 20 valores de tag. O valor da tag pode ser uma string vazia.	FinanceJoshua
SecurityProtectionEnabled	boolean	Não	Especifica se o Anti-DDoS (Enhanced) está ativado. Valores válidos:	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:	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 do EIP.
	array<object>	Os detalhes do EIP.
ReservationActiveTime	string	A hora de ativação da renovação no formato `YYYY-MM-DDThh:mm:ssZ`.	2021-05-23T16:00:00Z
Status	string	O status do EIP.	Available
ReservationOrderType	string	O tipo de pedido de renovação.	RENEWCHANGE
AllocationTime	string	A hora em que o EIP foi criado no formato `YYYY-MM-DDThh:mm:ssZ`.	2021-04-23T01:37:38Z
Netmode	string	O tipo de rede. O valor é public, que indica a Internet.	public
ChargeType	string	O método de cobrança do EIP. Valores válidos:	PostPaid
Description	string	A descrição do EIP.	abc
Mode	string	O modo de associação. Valores válidos:	NAT
SegmentInstanceId	string	O ID da instância do grupo de EIPs contíguos.	eipsg-t4nr90yik5oy38xd****
ReservationInternetChargeType	string	O tipo de cobrança de renovação.	PayByBandwidth
BandwidthPackageId	string	O ID da instância de Largura de Banda Compartilhada da Internet à qual o EIP foi adicionado.	cbwp-bp1ego3i4j07ccdvf****
IpAddress	string	O endereço IP do EIP.	47.75.XX.XX
Bandwidth	string	A largura de banda de pico do EIP. Unidade: Mbps.	5
ReservationBandwidth	string	A largura de banda de renovação. Unidade: Mbps.	12
EipBandwidth	string	A largura de banda do EIP antes de ser adicionado ou após ser removido de uma instância de Largura de Banda Compartilhada da Internet. Unidade: Mbps.	101
Name	string	O nome do EIP.	EIP-01
PrivateIpAddress	string	O endereço IP privado da instância secundária de controlador de interface de rede elástica (NIC) à qual o EIP está anexado.	192.168.XX.XX
InstanceRegionId	string	O ID da região do recurso que está atualmente associado ao EIP.	cn-hangzhou
DeletionProtection	boolean	Indica se a proteção contra exclusão está ativada.	true
InstanceId	string	O ID da instância que está atualmente associada ao EIP.	i-bp15zckdt37cdvf****
SecondLimited	boolean	Indica se o limitador de largura de banda secundário está configurado.	false
InstanceType	string	O tipo da instância que está atualmente associada ao EIP.	EcsInstance
HDMonitorStatus	string	Indica se o monitoramento de nível de segundo está ativado para o EIP.	false
RegionId	string	O ID da região do EIP.	cn-hangzhou
BandwidthPackageBandwidth	string	A largura de banda da instância de Largura de Banda Compartilhada da Internet à qual o EIP foi adicionado. Unidade: Mbps.	50
ServiceManaged	integer	Especifica se a instância é uma instância gerenciada. Valores válidos:	0
ExpiredTime	string	A hora 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.	PayByBandwidth
BusinessStatus	string	O status comercial da instância do EIP.	Normal
BandwidthPackageType	string	O tipo de largura de banda. Apenas CommonBandwidthPackage (Largura de Banda Compartilhada da Internet) é retornado.	CommonBandwidthPackage
HasReservationData	string	Indica se existem dados de renovação.	false
ISP	string	O tipo de linha.	BGP
OperationLocks	object
LockReason	array<object>	Os detalhes do bloqueio.
	object	Os detalhes do bloqueio.
LockReason	string	O tipo de bloqueio.	financial
Tags	object
Tag	array<object>	A lista de tags associadas ao EIP.
	object	A lista de tags associadas ao 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.
	string	O nível de proteção de segurança.	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 está na mesma região que o EIP.	vpc-bp15zckdt37pq72zv****
Zone	string	A zona do EIP.	ap-southeast-1-lzdvn-cb
BizType	string	O tipo de negócio do EIP.	CloudBox
ServiceID	integer	O ID da conta gerenciada do 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 este 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 operação não é suportada. IDs de grupo de recursos não são suportados no Finance Cloud.
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.	A frequência de saltos de página na paginação profunda acionou o limitador. 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.