ListPublicIpAddressPools - 查詢IP位址集區資訊 - Elastic IP Address

調用ListPublicIpAddressPools介面查詢可使用的IP位址集區資訊。

介面說明

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
PublicIpAddressPoolIds	array	否	IP 位址集區的執行個體 ID 列表。您最多可輸入 100 個 IP 位址集區的執行個體 ID。
	string	否	IP 位址集區的執行個體 ID 列表。您最多可輸入 100 個 IP 位址集區的執行個體 ID。	pippool-6wetvn6fumkgycssx****
Status	string	否	IP 位址集區執行個體狀態。取值： Created：可用。 Deleting：刪除中。 Modifying：修改中。	Created
MaxResults	integer	否	本次讀取的最巨量資料記錄數量。取值範圍：10~100。預設值：10。	10
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
Isp	string	否	線路類型。取值： BGP（預設值）：BGP（多線）線路。 BGP_PRO：BGP（多線）_精品線路。關於 BGP（多線）線路和 BGP（多線）_精品線路的更多資訊，請參見 EIP 線路類型。如果您是單線頻寬的白名單使用者，您還可以選擇以下類型： ChinaTelecom：中國電信 ChinaUnicom：中國聯通 ChinaMobile：中國移動 ChinaTelecom_L2：中國電信 L2 ChinaUnicom_L2：中國聯通 L2 ChinaMobile_L2：中國移動 L2 如果您是杭州金融雲使用者，該欄位必填，取值：BGP_FinanceCloud。	BGP
Name	string	否	位址集區執行個體的名稱。名稱長度為 0-128 個字元，不能以`http://`或`https://`開頭。	AddressPoolName
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會查詢可使用的 IP 位址集區資訊。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接進行操作。	false
ResourceGroupId	string	否	IP 位址集區所屬的資源群組 ID。	rg-acfmxazb4pcdvf****
Tags	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。一個標籤鍵最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceJoshua
RegionId	string	是	要查詢的 IP 位址集區所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-chengdu
SecurityProtectionEnabled	boolean	否	是否開啟 DDoS 防護（增強版）。取值： false：不開啟。 true：開啟。	true

返回參數

名稱	類型	描述	樣本值
	object	返回資料結構體。
RequestId	string	請求 ID。	4EC47282-1B74-4534-BD0E-403F3EE64CAF
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	本次請求條件下的資料總量。	1
PublicIpAddressPoolList	array<object>	IP 位址集區的執行個體列表。
	array<object>	IP 位址集區的執行個體結構體。
PublicIpAddressPoolId	string	IP 位址集區的執行個體 ID。	pippool-6wetvn6fumkgycssx****
RegionId	string	要查詢的 IP 位址集區所在的地區 ID。	cn-chengdu
CreationTime	string	建立時間，格式為`YYYY-MM-DDThh:mm:ssZ`。	2022-05-10T01:37:38Z
Isp	string	線路類型。 BGP：BGP（多線）線路。 BGP_PRO：BGP（多線）_精品線路。關於 BGP（多線）線路和 BGP（多線）_精品線路的更多資訊，請參見 EIP 線路類型。如果您是單線頻寬的白名單使用者，傳回型別還可能為： ChinaTelecom：中國電信 ChinaUnicom：中國聯通 ChinaMobile：中國移動 ChinaTelecom_L2：中國電信 L2 ChinaUnicom_L2：中國聯通 L2 ChinaMobile_L2：中國移動 L2 如果您是杭州金融雲使用者，返回BGP_FinanceCloud。	BGP
Name	string	IP 位址集區執行個體的名稱。	AddressPoolName
Status	string	IP 位址集區執行個體狀態。 Created：可用。 Deleting：刪除中。 Modifying：修改中。	Created
Description	string	IP 位址集區執行個體的描述。	AddressPoolDescription
TotalIpNum	integer	公網 IP 位址集區可用 IP 位址總數。	100
UsedIpNum	integer	公網 IP 位址集區已用 IP 位址數。	20
IpAddressRemaining	boolean	是否還有閒置 IP 位址。 true：是。 false：否。	true
UserType	string	使用者的類型。取值： admin：管理員，表示可以刪除、修改、查詢 IP 位址集區以及為 IP 位址集區分配彈性公網 IP（Elastic IP Address，簡稱 EIP）等操作。 user：普通使用者，表示只能為 IP 位址集區分配 EIP 以及查詢 IP 位址集區，但是無法修改以及刪除 IP 位址集區。	admin
OwnerId	integer	IP 位址集區所屬的阿里雲帳號（主帳號）。	121012345612*****
ShareType	string	IP 位址集區的共用類型。 Shared：表示該 IP 位址集區為共用的 IP 位址集區。空：表示該 IP 位址集區不是共用的 IP 位址集區。	Shared
ResourceGroupId	string	IP 位址集區所屬的資源群組 ID。	rg-acfmxazb4pcdvf****
Tags	array<object>	標籤列表。
	object	標籤列表。
Key	string	標籤鍵。	FinanceDept
Value	string	標籤值。	FinanceDept
BizType	string	IP 位址集區的業務類型。 CloudBox：雲盒。僅雲盒使用者支援該類型。 Default（預設值）：預設，表示非特殊類型。	CloudBox
Zones	array	IP 位址集區的可用性區域。僅當 IP 位址集區業務類型為雲盒時，返回該參數。
	string	IP 位址集區的可用性區域。僅當 IP 位址集區業務類型為雲盒時，返回該參數。	ap-southeast-1-lzdvn-cb
SecurityProtectionTypes	array	安全防護層級。配置為空白時，預設為 DDoS 防護（基礎版）。配置為AntiDDoS_Enhanced時，表示 DDoS 防護（增強版）。
	string	安全防護層級。配置為空白時，預設為 DDoS 防護（基礎版）。配置為AntiDDoS_Enhanced時，表示 DDoS 防護（增強版）。	AntiDDoS_Enhanced
BusinessStatus	string	IP 位址集區執行個體的業務狀態。 Normal：正常。 FinancialLocked：被鎖定。	Normal

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1,
  "PublicIpAddressPoolList": [
    {
      "PublicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****",
      "RegionId": "cn-chengdu",
      "CreationTime": "2022-05-10T01:37:38Z",
      "Isp": "BGP",
      "Name": "AddressPoolName",
      "Status": "Created",
      "Description": "AddressPoolDescription",
      "TotalIpNum": 100,
      "UsedIpNum": 20,
      "IpAddressRemaining": true,
      "UserType": "admin",
      "OwnerId": 0,
      "ShareType": "Shared",
      "ResourceGroupId": "rg-acfmxazb4pcdvf****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceDept"
        }
      ],
      "BizType": "CloudBox",
      "Zones": [
        "ap-southeast-1-lzdvn-cb"
      ],
      "SecurityProtectionTypes": [
        "AntiDDoS_Enhanced"
      ],
      "BusinessStatus": "Normal"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalParam.Isp	The param of Isp [%s] is illegal.	參數 Isp 不合法，請根據請求參數規定重新輸入。
400	IllegalParam.NextToken	The specified NextToken is invalid.	參數NextToken非法.

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

變更歷史

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