幫助中心
首頁 Elastic IP Address 開發參考 API參考 API目錄 Elastic IP Address EIP執行個體 DescribeEipAddresses - 查詢指定地區已建立的EIP

DescribeEipAddresses - 查詢指定地區已建立的EIP

更新時間：
Copy as MD
產品

查詢指定地區已建立的EIP。

介面說明

本介面可以查詢指定地區已建立的 EIP 資訊，包括 EIP 的頻寬峰值、計費方式，當前綁定的執行個體類型等。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值
RegionId

string

是

EIP 所在的地區 ID。

您可以通過調用 DescribeRegions 介面擷取地區 ID。

cn-hangzhou
IncludeReservationData

boolean

否

是否包含未生效的訂購資料，取值：

  • false（預設值）：不包含未生效的訂購資料。

  • true：包含未生效的訂購資料。

false
Status

string

否

EIP 的狀態，取值：

  • Associating：綁定中。

  • Unassociating：解除綁定中。

  • InUse：已指派。

  • Available：可用。

  • Releasing：釋放中。

Available
EipAddress

string

否

要查詢的 EIP 的 IP 位址。

最多支援輸入 50 個 EIP 的 IP 位址，IP 位址之間用半形逗號（,）分隔。

說明

如果同時傳入 EipAddress 和 AllocationId 參數，EipAddress 可輸入 50 個 EIP 的 IP 位址，AllocationId 也可同時輸入 50 個 EIP 的執行個體 ID。

47.75.XX.XX
AllocationId

string

否

要查詢的 EIP 執行個體的 ID。

最多支援輸入 50 個 EIP 執行個體 ID，執行個體 ID 之間用半形逗號（,）分隔。

說明

如果同時傳入 EipAddress 和 AllocationId 參數，AllocationId 可輸入 50 個 EIP 的執行個體 ID，EipAddress 也可同時輸入 50 個 EIP 的 IP 位址。

eip-2zeerraiwb7ujxscd****
SegmentInstanceId

string

否

連續 EIP 的執行個體 ID。

eipsg-t4nr90yik5oy38xdy****
ResourceGroupId

string

否

EIP 所屬的資源群組的 ID。

rg-acfmxazb4pcdvf****
PageNumber

integer

否

列表的頁碼。預設值：1。

10
PageSize

integer

否

分頁查詢時每頁的行數。最大值：100。預設值：10。

10
ISP

string

否

線路類型。取值：

  • BGP（預設值）：BGP（多線）線路。目前全部地區都支援 BGP（多線）線路 EIP。

  • BGP_PRO：BGP（多線）_精品線路。目前僅中國香港、新加坡、日本（東京）、馬來西亞（吉隆坡）、菲律賓（馬尼拉）、印尼（雅加達）和泰國（曼穀）地區支援 BGP（多線）_精品線路 EIP。

關於 BGP（多線）線路和 BGP（多線）_精品線路的更多資訊，請參見 EIP 線路類型。

如果您是單線頻寬的白名單使用者，您還可以選擇以下類型：

  • ChinaTelecom：中國電信

  • ChinaUnicom：中國聯通

  • ChinaMobile：中國移動

  • ChinaTelecom_L2：中國電信 L2

  • ChinaUnicom_L2：中國聯通 L2

  • ChinaMobile_L2：中國移動 L2

如果您是杭州金融雲使用者，該欄位必填，取值：BGP_FinanceCloud。

BGP
Filter.1.Key

string

否

查詢資源時的篩選鍵，必須取值為 CreationStartTime（資源建立的開始時間）。

CreationStartTime
Filter.2.Key

string

否

查詢資源時的篩選鍵，必須取值為 CreationEndTime（資源建立的結束時間）。

CreationEndTime
Filter.1.Value

string

否

查詢資源時的篩選值。使用 UTC 時間，格式為YYYY-MM-DDThh:mmZ。

2023-01-01T01:00Z
Filter.2.Value

string

否

查詢資源時的篩選值。使用 UTC 時間，格式為YYYY-MM-DDThh:mmZ。

