CreateVSwitchCidrReservation - 创建交换机预留网段 - 专有网络 VPC

调用CreateVSwitchCidrReservation接口创建交换机预留网段。

接口说明

调用该接口创建交换机预留网段时，请注意以下事项：

VPC 中单个交换机 IPv4、IPv6 最大预留网段数目均为 10 个。
当您在交换机下添加预留网段后，该预留网段不能包含交换机对应的 VPC 的系统保留地址。
CreateVSwitchCidrReservation 接口属于异步接口，即系统会返回一个实例 ID，但该交换机预留网段尚未创建完成，系统后台任务仍在进行中。您可以调用 ListVSwitchCidrReservations 查询交换机预留网段的创建状态：
- 当交换机预留网段处于 Assigning 状态时，表示交换机预留网段正在分配中。
- 当交换机预留网段处于 Assigned 状态时，表示交换机预留网段已分配。
当您分配 IPv4 版本的交换机预留网段时，该交换机的第 1 个和最后 3 个 IP 地址为系统保留地址。这 4 个保留地址不会被分配出去。
当您分配 IPv6 版本的交换机预留网段时，该交换机的第 1 个和最后 9 个 IP 地址为系统保留地址。这 10 个保留地址不会被分配出去。以 IPv4 预留网段为例，例如交换机网段为 192.168.1.0/24，则系统保留地址为 192.168.1.0、192.168.1.253、192.168.1.254 和 192.168.1.255，分配的预留网段中不能包含这 4 个 IP 地址在内。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:CreateVSwitchCidrReservation	create	VSwitchCidrReservation `acs:vpc:{#regionId}:{#accountId}:vswitchcidrreservation/`	无	无

请求参数

名称	类型	必填	描述	示例值
Tag	array<object>	否	资源标签
	object	否	标签信息。
Key	string	否	资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。一个标签键最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	FinanceDept
Value	string	否	资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	FinanceJoshua
VSwitchId	string	是	要创建的交换机预留网段所属的交换机 ID。	vsw-25navfgbue4g****
VSwitchCidrReservationName	string	否	交换机预留网段的名称。名称长度为 2~128 个字符，以英文字母或中文开头，可包含数字、下划线（_）和短划线（-）。	ReservationName
VSwitchCidrReservationDescription	string	否	交换机预留网段的描述信息。不填则为空，默认值为空。描述长度为 2~256 个字符，以英文字母或中文开头，不能以`http://`和`https://`开头。	ReservationDescription
IpVersion	string	否	交换机预留网段的 IP 版本。取值： IPv4 （默认值）：IPv4 版本。 IPv6：IPv6 版本。	IPv4
VSwitchCidrReservationMask	string	否	交换机预留网段的掩码。当 IpVersion 取值为 IPv4 时，交换机预留网段的掩码长度范围必须要大于所属交换机的 IPv4 网段掩码长度且最大不超过 28。当 IpVersion 取值为 IPv6 时，交换机预留网段的掩码长度范围必须要大于所属交换机的 IPv6 网段掩码长度且最大不超过 80。说明 VSwitchCidrReservationMask 参数和 VSwitchCidrReservationCidr 参数必须输入一个。当您在交换机下添加预留网段后，该预留网段不能包含交换机对应的 VPC 的系统保留地址。	28
VSwitchCidrReservationCidr	string	否	交换机预留网段。当 IpVersion 取值为 IPv4 时，交换机预留网段必须是其所属交换机 IPv4 网段的真子集且网段的掩码长度不超过 28。当 IpVersion 取值为 IPv6 时，交换机预留网段必须是其所属交换机 IPv6 网段的真子集且网段的掩码长度不超过 80。说明 VSwitchCidrReservationMask 参数和 VSwitchCidrReservationCidr 参数必须输入一个。当您在交换机下添加预留网段后，该预留网段不能包含交换机对应的 VPC 的系统保留地址。	192.168.1.64/28
VSwitchCidrReservationType	string	否	交换机预留网段的类型。取值：prefix，表示按段分配地址。说明用户及云服务自动为弹性网卡 ENI（Elastic Network Interface）分配网段时，必须从预留地址段分配。如果预留地址段的地址已经分配完，则系统会报错。	prefix
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会创建交换机预留网段。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行创建。	false
RegionId	string	是	交换机所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	交换机预留网段的实例 ID。
VSwitchCidrReservationId	string	交换机预留网段的实例 ID。	vcr-bp1m12saqteraw3rp****
RequestId	string	请求 ID。	54B48E3D-DF70-471B-AA93-08E683A1B45

