CheckCanAllocateVpcPrivateIpAddress - Virtual Private Cloud

Checks whether a private IP address in a specified vSwitch is available.

debugging

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the vSwitch to which the private IP address that you want to query belongs. You can call the DescribeRegions operation to query the most recent region list.	cn-qingdao
VSwitchId	string	Yes	The ID of the vSwitch to which the private IP address to be queried belongs.	vsw-m5ew3t46z2drmifnt****
PrivateIpAddress	string	Yes	To query whether a private IP address is available, the private IP address must belong to the vSwitch specified by the VSwitchId parameter.	10.0.0.7
IpVersion	string	No	The version of the private IP address. Valid values: ipv4 If you want to query an IPv4 address, this parameter is optional. ipv6 If you want to query an IPv6 address, this parameter is required.	ipv4

Parameter	Type	Description	Example
	object	Schema object
CanAllocate	boolean	Indicates whether the private IP address is available. Valid values: true false	true
RequestId	string	The request ID.	93360B0-2969-40BF-8542-EBB34FD358AB

Sample success responses

JSONformat

{
  "CanAllocate": true,
  "RequestId": "93360B0-2969-40BF-8542-EBB34FD358AB"
}

HTTP status code	Error code	Error message	Description
400	PARAMETER_ILLEGAL	Parameter illegal.Parameter is ipVersion	-
400	ResourceNotFound.VSwitchId	The specified resource vswitch is not found.	-
400	Mismatch.VSwitchAndPrivateIpAddress	The vswitch and privateIpAddress are mismatched.	The specified private IP address does not match the vSwitch.

For a list of error codes, visit the Service error codes.