ListPublicIpAddressPoolCidrBlocks - 查詢IP位址集區的位址區段資訊

更新時間:
Copy as MD

調用ListPublicIpAddressPoolCidrBlocks介面查詢IP位址集區中的IP地址網段資訊。

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

PublicIpAddressPoolId

string

IP 位址集區的執行個體 ID。

pippool-6wetvn6fumkgycssx****

CidrBlock

string

IP 位址網段。

47.0.XX.XX/24

MaxResults

integer

本次讀取的最巨量資料記錄數量,取值範圍:10~100,預設為 10

10

NextToken

string

是否擁有下一次查詢的令牌(Token)。取值:

  • 第一次查詢和沒有下一次查詢時,均無需填寫。

  • 如果有下一次查詢,取值為上一次 API 呼叫返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****

DryRun

boolean

是否只預檢此次請求。取值:

  • true:發送檢查請求,不會查詢 IP 位址集區中的 IP 位址網段資訊。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過,則返回對應錯誤。如果檢查通過,則返回錯誤碼DryRunOperation

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

false

RegionId

string

要查詢的 IP 位址網段所在的地區 ID。

cn-chengdu

返回參數

名稱

類型

描述

樣本值

object

返回資料結構體。

RequestId

string

請求 ID。

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

NextToken

string

是否擁有下一次查詢的令牌(Token)。取值:

  • 如果 NextToken 為空白表示沒有下一次查詢。

  • 如果 NextToken 有傳回值,該取值表示下一次查詢開始的令牌。

FFmyTO70tTpLG6I3FmYAXGKPd****

TotalCount

integer

本次請求條件下的資料總量。

10

PublicIpPoolCidrBlockList

array<object>

IP 位址集區的 IP 位址網段資料列表。

object

IP 位址集區的 IP 位址網段結構體。

PublicIpAddressPoolId

string

IP 位址集區的執行個體 ID。

pippool-6wetvn6fumkgycssx****

CidrBlock

string

IP 位址段。

47.0.XX.XX/24

CreationTime

string

建立時間,格式為YYYY-MM-DDThh:mm:ssZ

2022-05-10T01:37:38Z

Status

string

IP 位址集區中的 IP 位址網段狀態。取值:

  • Created:可用。

  • Deleting:刪除中。

  • Modifying:修改中。

Created

UsedIpNum

integer

IP 位址集區中 IP 位址網段的已用 IP 位址數。

20

TotalIpNum

integer

IP 位址集區中 IP 位址網段的可用 IP 位址總數。

20

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 10,
  "PublicIpPoolCidrBlockList": [
    {
      "PublicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****",
      "CidrBlock": "47.0.XX.XX/24",
      "CreationTime": "2022-05-10T01:37:38Z",
      "Status": "Created",
      "UsedIpNum": 20,
      "TotalIpNum": 20
    }
  ]
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 IllegalParam.NextToken The specified NextToken is invalid. 參數NextToken非法.
400 MissingParam.PublicIpAddressPoolId The parameter PublicIpAddressPoolId is missing. 參數PublicIpAddressPoolId缺失。

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

變更歷史

更多資訊,參考變更詳情