Queries one or more Elastic IP addresses in a specified region.

Make the API call

You can use OpenAPI Explorer to make API calls, search for API calls, perform debugging, and generate SDK example code.

Request parameters

Parameter Type Required? Example value Description
Action String Yes DescribeEipAddresses

The name of this action. Value: DescribeEipAddresses
RegionId String Yes cn-hangzhou

The ID of the region to be queried. To query the region ID, call DescribeRegions.

IncludeReservationData Boolean No true

Indicates whether to return data of orders that have not taken effect. Valid values:

  • false (default): Do not include data of orders that have not taken effect in the returned result.
  • true: Include data of orders that have not taken effect in the returned result.
Status String No Available

The status of the Elastic IP address. Valid values:

  • Associating: The Elastic IP address is being associated with a cloud instance.
  • Unassociating: The Elastic IP address is being disassociated from a cloud instance.
  • InUse: The Elastic IP address is already allocated.
  • Available: The Elastic IP address is available.
EipAddress String No 116.xx.xx.28

The IP address of the Elastic IP address.

After this parameter is specified, you can view information about the specified Elastic IP address.

AllocationId String No eip-2zeerraiwb7ujxscd****

The ID of the Elastic IP address to be queried.

SegmentInstanceId String No eip-bp1utfpg4zlhyodba****

The instance ID of the consecutive Elastic IP address.
ResourceGroupId String No rg-acfmxazb4pcdvf****

The ID of the resource group to which the Elastic IP address belongs.
PageNumber Integer No 10

The page number. Default value: 1
PageSize Integer No 10

The number of entries per page in the case of a paged query result. Maximum value: 100. Default value: 10
ISP String No BGP

The service provider. Valid value: BGP.

Filter.1.Key String No CreationStartTime

The filter key used to query resources. The value must be CreationStartTime (Start time of resource creation).

Filter.2.Key String No CreationEndTime

The filter key used to query resources. The value must be CreationEndTime (End time of resource creation).

Filter.1.Value String No 2018-01-22T09:12Z

The filter value used to query resources. UTC time is used. Format: YYYY-MM-DDThh:mmZ
Filter.2.Value String No 2018-01-22T09:15Z

The filter value used to query resources. UTC time is used. Format: YYYY-MM-DDThh:mmZ
LockReason String No financial

The reason why the Elastic IP address is locked. Valid values:

  • financial: The Elastic IP address is locked due to overdue payments.
  • security: The Elastic IP address is locked for security reasons.
AssociatedInstanceType String No EcsInstance

The type of the cloud product instance to associate. Valid values:

  • EcsInstance (default): Elastic Compute Service (ECS) instance of the VPC network
  • SlbInstance: Server Load Balancer (SLB) instance of the VPC network
  • Nat: NAT Gateway
  • HaVip: High-Availability Virtual IP Address (HaVip)

  • NetworkInterface: Secondary Elastic Network Interface (ENI)

    Each ECS instance, SLB instance, and HaVip can only be associated with one Elastic IP address. One NAT Gateway can be associated with multiple Elastic IP addresses. The number of Elastic IP addresses that a secondary ENI can be associated with is affected by its Elastic IP address association mode. For more information, see Elastic IP Address overview.

AssociatedInstanceId String No i-2zebb08phyccdvf****

The ID of the cloud instance.

ChargeType String No PostPaid

The billing method of the Elastic IP address. Valid value:

PostPaid: Pay-as-you-go

Response parameters

Parameter Type Example value Description
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.
TotalCount Integer 10

The number of total entries.
PageNumber Integer 10

The current page number.
PageSize Integer 10

The number of entries per page.
EipAddresses Array

Details of Elastic IP addresses.
RegionId String cn-hangzhou

The ID of the region to which the Elastic IP address belongs.
IpAddress String 101.xx.xx.36

The IP address of the Elastic IP address.
AllocationId String eip-2zeerraiwb7ujcdvf****

The instance ID of the Elastic IP address.
Status String Associating

The status of the Elastic IP address.

  • Associating: The Elastic IP address is being associated with a cloud instance.
  • Unassociating: The Elastic IP address is being disassociated from a cloud instance.
  • InUse: The Elastic IP address is already allocated.
  • Available: The Elastic IP address is available.
InstanceId String i-bp15zckdt37cdvf****

The ID of the associated instance.
Bandwidth String 5

The peak bandwidth of the Elastic IP address. Unit: Mbit/s
EipBandwidth String 101

The bandwidth of the Elastic IP address before the Elastic IP address is added to or after the it is removed from the Internet Shared Bandwidth instance.

InternetChargeType String PayByBandwidth

The billing model of the Elastic IP address.

  • PayByBandwidth: Pay-by-bandwidth
  • PayByTraffic: Pay-by-data-transfer
AllocationTime String 2019-04-23T01:37:38Z

The time when the Elastic IP address was created.
InstanceType String EcsInstance

The type of the cloud instance that is associated with the Elastic IP address.

  • EcsInstance: ECS instance of the VPC network
  • SlbInstance: SLB instance of the VPC network
  • Nat: NAT Gateway
  • HaVip: HaVip
  • NetworkInterface: Secondary ENI
InstanceRegionId String cn-hangzhou

The region ID of the associated resource.
ChargeType String PostPaid

The billing method of the Elastic IP address. Valid values:

  • PrePaid: Subscription
  • Postpaid: Pay-as-you-go
ExpiredTime String 2019-04-29T02:00Z

The time when the Elastic IP address expires. This value follows the ISO 8601 standard and uses UTC time. Format: YYYY-MM-DDThh:mmZ.

HDMonitorStatus String false

Indicates whether high granularity monitoring is enabled for the Elastic IP address.

  • false: Disabled.
  • true: Enabled.
Name String test

The name of the Elastic IP address.
ISP String BGP

The service provider.
Descritpion String abc

The description of the Elastic IP address.
BandwidthPackageId String cbwp-bp1ego3i4j07ccdvf****

The ID of the Internet Shared Bandwidth instance to which the Elastic IP address is added.

BandwidthPackageType String CommonBandwidthPackage

The type of the bandwidth. Valid value: CommonBandwidthPackage (shared-bandwidth).

BandwidthPackageBandwidth String 50

The bandwidth of the Internet Shared Bandwidth to which the Elastic IP address is added.

ResourceGroupId String rg-acfmxazcdxs****

The ID of the resource group.
HasReservationData String false

Indicates whether renewal data is involved.

The value of this parameter is true only when the value of the parameter IncludeReservationData is true, and orders that have not taken effect exist.
ReservationBandwidth String 12

The bandwidth of the Elastic IP address after the renewal.
ReservationInternetChargeType String PayByBandwidth

The billing model of the renewal.

  • PayByBandwidth: Pay-by-bandwidth
  • PayByTraffic: Pay-by-data-transfer
ReservationActiveTime String 2019-03-11T16:00:00Z

The time when the renewal takes effect.
ReservationOrderType String RENEWCHANGE

The type of the renewal order. Valid values:

  • RENEWCHANGE: Change the specification.
  • TEMP_UPGRADE: Temporarily upgrade the Elastic IP address.
  • UPGRADE: Upgrade the Elastic IP address.
DeletionProtection Boolean true

Indicates whether deletion protection is enabled for the Elastic IP address.

  • true: Enabled.
  • false: Disabled.
SecondLimited Boolean false

Indicates whether level-2 speed limit is enabled.

  • true: Enabled.
  • false: Disabled.
SegmentInstanceId String eip-bp1utfpg4zlhyodba****

The instance ID of the consecutive Elastic IP address.

This parameter value is returned only when the Elastic IP address is a consecutive Elastic IP address.

OperationLocks Array

The reason why the Elastic IP address is locked.
LockReason String financial

The reason why the Elastic IP address is locked.

  • financial: The Elastic IP address is locked due to overdue payments.
  • security: The Elastic IP address is locked for security reasons.
AvailableRegions List cn-hangzhou

The ID of the region to which the Elastic IP address belongs.

Examples

Request example

https://vpc.aliyuncs.com/?Action=DescribeEipAddresses
&RegionId=cn-hangzhou
&<CommonParameters>

Response example

XML format 

