调用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代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vpc:AddPublicIpAddressPoolCidrBlock |
create |
*PublicIpAddressPool
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据结构体。 |
||
| RequestId |
string |
请求 ID。 |
4EC47282-1B74-4534-BD0E-403F3EE64CAF |
| CidrBlock |
string |
IP 地址段。 |
47.0.XX.XX/28 |
示例
正常返回示例
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. | 指定的资源不足 |
| 400 | MissingParam.PublicIpAddressPoolId | The parameter PublicIpAddressPoolId is missing. | 参数PublicIpAddressPoolId缺失。 |
| 400 | OperationFailed.ResourceNotEnough | Insufficient resources. | 您申请的资源不足,如仍需申请,请提工单处理 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。