2023-01-06T02:00Z
LockReason

string

否

鎖定類型，取值：

  • financial：因欠費被鎖定。

  • security：因安全原因被鎖定。

financial
AssociatedInstanceType

string

否

要綁定的雲產品執行個體的類型，取值：

  • EcsInstance（預設值）：VPC 類型的 ECS 執行個體。

  • SlbInstance：VPC 類型的 CLB 執行個體。

  • Nat：NAT Gateway。

  • HaVip：高可用虛擬 IP。

  • NetworkInterface：輔助彈性網卡。

  • IpAddress：IP 位址。

說明

每個 ECS 執行個體、CLB 執行個體、高可用虛擬 IP 和 IP 位址同時只能綁定一個 EIP，NAT Gateway可以綁定多個 EIP。輔助彈性網卡可以綁定 EIP 的個數受 EIP 繫結模式影響，更多資訊，請參見彈性公網 IP 概述。

EcsInstance
AssociatedInstanceId

string

否

雲產品的執行個體 ID。

i-2zebb08phyccdvf****
ChargeType

string

否

EIP 的付費模式，取值：

  • PostPaid：隨用隨付。

  • PrePaid：訂用帳戶。

PostPaid
DryRun

boolean

否

是否只預檢此次請求，取值：

  • true：發送檢查請求，不會查詢資源狀況。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼DryRunOperation。

  • false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接進行操作。

false
EipName

string

否

EIP 的名稱。

長度為 1~128 個字元，必須以字母或中文開頭，可包含數字、底線（_）和短劃線（-）。

EIP-01
Tag

array<object>

否

指定標籤篩選 EIP。

object

否

指定標籤篩選 EIP。

Key

string

否

標籤鍵。最多支援輸入 20 個標籤鍵。一旦傳入該值，則不允許為空白字串。

一個標籤鍵最多支援 128 個字元，不能以aliyun和acs:開頭，不能包含http://或者https://。

FinanceDept
Value

string

否

標籤值。最多支援輸入 20 個標籤值。一旦傳入該值，可以為空白字串。

一個標籤值最多支援 128 個字元，不能以aliyun和acs:開頭，不能包含http://或者https://。

FinanceJoshua
SecurityProtectionEnabled

boolean

否

是否開啟了 DDoS 防護（增強版）。取值：

  • false：未開啟。

  • true：已開啟。

false
PublicIpAddressPoolId

string

否

要查詢的 EIP 所屬 IP 位址集區 ID。

pippool-2vc0kxcedhquybdsz****
ServiceManaged

boolean

否

是否為受管理的執行個體。取值：

  • true：是受管理的執行個體。

  • false：不是受管理的執行個體。

不填預設查詢所有執行個體。

false

返回參數

名稱

類型

描述

樣本值

object

返回資訊列表。

PageSize

integer

每頁包含的條目數。

10
RequestId

string

請求 ID。

4EC47282-1B74-4534-BD0E-403F3EE64CAF
PageNumber

integer

當前頁碼。

10
TotalCount

integer

列表條目數。

1
EipAddresses

object

EipAddress

array<object>

EIP 的詳細資料。

array<object>

EIP 的詳細資料。

ReservationActiveTime

string

續約生效時間，格式為YYYY-MM-DDThh:mm:ssZ。

2021-05-23T16:00:00Z
Status

string

EIP 的狀態。

  • Associating：綁定中。

  • Unassociating：解除綁定中。

  • InUse：已指派。

  • Available：可用。

  • Releasing：釋放中。

Available
ReservationOrderType

string

續約訂單類型。

  • RENEWCHANGE：續約變更配置。

  • TEMP_UPGRADE：短時升配。

  • UPGRADE ：升級。

RENEWCHANGE
AllocationTime

string

EIP 的建立時間，格式為YYYY-MM-DDThh:mm:ssZ。

2021-04-23T01:37:38Z
Netmode

string

網路類型。僅取值：public，表示公網。

public
ChargeType

string

EIP 的付費模式，取值：

  • PostPaid：隨用隨付。

  • PrePaid：訂用帳戶。

PostPaid
Description

string

EIP 的描述資訊。

abc
Mode

string

繫結模式，取值：

  • NAT：NAT 模式（普通模式）。

  • MULTI_BINDED：多 EIP 網卡可見度模式。

  • BINDED：EIP 網卡可見度模式。

NAT
SegmentInstanceId

string

連續 EIP 的執行個體 ID。

僅 EIP 屬於連續 EIP 時才會返回該參數值。

eipsg-t4nr90yik5oy38xd****
ReservationInternetChargeType

string

續約付費類型。

  • PayByBandwidth：按固定頻寬計費。

  • PayByTraffic：按使用流量計費。

PayByBandwidth
BandwidthPackageId

string

加入的共用頻寬 ID。

cbwp-bp1ego3i4j07ccdvf****
IpAddress

string

EIP 的 IP 位址。

47.75.XX.XX
Bandwidth

string

EIP 的頻寬峰值。單位：Mbps。

5
ReservationBandwidth

string

續約頻寬。單位：Mbps。

12
EipBandwidth

string

EIP 加入共用頻寬之前或退出共用頻寬之後的頻寬。單位：Mbps。

101
Name

string

EIP 的名稱。

EIP-01
PrivateIpAddress

string

EIP 所綁定的輔助彈性網卡執行個體的私網 IP 位址。

192.168.XX.XX
InstanceRegionId

string

當前綁定的資源的地區 ID。

cn-hangzhou
DeletionProtection

boolean

是否開啟了刪除保護功能。

  • true：已開啟。

  • false：未開啟。

true
InstanceId

string

當前綁定的執行個體的 ID。

i-bp15zckdt37cdvf****
SecondLimited

boolean

是否配置了二級限速。

  • true：已配置。

  • false：未配置。

false
InstanceType

string

當前綁定的執行個體類型。

  • EcsInstance：VPC 類型的 ECS 執行個體。

  • SlbInstance：VPC 類型的 CLB 執行個體。

  • Nat：NAT Gateway。

  • HaVip：高可用虛擬 IP。

  • NetworkInterface：輔助彈性網卡。

  • IpAddress：IP 位址。

EcsInstance
HDMonitorStatus

string

EIP 是否開啟了秒級監控。

  • false：未開啟。

  • true：已開啟。

false
RegionId

string

EIP 所在的地區 ID。

cn-hangzhou
BandwidthPackageBandwidth

string

EIP 加入的共用頻寬的頻寬值。單位：Mbps。

50
ServiceManaged

integer

是否為受管理的執行個體。取值：

  • 1：是受管理的執行個體。

  • 0：不是受管理的執行個體。

0
ExpiredTime

string

到期時間，格式為YYYY-MM-DDThh:mm:ssZ。

2021-05-23T02:00:00Z
ResourceGroupId

string

資源群組 ID。

rg-acfmxazcdxs****
AllocationId

string

EIP 的執行個體 ID。

eip-2zeerraiwb7ujcdvf****
InternetChargeType

string

EIP 的計費方式。

  • PayByBandwidth：按固定頻寬計費。

  • PayByTraffic：按使用流量計費。

PayByBandwidth
BusinessStatus

string

EIP 執行個體的業務狀態。

  • Normal：正常。

  • OperationLock：被鎖定。

  • Unactivated：未啟用。

Normal
BandwidthPackageType

string

頻寬的類型，僅支援返回 CommonBandwidthPackage（共用頻寬）。

CommonBandwidthPackage
HasReservationData

string

是否有續約資料。

  • false：無續約資料。

  • true：有續約資料。只有在入參 IncludeReservationData 為 true，且有未生效訂購資料時才會為 true。

false
ISP

string

線路類型。

  • BGP：BGP（多線）線路。目前全部地區都支援 BGP（多線）線路 EIP。

  • BGP_PRO：BGP（多線）_精品線路。目前僅中國香港、新加坡、日本（東京）、馬來西亞（吉隆坡）、菲律賓（馬尼拉）、印尼（雅加達）和泰國（曼穀）地區支援 BGP（多線）_精品線路 EIP。

