All Products
Search

This Product

    Virtual Private Cloud:CreateIpamPool

    Document Center

    Virtual Private Cloud:CreateIpamPool

    Last Updated:Jun 24, 2026

    Create an IPAM address pool.

    Operation description

    • The default maximum number of public IPv6 top-level pools per ISP type per region is 1.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID of the IPAM. You can call the DescribeRegions API to obtain the region ID.

    cn-hangzhou
    IpamScopeId

    string

    Yes

    The instance ID of the IPAM scope.

    ipam-scope-glfmcyldpm8lsy****
    IpamPoolName

    string

    No

    The name of the IPAM address pool.

    The name must be 1 to 128 characters in length and cannot start with http:// or https://.

    abc
    IpamPoolDescription

    string

    No

    The description of the IPAM address pool.

    The description must be 1 to 256 characters in length and must start with an uppercase or lowercase English letter or a Chinese character. It cannot start with http:// or https://. If this parameter is not specified, the description is empty by default.

    test description
    ResourceGroupId

    string

    No

    The resource group ID of the IPAM address pool.

    rg-acfmxazb4ph6aiy****
    PoolRegionId

    string

    No

    The region where the IPAM address pool takes effect.

    cn-hangzhou
    SourceIpamPoolId

    string

    No

    The instance ID of the source IPAM address pool.

    Note

    If this parameter is not specified, the created address pool is a parent address pool.

    ipam-pool-6rcq3tobayc20t****
    AllocationDefaultCidrMask

    integer

    No

    The default CIDR mask for allocations from the IPAM address pool.

    Note

    The IPv4 CIDR mask ranges from 0 to 32 bits. The IPv6 CIDR mask ranges from 0 to 128 bits.

    28
    AllocationMaxCidrMask

    integer

    No

    The maximum CIDR mask for allocations from the IPAM address pool.

    Note

    The IPv4 CIDR mask ranges from 0 to 32 bits. The IPv6 CIDR mask ranges from 0 to 128 bits.

    32
    AllocationMinCidrMask

    integer

    No

    The minimum CIDR mask for allocations from the IPAM address pool.

    Note

    The IPv4 CIDR mask ranges from 0 to 32 bits. The IPv6 CIDR mask ranges from 0 to 128 bits.

    8
    DryRun

    boolean

    No

    Specifies whether to perform only 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 required parameters, request format, and instance status. If the request fails the dry run, an error message is returned. If the request passes the dry run, DryRunOperation is returned.

    • false (default): performs a dry run and performs the actual request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is directly performed.

    false
    ClientToken

    string

    No

    The client token that is used to ensure the idempotency 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 RequestId of the API request as the ClientToken. The RequestId may be different for each API request.

    123e4567-e89b-12d3-a456-426655440000
    IpVersion

    string

    No

    The IP address protocol version. Valid values:

    • IPv4: IPv4.

    • IPv6: IPv6.

    IPv4
    Ipv6Isp

    string

    No

    The type of IPv6 CIDR block. This parameter takes effect only for public IPv6 address pools. Valid values:

    • BGP (default): Alibaba Cloud BGP IPv6.

    • ChinaMobile: China Mobile (single-line).

    • ChinaUnicom: China Unicom (single-line).

    • ChinaTelecom: China Telecom (single-line).

    Note

    If you are a user who has activated the single-line bandwidth whitelist, this field can be set to ChinaTelecom (China Telecom), ChinaUnicom (China Unicom), or ChinaMobile (China Mobile).

    BGP
    AutoImport

    boolean

    No

    Specifies whether to enable the auto-import feature for the address pool.

    true
    Tag

    array<object>

    No

    The tag list.

    object

    No

    The tag information.

    Key

    string

    No

    The tag key of the resource. A maximum of 20 tag keys are supported. Once this value is specified, it cannot be an empty string.

    The tag key can be up to 64 characters in length and must start with a letter or Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with aliyun or acs:, and cannot contain http:// or https://.

    Note

    You must specify at least one of the ResourceId.N and Tag.N (Tag.N.Key and Tag.N.Value) parameters.

    FinanceDept
    Value

    string

    No

    The tag value of the resource. A maximum of 20 tag values are supported. Once this value is specified, it can be an empty string.

    The tag value can be up to 128 characters in length and cannot contain http:// or https://.

    Note

    You must specify at least one of the ResourceId.N and Tag.N (Tag.N.Key and Tag.N.Value) parameters.

    FinanceJoshua

    Response elements

    Element

    Type

    Description

    Example

    object

    The returned information.

    RequestId

    string

    The request ID.

    BB2C39DE-CEB8-595A-981A-F2EFCBE7324E
    IpamPoolId

    string

    The instance ID of the IPAM address pool.

    ipam-pool-6rcq3tobayc20t****

    Examples

    Success response

    JSON format

    {
  "RequestId": "BB2C39DE-CEB8-595A-981A-F2EFCBE7324E",
  "IpamPoolId": "ipam-pool-6rcq3tobayc20t****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ResourceNotFound.IpamScope The specified resource of IPAM scope is not found. The input IPAM scope does not exist.
    400 ResourceNotFound.SourceIpamPool The dependent source IPAM pool is not found. The dependent resource source IPAM Pool does not exist.
    400 UnsupportedFeature.PublicIpamScopeType The feature of PublicIpamScopeType is not supported. The IPAM you specified does not support the creation of public scope.
    400 IllegalParam.AllocationDefaultNetmask The specified AllocationDefaultNetmask is illegal. AllocationDefaultNetmask parameter is illegal.
    400 IllegalParam.AllocationMaxNetmask The specified AllocationMaxNetmask is illegal. AllocationMaxNetmask parameter is illegal.
    400 IllegalParam.AllocationMinNetmask The specified AllocationMinNetmask is illegal. AllocationMinNetmask parameter is illegal.
    400 IllegalParam.IpVersion The specified IpVersion is illegal. Invalid IpVersion.
    400 QuotaExceeded.IpamPoolQuotaDepth The quota of IpamPoolQuotaDepth count is exceeded. Maximum number of IPAM address pool depth allowed exceeds limit
    400 ResourceNotFound.Ipam The specified resource of ipam is not found. The IPAM entered does not exist.
    400 IllegalParam.PoolRegionId The specified PoolRegionId is illegal. PoolRegionId parameter is illegal.
    400 QuotaExceeded.IpamSubPoolQuotaPerIpamPool The quota of ipamSubPoolQuotaPerIpamPool count is exceeded. The number of sub-pools for the IPAM pool exceeds the limit.
    400 DryRunOperation Request validation has been passed with DryRun flag set.
    400 IncorrectStatus.IpamPool The status of the IPAM pool is incorrect. The status of the IPAM pool is incorrect.
    400 OperationDenied.OperateShareResource The operation is not allowed because the instance is a shared resource. The operation is not allowed because the instance is a shared resource.
    400 UnsupportedFeature.IpamPublicIpv4Pool The feature of public IPv4 pool is not supported in IPAM. The feature of public IPv4 pool is not supported in IPAM.
    400 OperationDenied.IpamPublicIpv6PoolNeedPoolRegion The public IPv6 pool cannot be created in IPAM when its pool region is empty. The public IPv6 pool cannot be created in IPAM when its pool region is empty.
    400 IllegalParam.Ipv6Isp The specified Ipv6Isp is illegal. The specified Ipv6Isp is illegal.
    400 UnsupportedFeature.Ipv6Isp The Ipv6Isp feature is not supported. The Ipv6Isp feature is not supported.
    400 UnsupportedRegion.Ipv6Isp The current region does not support this feature. The current region does not support this feature.
    400 QuotaExceeded.IpamPublicIpv6TopPoolQuotaPerRegionIsp The number of public IPv6 top pool in IPAM for this ISP owned by the user in this region exceeds the limit. The number of public IPv6 top pool in IPAM for this ISP owned by the user in this region exceeds the limit.
    400 Mismatch.IpamScopeAndSourceIpamPool The input source IPAM pool is not in the input IPAM scope. The input source IPAM pool is not in the input IPAM scope.
    400 Mismatch.Ipv6IspAndSourceIpamPool The input Ipv6Isp is inconsistent with the Ipv6Isp of the input source IPAM pool. The input Ipv6Isp is inconsistent with the Ipv6Isp of the input source IPAM pool.
    400 UnsupportedFeature.IpamIpv6 The feature of IPv6 is not supported in this region. The feature of IPv6 is not supported in this region.
    400 Mismatch.ChildIpVersionAndParentIpVersion The ChildIpVersion and ParentIpVersion are mismatched. The ChildIpVersion and ParentIpVersion are mismatched.
    400 Mismatch.ChildPoolRegionAndParentPoolRegion The ChildPoolRegion and ParentPoolRegion are mismatched. The ChildPoolRegion and ParentPoolRegion are mismatched.
    400 Mismatch.ChildIpamScopeAndParentIpamScope The ChildIpamScope and ParentIpamScope are mismatched. The ChildIpamScope and ParentIpamScope are mismatched.
    400 Mismatch.ChildIpv6IspAndParentIpv6Isp The ChildIpv6Isp and ParentIpv6Isp are mismatched. The ChildIpv6Isp and ParentIpv6Isp are mismatched.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.