CreateIpamPoolAllocation - 从IPAM地址池创建自定义预留网段

从IPAM地址池创建自定义预留网段。

接口说明

创建自定义预留网段前，请确保您已经创建了 IPAM 地址池并为该地址池添加了 CIDR。您可以通过调用 CreateIpamPool 和 AddIpamPoolCidr 分别创建 IPAM 地址池并为地址池添加 CIDR。
指定参数 Cidr 或 CidrMask 创建自定义预留网段时，对应的掩码需要在 IPAM 地址池规定的范围内。
当 IPAM 地址池具备地域属性时，创建自定义预留网段的请求需要从地址池所在的地域发起。
需要创建的自定义预留网段不能和 IPAM 地址池已创建的 CIDR 分配冲突。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:CreateIpamPoolAllocation	create	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	要创建的自定义预留网段所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
IpamPoolId	string	是	IPAM 地址池的实例 ID。	ipam-pool-6rcq3tobayc20t****
Cidr	string	否	通过输入地址段的方式从 IPAM 地址池创建自定义预留网段。说明参数 Cidr 或 CidrMask 至少输入一个。	192.168.1.0/24
CidrMask	integer	否	通过输入掩码的方式从 IPAM 地址池创建自定义预留网段。说明参数 Cidr 或 CidrMask 至少输入一个。	24
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会创建自定义预留网段。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码 DryRunOperation。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接创建。	false
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-426655440000
IpamPoolAllocationDescription	string	否	自定义预留网段的描述信息。长度为 1～256 个字符，必须以大小写英文字母或中文字符开头，但不能以`http://`或`https://`开头。不填则为空，默认值为空。	test description
IpamPoolAllocationName	string	否	自定义预留网段的名称。长度为 1～128 个字符，不能以`http://`或`https://`开头。	test name

返回参数

名称	类型	描述	示例值
	object	返回的信息列表。
RequestId	string	请求 ID。	CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2
IpamPoolAllocationId	string	创建的自定义预留网段的实例 ID。	ipam-pool-alloc-112za33e4****
Cidr	string	创建的自定义预留网段。	192.168.1.0/24
SourceCidr	string	源地址段。	192.168.0.0/16

示例

正常返回示例

JSON格式

{
  "RequestId": "CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2",
  "IpamPoolAllocationId": "ipam-pool-alloc-112za33e4****",
  "Cidr": "192.168.1.0/24",
  "SourceCidr": "192.168.0.0/16"
}

错误码

HTTP status code	错误码	错误信息	描述
400	OperationDenied.ResourceTypeIsNotCustom	The operation is not allowed because the resource type is not Custom.	操作被拒绝，原因是资源类型不是Custom类型。
400	MissingParam.CidrOrCidrMask	The CIDR or CIDR Mask must be input.	从IPAM地址池分配资源或查询可用资源时，请输入Cidr或CidrMask。
400	OperationDenied.IpamPoolNotInRegion	The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.	操作被拒绝，因为无法从不具备地域属性的地址池中创建VPC或为VPC添加附加网段。
400	OperationDenied.RequestRegionInvalid	The operation is not allowed because the request is not invoked in the region of the IPAM pool.	操作被拒绝，因为未在地址池所在地域调用请求。
400	IllegalParam.Cidr	The specified CIDR is illegal.	指定的CIDR不合法。
400	IllegalParam.CidrMask	The specified CidrMask is illegal.	CidrMask参数不合法。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun校验通过。
400	OperationDenied.AvailableCidrInsufficient	The operation is not allowed because available CIDR is insufficient.	操作被拒绝，原因是可用的CIDR资源不足。
400	OperationDenied.CidrInExcludeCidrs	The operation is not allowed because the input CIDR is within the illegal CIDRs.	操作被拒绝，原因是输入的CIDR在不合法的CIDR范围内。
400	OperationDenied.CidrUnavailableInPool	The operation is not allowed because the CIDR is unavailable in the IPAM pool.	操作被拒绝，原因是CIDR在IPAM地址池中不可用。
404	ResourceNotFound.IpamPool	The dependent IPAM pool is not found.	依赖资源IPAM Pool不存在。

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

变更历史

变更时间	变更内容概要	操作
2024-10-28	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情