Check private IP address availability in a vSwitch with CheckCanAllocateVpcPrivateIpAddress - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:CheckCanAllocateVpcPrivateIpAddress

none

*vSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the vSwitch to which the private IP address 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 belongs.	vsw-m5ew3t46z2drmifnt****
PrivateIpAddress	string	Yes	The private IP address to check. The 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: Optional for IPv4 address queries. ipv6: Required for IPv6 address queries.	ipv4

Response elements

Element	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

Success response

JSON format

{
  "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.
400	IllegalParam.PrivateIpAddress	The specified PrivateIpAddress is illegal.	The specified PrivateIpAddress is invalid. Check the parameter constraints and try again after modification.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.