Use ListVSwitchCidrReservations to query CIDR reservations for vSwitches - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Queries reserved CIDR blocks of vSwitches.

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:ListVSwitchCidrReservations

list

*VSwitchCidrReservation

acs:vpc:{#regionId}:{#accountId}:vswitchcidrreservation/*

None

Request parameters

Parameter	Type	Required	Description	Example
Tags	array<object>	No	The tags.
	object	No
Key	string	No	The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string. A tag key can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.	FinanceDept
Value	string	No	The tag value. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length, and cannot start with acs: or aliyun. It cannot contain http:// or https://.	FinanceJoshua
VSwitchId	string	No	The ID of the vSwitch for which you want to query reserved CIDR blocks.	vsw-25navfgbue4g****
VSwitchCidrReservationIds	array	No	The ID of the reserved CIDR block. You can specify at most 10 IDs.
	string	No	The ID of the reserved CIDR block. You can specify at most 10 IDs.	vcr-bp1m12saqteraw3rp****
VSwitchCidrReservationType	string	No	The type of the reserved CIDR block. Set the value to prefix. Note When you allocate CIDR blocks, or enable the service to automatically allocate CIDR blocks to elastic network interfaces (ENIs), the CIDR blocks to allocate must fall into the reserved CIDR block. If the reserved CIDR is exhausted, an error message is returned.	prefix
IpVersion	string	No	The IP version of the reserved CIDR block. Valid values: IPv4 (default) IPv6	IPv4
NextToken	string	No	The pagination token for the next request. Valid values: You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
RegionId	string	Yes	The region ID of the vSwitch. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45
NextToken	string	A pagination token for the next request. Valid values: If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that determines the start point of the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries returned.	10
MaxResults	integer	The number of entries per page.	10
VSwitchCidrReservations	array<object>	A list of reserved CIDR blocks.
	array<object>
VpcId	string	The virtual private cloud (VPC) that the reserved CIDR block belongs to.	vpc-bp1wdz2pdhgurz1od****
VSwitchId	string	The vSwitch that the reserved CIDR block belongs to.	vsw-25navfgbue4g****
VSwitchCidrReservationId	string	The ID of the reserved CIDR block.	vcr-bp1m12saqteraw3rp****
VSwitchCidrReservationCidr	string	The reserved CIDR block.	192.168.1.64/28
VSwitchCidrReservationName	string	The name of the reserved CIDR block.	ReservationName
VSwitchCidrReservationDescription	string	The description of the reserved CIDR block.	ReservationDescription
IpVersion	string	The IP version of the reserved CIDR block. Valid values: IPv4 (default) IPv6	IPv4
CreationTime	string	The time when the reserved CIDR block was created.	2023-03-14T10:02:37Z
Type	string	The type of the reserved CIDR block. Valid value: prefix. CIDR blocks are allocated from this reserved block.	prefix
AvailableCidrCount	integer	The number of available prefixes in the reserved CIDR block.	10
AssignedCidrCount	integer	The number of used prefixes in the reserved CIDR block.	6
Status	string	The status of the reserved CIDR block. Valid values: Assigning Assigned Releasing Released	Assigned
Tags	array<object>	The tags.
	object
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	The specified NextToken is invalid.	The specified NextToken is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.