示例

正常返回示例

JSON格式

{
  "VSwitchCidrReservationId": "vcr-bp1m12saqteraw3rp****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParamFormat	IllegalParamFormat	参数格式不正确
400	IllegalParamFormat.VSwitchCidrReservationCidr	The param format of VSwitchCidrReservationCidr is illegal.	VSwitchCidrReservationCidr参数格式非法
400	ResourceNotFound.VSwitch	The specified resource of VSwitch is not found.	指定的VSwitch实例不存在
400	UnsupportedFeature.ReservedType	The specified ReservedType is not supported.	指定的ReservedType未支持
400	UnsupportedFeature.VSwitchIpv6	The ipv6 feature of switch is not supported.	指定的VSwitch未开启Ipv6
400	OperationFailed.VSwitchCidrReservationCidr	The specified VSwitchCidrReservationCidr conflicts with existed cidr reservation or vswitch cidr.	指定的VSwitchCidrReservationCidr与已有的VSwitchCidrReservation网段冲突
400	MissingParam.CidrReservationMaskOrCidrReservationCidr	Either VSwitchCidrReservationMask or VSwitchCidrReservationCidr should be specified.	VSwitchCidrReservationMask和VSwitchCidrReservationCidr不能同时为空，请指定其中一个重试。
400	UnsupportedRegion	UnsupportedRegion	当前Region未支持该特性
400	UnsupportedFeature.VpcAdvancedFeature	UnsupportedFeature.VpcAdvancedFeature	你指定的VSwitch所在的VPC未支持高级特性，请更换其他VSwitch重试
400	QuotaExceeded.VSwitchCidrReservationMask	The quota of VSwitchCidrReservationMask is exceeded.	VSwitchCidrReservationMask 超出配额，请参考API文档参数说明修改后重试。
400	QuotaExceeded.CidrReservationCount	The quota of VSwitchCidrReservation is exceeded.	超过 VSwitchCidrReservation 的数量配额。
400	Conflict.CidrReservationMaskAndCidrReservationCidr	The specified VSwitchCidrReservationMask and VSwitchCidrReservationCidr is conflict.	指定的 VSwitchCidrReservationMask 和 VSwitchCidrReservationCidr 冲突，请根据API文档参数说明修改后重试。
400	OperationFailed.CidrNotEnoughInVSwitch	No enough cidr to allocate in this vswitch.	指定的vswitch已没有足够的cidr分配出CidrReservation。
400	OperationFailed.SystemReservedIpContained	The specified VSwitchCidrReservationCidr cannot contain system reserved IP addresses.	指定的VSwitchCidrReservationCidr不能包含系统预留IP地址
400	OperationFailed.AlreadyUsedIpContained	The specified VSwitchCidrReservationCidr cannot contain already used IP addresses.	指定的预留网段不能包含已被使用的IP地址。
400	IncorrectStatus.VSWITCH	The status of the specified VSwitch is invalid.	虚拟交换机状态异常。
400	IllegalParam.VSwitchCidrReservationMask	The specified VSwitchCidrReservationMask must be at least 2 bits greater than the vSwitch mask.	指定的 VSwitchCidrReservationMask 至少比 VSwitch 的掩码大 2。

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

变更历史

变更时间	变更内容概要	操作
2023-11-27	OpenAPI 错误码发生变更	查看变更详情