Queries elastic IP addresses (EIPs) created in a specific region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeEipAddresses

The operation that you want to perform. Set the value to DescribeEipAddresses.

RegionId String Yes cn-hangzhou

The region ID of the EIP. You can call the DescribeRegions operation to query the most recent region list.

IncludeReservationData Boolean No true

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

  • false: does not return orders that have not taken effect This is the default value.
  • true: Data of orders that have not taken effect is returned.
Status String No Available

The state of the EIP. Valid values:

  • Associating: The EIP is being associated with an instance.
  • Unassociating: The EIP is being disassociated from an instance.
  • InUse: The EIP is associated with an instance.
  • Available: The EIP is available.
EipAddress String No 116.XX.XX.28

The IP address of the EIP that you want to query.

You can enter the IP addresses of up to 50 EIPs. Separate multiple IP addresses with commas (,).

Note If both the EipAddress and AllocationId parameters are set, you can enter the IP addresses of 50 EIPs in EipAddress, and enter the IDs of the 50 EIPs in AllocationId.
AllocationId String No eip-2zeerraiwb7ujxscd****

The ID of the EIP that you want to query.

You can enter IDs of up to 50 EIPs. Separate multiple IDs with commas (,).

Note If both the EipAddress and AllocationId parameters are set, you can enter the IDs of up to 50 EIPs in AllocationId, and enter the IP addresses of 50 EIPs in,EipAddress.
SegmentInstanceId String No eipsg-t4nr90yik5oy38xdy****

The IDs of contiguous EIPs.

ResourceGroupId String No rg-acfmxazb4pcdvf****

The ID of the resource group to which the EIPs belongs.

PageNumber Integer No 10

The number of the page to return, default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 100. Default value: 10.

ISP String No BGP

The type of lines. Valid values:

  • BGP: BGP (Multi-ISP) lines.

    Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet service providers (ISPs), including China Telecom, China Unicom, China Mobile, China Tietong Telecom, China Netcom, CERNET, China Broadcast Network, Dr. Peng Group, and Founder, can be established in all regions in mainland China.

  • BGP_PRO: BGP (Multi-ISP) Pro lines.

    BGP (Multi-ISP) Pro lines optimize data transmission to China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro lines provide services to users in mainland China (excluding data centers), cross-border connections are established by using mainland China ISP services. This reduces network latency.

BGP (Multi-ISP) lines are supported in all regions. BGP (Multi-ISP) Pro lines are supported only in the China (Hong Kong) region.

Note If your account is included in the BGP (single line) whitelist, you can set the ISP parameter to ChinaTelecom, ChinaUnicom, or ChinaMobile. If your workloads are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.
Filter.1.Key String No CreationStartTime

The filter key used to query resources. Set the value to CreationStartTime (the start time when resources are created).

Filter.2.Key String No CreationEndTime

The filter key used to query resources. Set the value to CreationEndTime (the end time when resources are created).

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

The filter value used to query resources. Specify the time in the ISO 8601 standard in YYYY-MM-ddTHH:mmZ format. The time must be in UTC.

Filter.2.Value String No 2018-01-22T09:15Z

The filter value used to query resources. Specify the time in the ISO 8601 standard in YYYY-MM-ddTHH:mmZ format. The time must be in UTC.

LockReason String No financial

The reason why the EIP 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 resource with which you want to associate the EIP. Valid values:

  • EcsInstance: an Elastic Compute Service instance in a Virtual Private Cloud. This is the default value.
  • SlbInstance: an Server Load Balancer instance in a VPC.
  • Nat: a NAT gateway.
  • HaVip: a high-availability virtual IP address (HAVIP).

  • NetworkInterface: a secondary elastic network interface (ENI).

    You can associate only one EIP with each ECS instance, SLB instance, or HAVIP. You can associate multiple EIPs with each NAT gateway. The number of EIPs that you can associate with a secondary ENI depends on the EIP mode. For more information, see EIP overview.

AssociatedInstanceId String No i-2zebb08phyccdvf****

The ID of the instance.

ChargeType String No PostPaid

The billing method of the EIP. Set the value to:

Set the value to: PostPaid: pay-as-you-go.

DryRun Boolean No false

Specifies whether to precheck only this request. Valid values:

  • true: prechecks the API request. Resources are not queried. The system checks whether the AccessKey pair is valid, whether the RAM user is authorized, and whether the required parameters are specified. If the check fails, the corresponding error is returned. If the check succeeds, the DryRunOperation error code is returned.
  • false: The request is checked. This is the default value. If the request passes the precheck, a 2xx HTTP status code is returned and the resource is queried.
EipName String No EIP-01

The name of the EIP.

The name must be 1 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

Response parameters

Parameter Type Example Description
EipAddresses Array of EipAddress

The details about the EIP.

EipAddress
AllocationId String eip-2zeerraiwb7ujcdvf****

The ID of the EIP.

