調(diào)用CreatePublicIpAddressPool接口創(chuàng)建IP地址池。
接口說明
IP 地址池功能默認(rèn)不開放。如需使用,請(qǐng)?jiān)谂漕~中心申請(qǐng) IP 地址池功能權(quán)益配額。具體操作,請(qǐng)參見通過配額中心提升配額。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
vpc:CreatePublicIpAddressPool | create |
|
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Isp | string | 否 | 線路類型。取值:
關(guān)于 BGP(多線)線路和 BGP(多線)_精品線路的更多信息,請(qǐng)參見 EIP 線路類型。
| BGP |
Name | string | 否 | 地址池實(shí)例的名稱。 長(zhǎng)度為 0-128 個(gè)字符,不能以 | AddressPoolName |
Description | string | 否 | 地址池實(shí)例的描述。 長(zhǎng)度為 0-256 個(gè)字符,不能以 | AddressPoolDescription |
ClientToken | string | 否 | 客戶端 Token,用于保證請(qǐng)求的冪等性。 從您的客戶端生成一個(gè)參數(shù)值,確保不同請(qǐng)求間該參數(shù)值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統(tǒng)自動(dòng)使用 API 請(qǐng)求的 RequestId 作為 ClientToken 標(biāo)識(shí)。每次 API 請(qǐng)求的 RequestId 不一樣。
| 02fb3da4-130e-11**** |
DryRun | boolean | 否 | 是否只預(yù)檢此次請(qǐng)求。取值:
| false |
ResourceGroupId | string | 否 | IP 地址池所屬的資源組 ID。 | rg-acfmxazb4pcdvf**** |
RegionId | string | 是 | 要?jiǎng)?chuàng)建的 IP 地址池所在的地域 ID。 | cn-chengdu |
BizType | string | 否 | IP 地址池的業(yè)務(wù)類型。取值:
| Default |
Zones | array | 否 | IP 地址池的可用區(qū)。 BizType 取值為 CloudBox,即 IP 地址池業(yè)務(wù)類型為云盒時(shí),該參數(shù)必填。 | |
string | 否 | IP 地址池的可用區(qū)。 BizType 取值為 CloudBox,即 IP 地址池業(yè)務(wù)類型為云盒時(shí),該參數(shù)必填。 目前僅支持傳入 1 個(gè)可用區(qū)。 | ap-southeast-1-lzdvn-cb | |
Tag | array<object> | 否 | 資源的標(biāo)簽。 | |
object | 否 | 標(biāo)簽。 | ||
Key | string | 否 | 資源的標(biāo)簽鍵。最多支持輸入 20 個(gè)標(biāo)簽鍵。如需傳入該值,則不能輸入空字符串。 一個(gè)標(biāo)簽鍵最多支持 128 個(gè)字符,不能以 | FinanceDept |
Value | string | 否 | 資源的標(biāo)簽值。最多支持輸入 20 個(gè)標(biāo)簽值。如需傳入該值,可以輸入空字符串。 最多支持 128 個(gè)字符,不能以 | FinanceJoshua |
SecurityProtectionTypes | array | 否 | 安全防護(hù)級(jí)別。
| |
string | 否 | 安全防護(hù)級(jí)別。
| AntiDDoS_Enhanced |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"PulbicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****",
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
"ResourceGroupId": "rg-acfmxazb4pcdvf****",
"PublicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.Isp | The param of Isp [%s] is illegal. | 參數(shù) Isp 不合法,請(qǐng)根據(jù)請(qǐng)求參數(shù)規(guī)定重新輸入。 |
400 | IllegalParam.Name | The param of Name [%s] is illegal. | 參數(shù) Name 不合法,請(qǐng)根據(jù)請(qǐng)求參數(shù)規(guī)定重新輸入。 |
400 | IllegalParam.Description | The param of Description [%s] is illegal. | 參數(shù)Description 不合法,請(qǐng)根據(jù)請(qǐng)求參數(shù)規(guī)定重新輸入。 |
400 | Forbidden.CreatePublicIpAddressPool | Authentication is failed for creating public ip address pool. | 您暫時(shí)無法創(chuàng)建 PublicIpAddressPool,請(qǐng)檢查賬號(hào)是否已授權(quán)該操作 |
400 | QuotaExceeded.PublicIpAddressPool | The quota of PublicIpAddressPool is exceeded. | 您的PublicIpAddressPool數(shù)量已達(dá)配額,請(qǐng)?zhí)嵘漕~后操作 |
400 | MissingParam.Zones | The Zones parameter is required. | 參數(shù)Zones必填 |
400 | UnsupportedRegion | The feature is not supported in current region. | 當(dāng)前地域不支持該功能。 |
400 | IllegalParam.Zones | The values of Zones [%s] are invalid. | 參數(shù)Zones非法 |
400 | IllegalParamSize.Zones | An invalid number of zones is specified. | Zones數(shù)組大小非法 |
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. | 當(dāng)前ISP不支持創(chuàng)建增強(qiáng)型安全防護(hù)地址池。 |
400 | IllegalParam.SecurityProtectionTypes | The param of securityProtectionTypes is illegal. | 傳入的SecurityProtectionTypes參數(shù)非法 |
400 | IncorrectBusinessStatus.PublicIpAddressPool | The business status of publicIpAddressPool is incorrect. | 當(dāng)前業(yè)務(wù)狀態(tài)不支持創(chuàng)建IP地址池實(shí)例。 |
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. | 您無權(quán)使用請(qǐng)求的IP地址池服務(wù)。 確保您已經(jīng)訂閱了您嘗試使用的服務(wù)。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-05-27 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2024-03-04 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2024-01-22 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-12-08 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-08-08 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-07-10 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |