调用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代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String AddPublicIpAddressPoolCidrBlock

系统规定参数。取值:AddPublicIpAddressPoolCidrBlock

PublicIpAddressPoolId String pippool-6wetvn6fumkgycssx****

IP地址池的实例ID。

CidrBlock String 47.0.XX.XX/24

IP地址网段。

说明 不支持同时配置 CidrBlockCidrMask,请选择其中一个进行配置。
ClientToken String 02fb3da4-130e-11****

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

DryRun Boolean false

是否只预检此次请求。取值:

  • true:发送检查请求,不会添加网段。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
RegionId String cn-chengdu

要添加网段的IP地址池所在的地域ID。

CidrMask Integer 24

IP地址网段掩码。

输入掩码后,系统会自动分配IP地址网段。

取值范围:24~30

说明 不支持同时配置 CidrBlockCidrMask,请选择其中一个进行配置。

返回数据

名称 类型 示例值 描述
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=AddPublicIpAddressPoolCidrBlock
&PublicIpAddressPoolId=pippool-6wetvn6fumkgycssx****
&CidrBlock=47.0.XX.XX/24
&ClientToken=02fb3da4-130e-11****
&DryRun=false
&RegionId=cn-chengdu
&CidrMask=24
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<AddPublicIpAddressPoolCidrBlockResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
</AddPublicIpAddressPoolCidrBlockResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

错误码

HttpCode 错误码 错误信息 描述
400 IllegalParam.CidrBlock The param of CidrBlock [%s] is illegal. CidrBlock非法
400 IllegalParam.CidrBlockMask The param of CidrBlock Mask [%s] is illegal. CidrBlock掩码非法
400 ResourceNotFound.CidrBlock The specified resource of CidrBlock is not found. 无法找到指定的CidrBlock
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. 给地址池添加地址段失败,因为地址段和地址掩码不能同时输入。

访问错误中心查看更多错误码。