CreatePublicIpAddressPool -

Limits

By default, the IP address pool feature is unavailable. You can apply for the privilege to use the IP address pool feature on the Quota Center page. For more information, see Request a quota increase in the Quota Center console.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	CreatePublicIpAddressPool	The operation that you want to perform. Set the value to CreatePublicIpAddressPool.
Isp	String	No	BGP	The line type. Valid values: BGP (default) BGP_PRO For more information about BGP (Multi-ISP) and BGP (Multi-ISP) Pro, see Line types. If you are allowed to use single-ISP bandwidth, you can also choose 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.
Name	String	No	AddressPoolName	The name of the IP address pool. This parameter is optional. If you enter a name, 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://`.
Description	String	No	AddressPoolDescription	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://.
ClientToken	String	No	02fb3da4-130e-11****	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 client 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.
DryRun	Boolean	No	false	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 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.
ResourceGroupId	String	No	rg-acfmxazb4pcdvf****	The ID of the resource group to which the IP address pool belongs.
RegionId	String	Yes	cn-chengdu	The ID of the region where you want to create the IP address pool.
BizType	String	No	Default	The service type of the IP address pool. Valid values: CloudBox Only cloud box users can select this type. Default (default)
Zones.N	String	No	ap-southeast-1-lzdvn-cb	The zone of the IP address pool. If you set BizType to CloudBox, this parameter is required. You can specify only one zone.
Tag.N.Key	String	No	FinanceDept	The key of tag N to add to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string. The tag key can be at most 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.
Tag.N.Value	String	No	FinanceJoshua	The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length, but cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.

Response parameters

Parameter	Type	Example	Description
PulbicIpAddressPoolId	String	pippool-6wetvn6fumkgycssx****	The ID of the IP address pool.
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	The request ID.
ResourceGroupId	String	rg-acfmxazb4pcdvf****	The ID of the resource group to which the IP address pool belongs.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreatePublicIpAddressPool
&Isp=BGP
&Name=AddressPoolName
&Description=AddressPoolDescription
&ClientToken=02fb3da4-130e-11****
&DryRun=false
&ResourceGroupId=rg-acfmxazb4pcdvf****
&RegionId=cn-chengdu
&BizType=Default
&Zones=["ap-southeast-1-lzdvn-cb"]
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Sample success responses

XML format

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

<CreatePublicIpAddressPoolResponse>
    <PulbicIpAddressPoolId>pippool-6wetvn6fumkgycssx****</PulbicIpAddressPoolId>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <ResourceGroupId>rg-acfmxazb4pcdvf****</ResourceGroupId>
</CreatePublicIpAddressPoolResponse>

JSON format

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

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

Error codes

HttpCode	Error code	Error message	Description
400	IllegalParam.Isp	The param of Isp [%s] is illegal.	Isp is set to an invalid value. Specify a valid value and try again.
400	IllegalParam.Name	The param of Name [%s] is illegal.	Name is set to an invalid value. Specify a valid value and try again.
400	IllegalParam.Description	The param of Description [%s] is illegal.	Description is set to an invalid value. Specify a valid value and try again.
400	Forbidden.CreatePublicIpAddressPool	Authentication is failed for creating public ip address pool.	You cannot create an IP address pool. Check whether your account has the required permissions.
400	QuotaExceeded.PublicIpAddressPool	The quota of PublicIpAddressPool is exceeded.	The number of your IP address pools has reached the upper limit. Request a quota increase.
400	MissingParam.Zones	The Zones parameter is required.	You must specify Zones.
400	UnsupportedRegion	The feature is not supported in current region.	The feature is not supported in the current region.
400	IllegalParam.Zones	The values of Zones [%s] are invalid.	Zones is set to an invalid value.
400	IllegalParamSize.Zones	An invalid number of zones is specified.	Zones is set to an invalid value. The value length exceeds the upper limit.

For a list of error codes, see Service error codes.