调用CreatePublicIpAddressPool接口创建IP地址池。

使用限制

IP地址池功能默认不开放。如需使用,请在配额中心申请IP地址池功能权益配额。具体操作,请参见通过配额中心提升配额

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

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

系统规定参数。取值:CreatePublicIpAddressPool

Isp String BGP

线路类型。取值:

  • BGP(默认值):BGP(多线)线路。目前全部地域都支持BGP(多线)线路EIP。
  • BGP_PRO:BGP(多线)_精品线路。目前仅中国香港、新加坡、马来西亚(吉隆坡)、菲律宾(马尼拉)、印度尼西亚(雅加达)和泰国(曼谷)地域支持BGP(多线)_精品线路EIP。

关于BGP(多线)线路和BGP(多线)_精品线路的更多信息,请参见EIP线路类型

  • 如果您是单线带宽的白名单用户,您还可以选择以下类型:
    • ChinaTelecom:中国电信
    • ChinaUnicom:中国联通
    • ChinaMobile:中国移动
    • ChinaTelecom_L2:中国电信L2
    • ChinaUnicom_L2:中国联通L2
    • ChinaMobile_L2:中国移动L2
  • 如果您是杭州金融云用户,该字段必填,取值:BGP_FinanceCloud
Name String AddressPoolName

地址池实例的名称。

描述可以为空,或输入1~128个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以http://https://开头。

Description String AddressPoolDescription

地址池实例的描述。

描述可以为空,或输入2~256个中英文字符,不能以http://或https://开头。

ClientToken String 02fb3da4-130e-11****

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

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

说明 若您未指定,则系统自动使用API请求的 RequestId作为 ClientToken标识。每次API请求的 RequestId可能不一样。
DryRun Boolean false

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

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

IP地址池所属的资源组ID。

RegionId String cn-chengdu

要创建的IP地址池所在的地域ID。

返回数据

名称 类型 示例值 描述
PulbicIpAddressPoolId String pippool-6wetvn6fumkgycssx****

IP地址池的实例ID。

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

请求ID。

ResourceGroupId String rg-acfmxazb4pcdvf****

IP地址池所属的资源组ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreatePublicIpAddressPool
&Isp=BGP
&Name=AddressPoolName
&Description=AddressPoolDescription
&ClientToken=02fb3da4-130e-11****
&DryRun=false
&ResourceGroupId=rg-acfmxazb4pcdvf****
&RegionId=cn-chengdu
&公共请求参数

正常返回示例

XML格式

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格式

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

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

错误码

HttpCode 错误码 错误信息 描述
400 IllegalParam.Isp The param of Isp [%s] is illegal. 参数 Isp 不合法,请根据请求参数规定重新输入。
400 IllegalParam.Name The param of Name [%s] is illegal. 参数 Name 不合法,请根据请求参数规定重新输入。
400 IllegalParam.Description The param of Description [%s] is illegal. 参数Description 不合法,请根据请求参数规定重新输入。
400 Forbidden.CreatePublicIpAddressPool Authentication is failed for creating public ip address pool. 您暂时无法创建 PublicIpAddressPool,请检查账号是否已授权该操作
400 QuotaExceeded.PublicIpAddressPool The quota of PublicIpAddressPool is exceeded. 您的PublicIpAddressPool数量已达配额,请提升配额后操作

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