CreatePublicIpAddressPool - 建立IP位址集區

更新時間:
Copy as MD

調用CreatePublicIpAddressPool介面建立IP位址集區。

介面說明

IP 位址集區功能預設不開放。如需使用,請在配額中心申請 IP 位址集區功能權益配額。具體操作,請參見通過配額中心提升配額

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

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

Description

string

位址集區執行個體的描述。

長度為 0-256 個字元,不能以http://https://開頭。

AddressPoolDescription

ClientToken

string

用戶端 Token,用於保證請求的等冪性。

從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

說明

若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。

02fb3da4-130e-11****

DryRun

boolean

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

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

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

false

ResourceGroupId

string

IP 位址集區所屬的資源群組 ID。

rg-acfmxazb4pcdvf****

RegionId

string

要建立的 IP 位址集區所在的地區 ID。

cn-chengdu

BizType

string

IP 位址集區的業務類型。取值:

  • CloudBox:雲盒。僅雲盒使用者支援選擇該類型。

  • Default(預設值):預設,表示非特殊類型。

Default

Zones

array

IP 位址集區的可用性區域。 僅 BizType 取值為 CloudBox,即 IP 位址集區業務類型為雲盒時,需要填寫該參數。

string

IP 位址集區的可用性區域。 僅 BizType 取值為 CloudBox,即 IP 位址集區業務類型為雲盒時,需要填寫該參數。 目前僅支援傳入 1 個可用性區域。

ap-southeast-1-lzdvn-cb

Tag

array<object>

資源的標籤。

object

標籤。

Key

string

資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值,則不能輸入Null 字元串。

一個標籤鍵最多支援 128 個字元,不能以aliyunacs:開頭,不能包含http://或者https://

FinanceDept

Value

string

資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值,可以輸入Null 字元串。

最多支援 128 個字元,不能以aliyunacs:開頭,不能包含http://或者https://

FinanceJoshua

SecurityProtectionTypes

array

安全防護層級。

  • 配置為空白時,預設為 DDoS 防護(基礎版)。

  • 配置為AntiDDoS_Enhanced時,表示 DDoS 防護(增強版)。

string

安全防護層級。

  • 配置為空白時,預設為 DDoS 防護(基礎版)。

  • 配置為AntiDDoS_Enhanced時,表示 DDoS 防護(增強版)。

AntiDDoS_Enhanced

返回參數

名稱

類型

描述

樣本值

object

返回資料結構體。

PulbicIpAddressPoolId deprecated

string

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

pippool-6wetvn6fumkgycssx****

RequestId

string

請求 ID。

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

ResourceGroupId

string

IP 位址集區所屬的資源群組 ID。

rg-acfmxazb4pcdvf****

PublicIpAddressPoolId

string

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

pippool-6wetvn6fumkgycssx****

樣本

正常返回樣本

JSON格式

{
  "PulbicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****",
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "ResourceGroupId": "rg-acfmxazb4pcdvf****",
  "PublicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 IllegalParam.Isp The param of Isp [%s] is illegal. 參數 Isp 不合法,請根據請求參數規定重新輸入。
400 IllegalParam.Name The param of Name [%s] is illegal. 參數 Name 不合法,請根據請求參數規定重新輸入。
400 IllegalParam.Description The param of Description [%s] is illegal. 參數Description 不合法,請根據請求參數規定重新輸入。
400 Forbidden.CreatePublicIpAddressPool Authentication is failed for creating public ip address pool. 您暫時無法建立 PublicIpAddressPool,請檢查帳號是否已授權該操作
400 QuotaExceeded.PublicIpAddressPool The quota of PublicIpAddressPool is exceeded. 您的PublicIpAddressPool數量已達配額,請提升配額後操作
400 MissingParam.Zones The Zones parameter is required. 參數Zones必填
400 UnsupportedRegion The feature is not supported in current region. 當前地區不支援該功能。
400 IllegalParam.Zones The values of Zones [%s] are invalid. 參數Zones非法
400 IllegalParamSize.Zones An invalid number of zones is specified. Zones數組大小非法
400 UnsupportedFeature.Isp The feature of Isp is not supported. 您指定的Isp暫未支援
400 OperationDenied.ISPNotSupportDdosEnhanced The operation is not allowed because of DdosEnhanced is not supported by current isp. 當前ISP不支援建立增強型安全防護位址集區。
400 IllegalParam.SecurityProtectionTypes The param of securityProtectionTypes is illegal. 傳入的SecurityProtectionTypes參數非法
400 IncorrectBusinessStatus.PublicIpAddressPool The business status of publicIpAddressPool is incorrect. 當前業務狀態不支援建立IP位址集區執行個體。
400 OptInRequired.PublicIpAddressPool You are not authorized to use the requested service of publicIpAddressPool. Ensure that you have subscribed to the service you are trying to use. 您無權使用請求的IP位址集區服務。 確保您已經訂閱了您嘗試使用的服務。

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

變更歷史

更多資訊,參考變更詳情