AllocationTime String 2019-04-23T01:37:38Z

The time when the EIP was created.

AvailableRegions List cn-hangzhou

The ID of the region to which the EIP belongs.

Bandwidth String 5

The bandwidth limit of the EIP. Unit: Mbit/s.

BandwidthPackageBandwidth String 50

The bandwidth limit of the EIP bandwidth plan with which the EIP is associated.

BandwidthPackageId String cbwp-bp1ego3i4j07ccdvf****

The ID of the-EIP bandwidth plan.

BandwidthPackageType String CommonBandwidthPackage

The type of the bandwidth.plan Only CommonBandwidthPackage (EIP Bandwidth Plan) is returned.

BusinessStatus String Normal

The state of the EIP. Valid values:

  • Normal: normal.
  • FinancialLocked: locked.
ChargeType String PostPaid

The billing method of the EIP. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
DeletionProtection Boolean true

Indicates whether deletion protection is enabled. Valid values:

  • true: enabled.
  • false: disabled.
Descritpion String abc

The description of the EIP.

EipBandwidth String 101

The bandwidth of the EIP when it is not associated with an EIP bandwidth plan.

ExpiredTime String 2019-04-29T02:00Z

The expiration date. The time follows the ISO 8601 standard and is displayed in UTC. Format: YYYY-MM-ddTHH:mmZ.

HDMonitorStatus String false

Indicates whether fine-grained monitoring is enabled for the EIP. Valid values:

  • false: disabled.
  • true: enabled.
HasReservationData String false

Indicates whether renewal data is included.

This parameter returns true only when the parameter IncludeReservationData is set to true, and some orders have not taken effect.

ISP String BGP

ISP

InstanceId String i-bp15zckdt37cdvf****

The ID of the instance with which the EIP is associated.

InstanceRegionId String cn-hangzhou

The region ID of the associated resource.

InstanceType String EcsInstance

The type of the instance associated with the EIP.

  • EcsInstance: an ECS instance in a VPC
  • SlbInstance: an SLB instance in a VPC
  • Nat: a NAT gateway.
  • HaVip: a high-availability virtual IP address.
  • NetworkInterface: a secondary ENI.
InternetChargeType String PayByBandwidth

The metering method of the EIP. Valid values:

  • PayByBandwidth
  • PayByTraffic
IpAddress String 116.XX.XX.28

The IP address of the EIP.

Name String test

The name of the EIP.

Netmode String public

The type of the network.

OperationLocks Array of LockReason

The details about the locked EIP.

LockReason
LockReason String financial

The reason why the EIP is locked. Valid values:

  • financial: The EIP is locked due to overdue payments.
  • security: The EIP is locked for security reasons.
RegionId String cn-hangzhou

The ID of the region to which the EIP belongs.

ReservationActiveTime String 2019-03-11T16:00:00Z

The time when the renewal takes effect.

ReservationBandwidth String 12

The bandwidth after the renewal takes effect.

ReservationInternetChargeType String PayByBandwidth

The metering method of the renewal. Valid values:

  • PayByBandwidth
  • PayByTraffic
ReservationOrderType String RENEWCHANGE

The type of the renewal order. Valid values:

  • RENEWCHANGE: upgrade or downgrade
  • TEMP_UPGRADE: temporary upgrade
  • UPGRADE: upgrade.
ResourceGroupId String rg-acfmxazcdxs****

The ID of the resource group to which the EIP belongs.

SecondLimited Boolean false

Indicates whether level-2 throttling is configured.

  • true: yes
  • false: no
SegmentInstanceId String eipsg-t4nr90yik5oy38xd****

The IDs of the contiguous EIPs.

This value is returned only when contiguous EIPs are specified.

ServiceManaged Integer 0

Indicates whether the resource is created by the service account. Valid values:

  • 0: no
  • 1: yes
Status String Associating

The status of the Elastic IP address.

  • Associating: The EIP is being associated with an instance.
  • Unassociating: The EIP is being disassociated from an instance.
  • InUse: The EIP is associated with an instance.
  • Available: The EIP is available.
TotalCount Integer 10

The total number of entries returned.

PageNumber Integer 10

The number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

Samples

Sample requests

http(s)://[Endpoint]/?Action=DescribeEipAddresses
&RegionId=cn-hangzhou
&<Common request parameters>|

Sample success responses

XML format 

