調用AddPublicIpAddressPoolCidrBlock接口將IP地址網段添加至IP地址池。
接口說明
在調用本接口時,請了解以下內容:
- IP 地址網段和 IP 地址池需屬于同一地域。
- IP 地址網段和 IP 地址池需屬于同一 ISP 線路類型。
- AddPublicIpAddressPoolCidrBlock 接口屬于異步接口,即系統會先返回一個請求 ID,但 IP 地址網段并未添加完成,系統后臺的添加任務仍在進行。您可以調用 ListPublicIpAddressPoolCidrBlocks 查詢 IP 地址池中 IP 地址網段的狀態。
- 當 IP 地址網段處于 Modifying 狀態時,表示 IP 地址網段正在添加中,在該狀態下,您只能執行查詢操作,不能執行其他操作。
- 當 IP 地址網段處于 Created 狀態時,表示 IP 地址網段添加完成。
- AddPublicIpAddressPoolCidrBlock 接口不支持并發添加同一個 IP 地址網段至 IP 地址池。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vpc:AddPublicIpAddressPoolCidrBlock | create | *PublicIpAddressPool acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/{#PublicIpAddressPoolId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PublicIpAddressPoolId | string | 是 | IP 地址池的實例 ID。 | pippool-6wetvn6fumkgycssx**** |
CidrBlock | string | 否 | IP 地址網段。 說明
不支持同時配置 CidrBlock 與 CidrMask,請選擇其中一個進行配置。
| 47.0.XX.XX/24 |
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。
| 02fb3da4-130e-11**** |
DryRun | boolean | 否 | 是否只預檢此次請求。取值:
| false |
RegionId | string | 是 | 要添加網段的 IP 地址池所在的地域 ID。 | cn-chengdu |
CidrMask | integer | 否 | IP 地址網段掩碼。 輸入掩碼后,系統會自動分配 IP 地址網段。 取值范圍:24~28。 說明
不支持同時配置 CidrBlock 與 CidrMask,請選擇其中一個進行配置。
| 24 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
"CidrBlock": "47.0.XX.XX/28"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.CidrBlock | The param of CidrBlock [%s] is illegal. | CidrBlock非法 |
400 | IllegalParam.CidrBlockMask | The param of CidrBlock Mask [%s] is illegal. | CidrBlock掩碼非法 |
400 | IncorrectStatus.PublicIpAddressPool | The status of PublicIpAddressPool [%s] is incorrect. | - |
400 | OperationDenied.CidrBlockBelongToOtherUser | The operation is not allowed because of CidrBlock belong to other user. | - |
400 | ResourceNotFound.PublicIpAddressPool | The specified resource ofPublicIpAddressPool [%s] is not found. | - |
400 | QuotaExceeded.PoolIpQuantity | The quota of PoolIpQuantity is exceeded. | 地址池中IP數量配額超出限制。 |
400 | OperationDenied.OperateSharedResource | The operation is not allowed because of the PublicIpAddressPool is a shared resource. | 該公網IP地址池實例是共享資源,不允許修改。 |
400 | MissingParam.CidrBlockOrCidrMask | CidrBlock or CidrMask is not specified. | 給地址池添加地址段失敗,因為缺少地址段或掩碼參數。 |
400 | DuplicatedParam.CidrBlockAndCidrMask | CidrBlock and CidrMask cannot be specified at the same time. | 給地址池添加地址段失敗,因為地址段和地址掩碼不能同時輸入。 |
400 | Forbidden.FinancialLocked | The instance is locked due to outstanding payments. | 該實例已欠費鎖定,無法操作 |
400 | ResourceNotEnough.CidrBlock | The specified resource is not enough. | 指定的資源不足 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-07-29 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-05-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-03-14 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |