調用CreatePublicIpAddressPool接口創建IP地址池。
接口說明
IP 地址池功能默認不開放。如需使用，請在配額中心申請 IP 地址池功能權益配額。具體操作，請參見通過配額中心提升配額。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:CreatePublicIpAddressPool | create | *PublicIpAddressPool acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Isp | string | 否 | 線路類型。取值：
關于 BGP（多線）線路和 BGP（多線）_精品線路的更多信息，請參見 EIP 線路類型。
| BGP |
| Name | string | 否 | 地址池實例的名稱。 長度為 0-128 個字符，不能以 | AddressPoolName |
| Description | string | 否 | 地址池實例的描述。 長度為 0-256 個字符，不能以 | AddressPoolDescription |
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11**** |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值：
| false |
| ResourceGroupId | string | 否 | IP 地址池所屬的資源組 ID。 | rg-acfmxazb4pcdvf**** |
| RegionId | string | 是 | 要創建的 IP 地址池所在的地域 ID。 | cn-chengdu |
| BizType | string | 否 | IP 地址池的業務類型。取值：
| 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 個標簽鍵。如需傳入該值，則不能輸入空字符串。 一個標簽鍵最多支持 128 個字符，不能以 | FinanceDept |
| Value | string | 否 | 資源的標簽值。最多支持輸入 20 個標簽值。如需傳入該值，可以輸入空字符串。 最多支持 128 個字符，不能以 | FinanceJoshua |
| SecurityProtectionTypes | array | 否 | 安全防護級別。
| |
| string | 否 | 安全防護級別。
| AntiDDoS_Enhanced |
返回參數
示例
正常返回示例
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地址池服務。 確保您已經訂閱了您嘗試使用的服務。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-05-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-03-04 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-01-22 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-12-08 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-08-08 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-07-10 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |