调用CreatePublicIpAddressPool创建IP地址池_专有网络VPC(VPC)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:CreatePublicIpAddressPool	create	PublicIpAddressPool acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/*	无	无

请求参数

名称	类型	必填	描述	示例值
Isp	string	否	线路类型。取值： BGP（默认值）：BGP（多线）线路。 BGP_PRO：BGP（多线）_精品线路。关于 BGP（多线）线路和 BGP（多线）_精品线路的更多信息，请参见 EIP 线路类型。如果您是单线带宽的白名单用户，您还可以选择以下类型： ChinaTelecom：中国电信 ChinaUnicom：中国联通 ChinaMobile：中国移动 ChinaTelecom_L2：中国电信 L2 ChinaUnicom_L2：中国联通 L2 ChinaMobile_L2：中国移动 L2 如果您是杭州金融云用户，该字段必填，取值：BGP_FinanceCloud。	BGP
Name	string	否	地址池实例的名称。长度为 0-128 个字符，不能以`http://`或`https://`开头。	AddressPoolName
Description	string	否	地址池实例的描述。长度为 0-256 个字符，不能以`http://`或`https://`开头。	AddressPoolDescription
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	02fb3da4-130e-11****
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会创建 IP 地址池。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。	false
ResourceGroupId	string	否	IP 地址池所属的资源组 ID。	rg-acfmxazb4pcdvf****
RegionId	string	是	要创建的 IP 地址池所在的地域 ID。	cn-chengdu
BizType	string	否	IP 地址池的业务类型。取值： CloudBox：云盒。仅云盒用户支持选择该类型。 Default（默认值）：默认，表示非特殊类型。	Default
Zones	array	否	IP 地址池的可用区。 BizType 取值为 CloudBox，即 IP 地址池业务类型为云盒时，该参数必填。
	string	否	IP 地址池的可用区。 BizType 取值为 CloudBox，即 IP 地址池业务类型为云盒时，该参数必填。目前仅支持传入 1 个可用区。	ap-southeast-1-lzdvn-cb
Tag	array<object>	否	资源的标签。
	object	否	标签。
Key	string	否	资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。一个标签键最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua
SecurityProtectionTypes	array	否	安全防护级别。配置为空时，默认为 DDoS 防护（基础版）。配置为AntiDDoS_Enhanced时，表示 DDoS 防护（增强版）。
	string	否	安全防护级别。配置为空时，默认为 DDoS 防护（基础版）。配置为AntiDDoS_Enhanced时，表示 DDoS 防护（增强版）。	AntiDDoS_Enhanced

返回参数

名称	类型	描述	示例值
	object	返回数据结构体。
PulbicIpAddressPoolId`deprecated`	string	IP 地址池的实例 ID。	pippool-6wetvn6fumkgycssx****
RequestId	string	请求 ID。	4EC47282-1B74-4534-BD0E-403F3EE64CAF
ResourceGroupId	string	IP 地址池所属的资源组 ID。	rg-acfmxazb4pcdvf****
PublicIpAddressPoolId	string	IP 地址池的实例 ID。	pippool-6wetvn6fumkgycssx****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
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数量已达配额，请提升配额后操作
400	MissingParam.Zones	The Zones parameter is required.	参数Zones必填
400	UnsupportedRegion	The feature is not supported in current region.	当前地域不支持该功能。
400	IllegalParam.Zones	The values of Zones [%s] are invalid.	参数Zones非法
400	IllegalParamSize.Zones	An invalid number of zones is specified.	Zones数组大小非法
400	UnsupportedFeature.Isp	The feature of Isp is not supported.	您指定的Isp暂未支持
400	OperationDenied.ISPNotSupportDdosEnhanced	The operation is not allowed because of DdosEnhanced is not supported by current isp.	当前ISP不支持创建增强型安全防护地址池。
400	IllegalParam.SecurityProtectionTypes	The param of securityProtectionTypes is illegal.	传入的SecurityProtectionTypes参数非法
400	IncorrectBusinessStatus.PublicIpAddressPool	The business status of publicIpAddressPool is incorrect.	当前业务状态不支持创建IP地址池实例。
400	OptInRequired.PublicIpAddressPool	You are not authorized to use the requested service of publicIpAddressPool. Ensure that you have subscribed to the service you are trying to use.	您无权使用请求的IP地址池服务。确保您已经订阅了您尝试使用的服务。

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

变更历史

变更时间	变更内容概要	操作
2024-05-27	OpenAPI 错误码发生变更	查看变更详情
2024-03-04	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-01-22	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-12-08	OpenAPI 错误码发生变更	查看变更详情
2023-08-08	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-07-10	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情