CreateIpamPoolAllocation_IP地址管理_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
RegionIdstring

要创建的自定义预留网段所在的地域 ID。展开详情

示例值:cn-hangzhou
IpamPoolIdstring

IPAM 地址池的实例 ID。

示例值:ipam-pool-6rcq3tobayc20t****参考取值来源:
    AddIpamPoolCidr
    ListIpamPools
    CreateIpamPool
    GetIpamPoolAllocation
Cidrstring

通过输入地址段的方式从 IPAM 地址池创建自定义预留网段。展开详情

示例值:192.168.1.0/24参考取值来源:
    AddIpamPoolCidr
CidrMaskinteger<int32>

通过输入掩码的方式从 IPAM 地址池创建自定义预留网段。展开详情

示例值:24
DryRunboolean

是否只预检此次请求。取值:展开详情

示例值:false
ClientTokenstring

客户端 Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。展开详情

示例值:123e4567-e89b-12d3-a456-426655440000
IpamPoolAllocationDescriptionstring

自定义预留网段的描述信息。展开详情

示例值:test description
IpamPoolAllocationNamestring

自定义预留网段的名称。展开详情

示例值:test name参考取值来源:
    GetIpamPoolAllocation
    ListIpamPoolAllocations

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2
IpamPoolAllocationIdstring

创建的自定义预留网段的实例 ID。

示例值:ipam-pool-alloc-112za33e4****
Cidrstring

创建的自定义预留网段。

示例值:192.168.1.0/24
SourceCidrstring

源地址段。

示例值:192.168.0.0/16

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
OperationDenied.ResourceTypeIsNotCustom
The operation is not allowed because the resource type is not Custom.诊断
400
MissingParam.CidrOrCidrMask
The CIDR or CIDR Mask must be input.诊断
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.诊断
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.诊断
400
IllegalParam.CidrMask
The specified CidrMask is illegal.诊断
400
DryRunOperation
Request validation has been passed with DryRun flag set.诊断
400
OperationDenied.AvailableCidrInsufficient
The operation is not allowed because available CIDR is insufficient.诊断
400
OperationDenied.CidrInExcludeCidrs
The operation is not allowed because the input CIDR is within the illegal CIDRs.诊断
400
OperationDenied.CidrUnavailableInPool
The operation is not allowed because the CIDR is unavailable in the IPAM pool.诊断
404
ResourceNotFound.IpamPool
The dependent IPAM pool is not found.诊断

变更历史

变更时间变更内容概要操作
2024-12-19
变更错误码400
2024-10-28
新增请求参数IpamPoolAllocationDescription
新增请求参数IpamPoolAllocationName

相关示例