<DescribeEipAddressesResponse>
  <TotalCount>10</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
  <EipAddresses>
        <EipAddress>
              <HDMonitorStatus>false</HDMonitorStatus>
              <ServiceManaged>0</ServiceManaged>
              <ResourceGroupId>rg-acfmxazcdxs****</ResourceGroupId>
              <AllocationId>eip-2zeerraiwb7ujcdvf****</AllocationId>
              <SecondLimited>false</SecondLimited>
              <BusinessStatus>Normal</BusinessStatus>
              <Name>test</Name>
              <SegmentInstanceId>eipsg-t4nr90yik5oy38xd****</SegmentInstanceId>
              <ReservationOrderType>RENEWCHANGE</ReservationOrderType>
              <InstanceRegionId> cn-hangzhou</InstanceRegionId>
              <ExpiredTime>2019-04-29T02:00Z</ExpiredTime>
              <Bandwidth>5</Bandwidth>
              <BandwidthPackageId>cbwp-bp1ego3i4j07ccdvf****</BandwidthPackageId>
              <ReservationActiveTime>2019-03-11T16:00:00Z</ReservationActiveTime>
              <InstanceType>EcsInstance</InstanceType>
              <ReservationBandwidth>12</ReservationBandwidth>
              <Status>Associating</Status>
              <InstanceId>i-bp15zckdt37cdvf****</InstanceId>
              <ISP>BGP</ISP>
              <HasReservationData>false</HasReservationData>
              <DeletionProtection>true</DeletionProtection>
              <BandwidthPackageType>CommonBandwidthPackage</BandwidthPackageType>
              <BandwidthPackageBandwidth>50</BandwidthPackageBandwidth>
              <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
              <InternetChargeType>PayByBandwidth</InternetChargeType>
              <AllocationTime>2019-04-23T01:37:38Z</AllocationTime>
              <Descritpion>abc</Descritpion>
              <EipBandwidth>101</EipBandwidth>
              <Netmode>public</Netmode>
              <ChargeType>PostPaid</ChargeType>
              <IpAddress>116.XX.XX.28</IpAddress>
              <RegionId>cn-hangzhou</RegionId>
              <OperationLocks>
                    <LockReason>
                          <LockReason>financial</LockReason>
                    </LockReason>
              </OperationLocks>
              <AvailableRegions>
                    <AvailableRegion>cn-hangzhou</AvailableRegion>
              </AvailableRegions>
        </EipAddress>
  </EipAddresses>
  <PageNumber>10</PageNumber>
</DescribeEipAddressesResponse>

JSON format 

{
    "TotalCount": 10,
    "PageSize": 10,
    "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
    "EipAddresses": {
        "EipAddress": {
            "HDMonitorStatus": false,
            "ServiceManaged": 0,
            "ResourceGroupId": "rg-acfmxazcdxs****",
            "AllocationId": "eip-2zeerraiwb7ujcdvf****",
            "SecondLimited": false,
            "BusinessStatus": "Normal",
            "Name": "test",
            "SegmentInstanceId": "eipsg-t4nr90yik5oy38xd****",
            "ReservationOrderType": "RENEWCHANGE",
            "InstanceRegionId": "cn-hangzhou",
            "ExpiredTime": "2019-04-29T02:00Z",
            "Bandwidth": 5,
            "BandwidthPackageId": "cbwp-bp1ego3i4j07ccdvf****",
            "ReservationActiveTime": "2019-03-11T16:00:00Z",
            "InstanceType": "EcsInstance",
            "ReservationBandwidth": 12,
            "Status": "Associating",
            "InstanceId": "i-bp15zckdt37cdvf****",
            "ISP": "BGP",
            "HasReservationData": false,
            "DeletionProtection": true,
            "BandwidthPackageType": "CommonBandwidthPackage",
            "BandwidthPackageBandwidth": 50,
            "ReservationInternetChargeType": "PayByBandwidth",
            "InternetChargeType": "PayByBandwidth",
            "AllocationTime": "2019-04-23T01:37:38Z",
            "Descritpion": "abc",
            "EipBandwidth": 101,
            "Netmode": "public",
            "ChargeType": "PostPaid",
            "IpAddress": "116.XX.XX.28",
            "RegionId": "cn-hangzhou",
            "OperationLocks": {
                "LockReason": {
                    "LockReason": "financial"
                }
            },
            "AvailableRegions": {
                "AvailableRegion": "cn-hangzhou"
            }
        }
    },
    "PageNumber": 10
}

Error codes

HttpCode Error codes Error message Description
404 Forbidden.RegionNotFound Specified region is not found during access authentication. The error message returned because the specified region does not exist. Check whether the region is correct.
404 InvalidLockReason.NotFound The specified LockReason is not found The error message returned because the reason why the EIP is locked is unknown.
400 InvalidIAssociatedInstanceType.ValueNotSupported The specified value of AssociatedInstanceType is not supported. The error message returned because AssociatedInstanceType is set to an invalid value. Check whether the value is valid.
400 InvalidChargeType.ValueNotSupported The specified ChargeType is not supported. The error message returned because the specified billing method is not supported. Select a supported billing method.
400 InvalidResourceGroupId The specified ResourceGroupId does not exist. The error message returned because the specified resource group ID is invalid.
400 OperationUnsupported.ResourceGroupId ResourceGroup is not supported in this region. The error message returned because the resource group feature is not enabled.

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