CheckCanAllocateVpcPrivateIpAddress - Virtual Private Cloud

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:CheckCanAllocateVpcPrivateIpAddress	none	*VSwitch `acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}`	none	none

Request parameters

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

Response parameters

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

Examples

Sample success responses

JSONformat

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

Error codes

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.

Change history

Change time	Summary of changes	Operation
2024-12-16	The Error code has changed	View Change Details