關於 BGP（多線）線路和 BGP（多線）_精品線路的更多資訊，請參見 EIP 線路類型。

如果您是單線頻寬的白名單使用者，傳回型別還可能為：

  • ChinaTelecom：中國電信

  • ChinaUnicom：中國聯通

  • ChinaMobile：中國移動

  • ChinaTelecom_L2：中國電信 L2

  • ChinaUnicom_L2：中國聯通 L2

  • ChinaMobile_L2：中國移動 L2

如果您是杭州金融雲使用者，返回BGP_FinanceCloud。

BGP
OperationLocks

object

LockReason

array<object>

鎖定詳情。

object

鎖定詳情。

LockReason

string

鎖定類型。

  • financial：因欠費被鎖定。

  • security：因安全原因被鎖定。

  • sharedPool：因共用 IP 位址集區欠費被鎖定。

financial
Tags

object

Tag

array<object>

EIP 的標籤列表。

object

EIP 的標籤列表。

"Tag": [ { "Value": "000", "Key": "yyy" }, { "Value": "111","Key": "kkk" }
Key

string

EIP 的標籤鍵。

KeyTest
Value

string

EIP 的標籤值。

ValueTest
SecurityProtectionTypes

object

SecurityProtectionType

array

安全防護層級。

  • 返回為空白時，表示 DDoS 防護（基礎版）。

  • 返回AntiDDoS_Enhanced時，表示 DDoS 防護（增強版）。

string

安全防護層級。

  • 返回為空白時，表示 DDoS 防護（基礎版）。

  • 返回AntiDDoS_Enhanced時，表示 DDoS 防護（增強版）。

AntiDDoS_Enhanced
PublicIpAddressPoolId

string

EIP 所屬的 IP 位址集區 ID。

pippool-2vc0kxcedhquybdsz****
VpcId

string

開通了 IPv4 網關功能且與 EIP 同地區的 VPC ID。

EIP 綁定 IP 位址時，系統可以根據該 VPC 的路由配置，使綁定的 IP 位址具備公網訪問能力。

說明

InstanceType 為 IpAddress 時，即綁定 EIP 的執行個體類型為 IP 位址時，返回該參數。

vpc-bp15zckdt37pq72zv****
Zone

string

EIP 的可用性區域。

僅當 EIP 業務類型為雲盒時，返回該參數。

ap-southeast-1-lzdvn-cb
BizType

string

EIP 的業務類型。

  • CloudBox：雲盒。僅雲盒使用者支援該類型。

  • Default（預設值）：預設，表示非特殊類型。

CloudBox
ServiceID

integer

雲端服務託管帳號 ID

18726XXXXXXX

樣本

正常返回樣本

JSON格式

{
  "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
      }
    ]
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述
400 InvalidIAssociatedInstanceType.ValueNotSupported The specified value of AssociatedInstanceType is not supported. AssociatedInstanceType的值不合法，請您檢查該參數是否正確。
400 InvalidChargeType.ValueNotSupported The specified ChargeType is not supported.
400 InvalidAliuid User Id is not valid.
400 InvalidResourceGroupId The specified ResourceGroupId does not exist. 資源群組ID不存在。
400 InstanceType.Invalid InstanceType is not null
400 InstanceIdLength.Exceed InstanceId length is exceed
400 InvalidTagKey The tag keys are not valid. 無效的標籤索引
400 InvalidTagValue The tag values are not valid. 無效的標籤值
400 OperationUnsupported.ResourceGroupId ResourceGroup is not supported in this region. 資源群組功能未開啟。
400 IellgalParameter.OwnerAccount The specified parameter OwnerAccount is not valid. 指定參數 OwnerAccount 不合法
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

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。

上一篇：ModifyEipAddressAttribute - 修改EIP屬性下一篇：DescribeEipGatewayInfo - 查詢EIP的網關和掩碼資訊