Basic Network(UNet)

Obtain Elastic IP Information - DescribeEIP


Obtain Elastic IP Information


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeEIP.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in.No
EIPIds.NstringIf the resource ID of the Elastic IP is empty, return all EIPs in the current Region that meet the conditions.No
OffsetintData offset, default is 0No
LimitintData pagination value, default is 20No
IPs.NstringIP address, supports query by IP. If both IP and EIP are passed, the query will take the union set.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
TotalCountintTotal number of eligible Elastic IPsNo
UnbindCountintTotal number of unbound Elastic IPsNo
TotalBandwidthintTotal bandwidth of eligible Elastic IPs, unit in MbpsNo
EIPSetarray[UnetEIPSet]Elastic IP List, see UnetEIPSet for each parameter details.No

Data Model


Field NameTypeDescription InformationRequired
EIPIdstringElastic IP Resource IDNo
WeightintEgress weight of the public network, default is 50, range [0-100]No
BandwidthTypeintBandwidth Mode, enumeration values are: 0: Non-shared bandwidth mode, 1: Shared bandwidth modeNo
BandwidthintThe bandwidth of the Elastic IP, measured in Mbps. When BandwidthType=1, this shows the shared bandwidth value. When BandwidthType=0, this shows the bandwidth of this Elastic IP.No
StatusstringThe resource binding status of Elastic IP, enumeration values are: used: Bound, free: Unbound, freeze: Frozen.No
ChargeTypestringPayment method, enumeration values are: Year, pay annually; Month, pay monthly; Dynamic, pay hourly; Trial, trial. The two payment modes of hourly payment and trial need to be authorized.No
CreateTimeintCreation time of Elastic IP, in Unix Timestamp formatNo
ExpireTimeintExpiration time of Elastic IP, formatted as Unix TimestampNo
ResourceUnetEIPResourceSetDetailed information list of Elastic IP, see the specific structure below UnetEIPResourceSetNo
EIPAddrarray[UnetEIPAddrSet]Detailed information list of Elastic IP, see UnetEIPAddrSet structure below for specifics.No
NamestringThe name of the Elastic IP, the default value is 'EIP'.No
TagstringBusiness group identifier for Elastic IP, default value is "Default".No
RemarkstringRemarks for Elastic IP, the default value is "".No
PayModestringThe billing mode of Elastic IP, enumeration values are: "Bandwidth", bandwidth billing; "Traffic", traffic billing; "ShareBandwidth", shared bandwidth mode. The default is "Bandwidth"."""
ShareBandwidthSetShareBandwidthSetShared Bandwidth Information See ShareBandwidthSetNo
ExpirebooleanIs the Elastic IP expired?No
EIPBindingEIPBindingEIP Binding Intranet IP Relationship DataNo


Field NameTypeDescription InformationRequired
ResourceTypestringBound resource types, enumeration values are: uhost, UHost; natgw: NAT Gateway; ulb: Load Balancer; upm: Physical Machine; hadoophost: Big Data Cluster; fortresshost: Bastion Host; udockhost: Container; udhost: Private Zone Host; vpngw: IPSec VPN; ucdr: Cloud Disaster Recovery; dbaudit: Database Audit, uni: Virtual Network Interface.No
ResourceNamestringBound Resource NameNo
ResourceIDstringResource ID of the bound resourceNo
SubResourceTypestringThe type of the virtual network card bound to the resource. uni, virtual network card.No
SubResourceNamestringThe name of the virtual network card bound to the resourceNo
SubResourceIdstringID of the virtual network card bound to the resourceNo
EIPIdstringElastic IP Resource IDNo


Field NameTypeDescription InformationRequired
OperatorNamestringOperator information such as: International: International, BGP: BGPNo
IPstringIP AddressNo


Field NameTypeDescription InformationRequired
ShareBandwidthintShared Bandwidth ValueNo
ShareBandwidthNamestringShared Bandwidth Resource NameNo
ShareBandwidthIdstringShared Bandwidth IDNo


Field NameTypeDescription InformationRequired
EIPstringPublic IPNo
PrivateIPstringIntranet IPNo
PrivateIPTypestringIntranet IP type: PrimaryIP (default), SecondaryIP (non-default)No


Request Example

Response Example

  "Action": "DescribeEIPResponse",
  "EIPBinding": [
      "EIP": "CcSrYinL",
      "PrivateIP": "knTpCYwB",
      "PrivateIPType": "cUMLjFZU"
  "EIPSet": [
      "Bandwidth": 20,
      "BandwidthType": 1,
      "ChargeType": "Month",
      "CreateTime": 1528785841,
      "EIPAddr": [
          "IP": "106.75.XX.XX",
          "OperatorName": "BGP"
      "EIPId": "eip-XXXXX",
      "Expire": false,
      "ExpireTime": 1530374400,
      "Name": "EIP",
      "PayMode": "ShareBandwidth",
      "Remark": "",
      "Resource": {
        "ResourceID": "uhost-XXXXXX",
        "ResourceName": "test",
        "ResourceType": "uhost",
        "Zone": "cn-sh2-01"
      "ShareBandwidthSet": {
        "ShareBandwidth": 20,
        "ShareBandwidthId": "bwshare-XXXX",
        "ShareBandwidthName": "test"
      "Status": "used",
      "Tag": "Default",
      "Weight": 50
  "Request_uuid": "f33cf273-89ed-4215-a9c6-XXXXXXX",
  "RetCode": 0,
  "TotalBandwidth": 13,
  "TotalCount": 10,
  "UnbindCount": 5
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.