All Products
Search

This Product

    Virtual Private Cloud:AddPublicIpAddressPoolCidrBlock

    Document Center

    Virtual Private Cloud:AddPublicIpAddressPoolCidrBlock

    Last Updated:Apr 10, 2024

    Adds a CIDR block to an IP address pool.

    Operation description

    Before you call this operation, take note of the following limits:

    • The CIDR block and the IP address pool must belong to the same region.

    • The CIDR block and the IP address pool must use the same line type.

    • AddPublicIpAddressPoolCidrBlock is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListPublicIpAddressPoolCidrBlocks operation to query the status of the task.

      • If the CIDR block is in the Modifying state, the CIDR block is being added. In this state, you can only query the CIDR block and cannot perform other operations.
      • If the CIDR block is in the Created state, the CIDR block is added.

    • You cannot repeatedly call the AddPublicIpAddressPoolCidrBlock operation to add a CIDR block to an IP address pool within the specified period of time.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:AddPublicIpAddressPoolCidrBlockWrite
    • PublicIpAddressPool
      acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/{#PublicIpAddressPoolId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    PublicIpAddressPoolIdstringYes

    The ID of the IP address pool.

    		pippool-6wetvn6fumkgycssx****
    CidrBlockstringNo

    The CIDR block.

    Note You can specify only one of CidrBlock and CidrMask.
    		47.0.XX.XX/24
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		02fb3da4-130e-11****
    DryRunbooleanNo

    Specifies whether to perform a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		false
    RegionIdstringYes

    The region ID of the IP address pool to which you want to add the CIDR block.

    		cn-chengdu
    CidrMaskintegerNo

    The subnet mask of the CIDR block. After you enter the subnet mask, the system automatically allocates IP addresses.

    Valid values: 24 to 28.

    Note You can specify only one of CidrBlock and CidrMask.
    		24

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		4EC47282-1B74-4534-BD0E-403F3EE64CAF
    CidrBlockstring

    The CIDR blocks.

    		47.0.XX.XX/28

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "CidrBlock": "47.0.XX.XX/28"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParam.CidrBlockThe param of CidrBlock [%s] is illegal.The CidrBlock parameter is set to an invalid value.
    400IllegalParam.CidrBlockMaskThe param of CidrBlock Mask [%s] is illegal.The subnet mask of the CIDR block is invalid.
    400IncorrectStatus.PublicIpAddressPoolThe status of PublicIpAddressPool [%s] is incorrect.-
    400ResourceNotFound.CidrBlockThe specified resource of CidrBlock is not found.-
    400OperationDenied.CidrBlockBelongToOtherUserThe operation is not allowed because of CidrBlock belong to other user.-
    400ResourceNotFound.PublicIpAddressPoolThe specified resource ofPublicIpAddressPool [%s] is not found.-
    400QuotaExceeded.PoolIpQuantityThe quota of PoolIpQuantity is exceeded.The number of IP addresses in the pool has reached the upper limit.
    400OperationDenied.OperateSharedResourceThe operation is not allowed because of the PublicIpAddressPool is a shared resource.The public IP address pool is a shared resource and cannot be modified.
    400MissingParam.CidrBlockOrCidrMaskCidrBlock or CidrMask is not specified.The system failed to add the CIDR block to the address pool because the CIDR block or the subnet mask is not specified.
    400DuplicatedParam.CidrBlockAndCidrMaskCidrBlock and CidrMask cannot be specified at the same time.The system failed to add the CIDR block to the address pool because you cannot specify the CIDR block and the subnet mask at the same time.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-03-14API Description Update. The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Output ParametersThe response structure of the API has changed.