All Products
Search

This Product

    Virtual Private Cloud:CreatePublicIpAddressPool

    Document Center

    Virtual Private Cloud:CreatePublicIpAddressPool

    Last Updated:Mar 22, 2024

    Creates an IP address pool.

    Operation description

    By default, the IP address pool feature is unavailable. You can apply for the privilege to use the IP address pool feature in the Quota Center console. For more information, see the "Request a quota increase in the Quota Center console" section in the Manage EIP quotas topic.

    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:CreatePublicIpAddressPoolWrite
    • PublicIpAddressPool
      acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    IspstringNo

    The line type. Valid values:

    • BGP (default)
    • BGP_PRO

    For more information about BGP (Multi-ISP) lines and BGP (Multi-ISP) Pro lines, see the "Line types" section in the What is EIP? topic.

    • If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

      • ChinaTelecom
      • ChinaUnicom
      • ChinaMobile
      • ChinaTelecom_L2
      • ChinaUnicom_L2
      • ChinaMobile_L2

    • If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    		BGP
    NamestringNo

    The name of the IP address pool.

    This parameter is optional. The name must be 1 to 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.

    		AddressPoolName
    DescriptionstringNo

    The description of the IP address pool.

    This parameter is optional. The description must be 2 to 256 characters in length, and cannot start with http:// or https://.

    		AddressPoolDescription
    ClientTokenstringNo

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

    You can use the client to generate a value, and you must make sure that each request has a unique token value. The client token can contain only ASCII characters.

    Note If you do not specify this parameter, the system automatically uses the value of RequestId as the value of ClientToken. The value of RequestId for each API request is different.
    		02fb3da4-130e-11****
    DryRunbooleanNo

    Specifies whether to precheck only this request. Valid values:

    • true: prechecks the request without creating an IP address pool. The system checks the required parameters, request format, and service limits. If the request fails to pass the precheck, an error code is returned. If the request passes the precheck, the DryRunOperation error code is returned.
    • false: sends the request. This is the default value. If the request passes the precheck, a 2xx HTTP status code is returned and the IP address pool is created.
    		false
    ResourceGroupIdstringNo

    The ID of the resource group to which the IP address pool belongs.

    		rg-acfmxazb4pcdvf****
    RegionIdstringYes

    The ID of the region where you want to create the IP address pool.

    		cn-chengdu
    BizTypestringNo

    The service type of the IP address pool. Valid values:

    • CloudBox Only cloud box users can select this type.
    • Default: This is the default value.
    		Default
    ZonesarrayNo

    The zone of the IP address pool. If you set BizType to CloudBox, this parameter is required.

    stringNo

    The zone of the IP address pool. If you set BizType to CloudBox, this parameter is required. You can specify only one zone.

    		ap-southeast-1-lzdvn-cb
    Tagobject []No

    The tag of the resource.

    KeystringNo

    The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string.

    A tag key can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

    		FinanceDept
    ValuestringNo

    The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string.

    The tag value can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

    		FinanceJoshua
    SecurityProtectionTypesarrayNo

    The editions of Anti-DDoS.

    • If you do not specify this parameter, Anti-DDoS Origin Basic is used.
    • If you set the parameter to AntiDDoS_Enhanced, Anti-DDoS Pro/Premium is used.
    stringNo

    The editions of Anti-DDoS.

    • If you do not specify this parameter, Anti-DDoS Origin Basic is used.
    • If you set the parameter to AntiDDoS_Enhanced, Anti-DDoS Pro/Premium is used.
    		AntiDDoS_Enhanced

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned data.

    PulbicIpAddressPoolIdstring

    The ID of the IP address pool.

    		pippool-6wetvn6fumkgycssx****
    RequestIdstring

    The request ID.

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

    The ID of the resource group to which the IP address pool belongs.

    		rg-acfmxazb4pcdvf****

    Examples

    Sample success responses

    JSONformat

    {
  "PulbicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****",
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "ResourceGroupId": "rg-acfmxazb4pcdvf****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParam.IspThe param of Isp [%s] is illegal.The error message returned because the Isp parameter is set to an invalid value. Specify a valid value and try again.
    400IllegalParam.NameThe param of Name [%s] is illegal.The error message returned because the Name parameter is set to an invalid value. Specify a valid value and try again.
    400IllegalParam.DescriptionThe param of Description [%s] is illegal.The error message returned because the Description parameter is set to an invalid value. Specify a valid values and try again.
    400Forbidden.CreatePublicIpAddressPoolAuthentication is failed for creating public ip address pool.The error message returned because you cannot create an IP address pool. Check whether you have the relevant permissions.
    400QuotaExceeded.PublicIpAddressPoolThe quota of PublicIpAddressPool is exceeded.The error message returned because the number of your IP address pools has reached the upper limit. Request a quota increase.
    400MissingParam.ZonesThe Zones parameter is required.Zones is required.
    400UnsupportedRegionThe feature is not supported in current region.The feature is not supported in the current region.
    400IllegalParam.ZonesThe values of Zones [%s] are invalid.Zones is set to an invalid value.
    400IllegalParamSize.ZonesAn invalid number of zones is specified.Zones is set to an invalid value.
    400UnsupportedFeature.IspThe feature of Isp is not supported.The ISP you specified is not currently supported.
    400OperationDenied.ISPNotSupportDdosEnhancedThe operation is not allowed because of DdosEnhanced is not supported by current isp.The current ISP does not support the creation of an enhanced security protection address pool.
    400IllegalParam.SecurityProtectionTypesThe param of securityProtectionTypes is illegal.The passed-in SecurityProtectionTypes parameter is invalid.

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

    Change history

    Change timeSummary of changesOperation
    2024-03-04The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Output ParametersThe response structure of the API has changed.
    2024-01-22The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: SecurityProtectionTypes
    2023-12-08The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-08-08The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: BizType
      Added Input Parameters: Zones
    2023-07-10The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Tag