<DescribeEipAddressesResponse>
  <PageNumber>1</PageNumber>
  <EipAddresses>
        <EipAddress>
              <HDMonitorStatus>OFF</HDMonitorStatus>
              <BandwidthPackageBandwidth>5</BandwidthPackageBandwidth>
              <HasReservationData>false</HasReservationData>
              <InstanceId>ngw-bp1kpih7t3izsxezx****</InstanceId>
              <ISP>BGP</ISP>
              <InternetChargeType>PayByBandwidth</InternetChargeType>
              <EipBandwidth>199</EipBandwidth>
              <BandwidthPackageType>CommonBandwidthPackage</BandwidthPackageType>
              <PrivateIpAddress></PrivateIpAddress>
              <SecondLimited>false</SecondLimited>
              <Bandwidth>5</Bandwidth>
              <ChargeType>PostPaid</ChargeType>
              <AllocationTime>2019-12-26T05:06:56Z</AllocationTime>
              <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
              <Descritpion>abc</Descritpion>
              <IpAddress>47.xx.xx.184</IpAddress>
              <AllocationId>eip-bp1utfpg4zlhyodba****</AllocationId>
              <Mode>NAT</Mode>
              <InstanceType>Nat</InstanceType>
              <Name>vmeixme</Name>
              <SegmentInstanceId></SegmentInstanceId>
              <Status>InUse</Status>
              <InstanceRegionId>cn-hangzhou</InstanceRegionId>
              <BandwidthPackageId>cbwp-bp1k042riiv5aqkkq****</BandwidthPackageId>
              <RegionId>cn-hangzhou</RegionId>
              <DeletionProtection>false</DeletionProtection>
              <OperationLocks>
        </OperationLocks>
              <ExpiredTime></ExpiredTime>
              <AvailableRegions>
                    <AvailableRegion>cn-hangzhou</AvailableRegion>
              </AvailableRegions>
        </EipAddress>
  </EipAddresses>
  <TotalCount>1</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>27CEB319-8242-46A8-B96B-998BCDF87D97</RequestId>
</DescribeEipAddressesResponse>

JSON format 

{
    "PageNumber": 1,
    "EipAddresses": {
        "EipAddress": [
            {
                "HDMonitorStatus": "OFF",
                "BandwidthPackageBandwidth": "5",
                "HasReservationData": false,
                "InstanceId": "ngw-bp1kpih7t3izsxezx****",
                "ISP": "BGP",
                "InternetChargeType": "PayByBandwidth",
                "EipBandwidth": "199",
                "BandwidthPackageType": "CommonBandwidthPackage",
                "PrivateIpAddress": "",
                "SecondLimited": false,
                "Bandwidth": "5",
                "ChargeType": "PostPaid",
                "AllocationTime": "2019-12-26T05:06:56Z",
                "ResourceGroupId": "rg-acfmxazb4ph****",
                "Descritpion": "abc",
                "IpAddress": "47.xx.xx.184",
                "AllocationId": "eip-bp1utfpg4zlhyodba****",
                "Mode": "NAT",
                "InstanceType": "Nat",
                "Name": "vmeixme",
                "SegmentInstanceId": "",
                "Status": "InUse",
                "InstanceRegionId": "cn-hangzhou",
                "BandwidthPackageId": "cbwp-bp1k042riiv5aqkkq****",
                "RegionId": "cn-hangzhou",
                "DeletionProtection": false,
                "OperationLocks": {
                    "LockReason": []
                },
                "ExpiredTime": "",
                "AvailableRegions": {
                    "AvailableRegion": [
                        "cn-hangzhou"
                    ]
                }
            }
        ]
    },
    "TotalCount": 1,
    "PageSize": 10,
    "RequestId": "27CEB319-8242-46A8-B96B-998BCDF87D97"
}

Errors

HTTP status code Error code Error message Description
404 Forbidden.RegionNotFound Specified region is not found during access authentication. The specified region does not exist.
404 InvalidFilterKey.NotFound The specified filter key is invalid.
404 InvalidFilterValue The specified filter value is invalid.
404 InvalidLockReason.NotFound The specified LockReason is not found The reason why the Elastic IP address is locked is unknown.
400 InvalidIAssociatedInstanceType.ValueNotSupported The specified value of AssociatedInstanceType is not supported. The specified value of AssociatedInstanceType is invalid.
400 InvalidChargeType.ValueNotSupported The specified ChargeType is not supported. The specified billing model is not supported.

For a list of error codes, visit the API Error Center.