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

Queries the reserved CIDR blocks for a vSwitch.

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 tag information.
	object	No	The tag information.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. If you specify this parameter, you cannot enter an empty string. A tag key can be up to 128 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. If you specify this parameter, you can enter an empty string. A tag value can be up to 128 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://.	FinanceJoshua
VSwitchId	string	No	The ID of the vSwitch to which the reserved CIDR block that you want to query belongs.	vsw-25navfgbue4g****
VSwitchCidrReservationIds	array	No	The instance IDs of the reserved CIDR blocks for a vSwitch. You can specify up to 10 reserved CIDR blocks.
	string	No	The instance ID of the reserved CIDR block for a vSwitch. You can specify up to 10 reserved CIDR blocks.	vcr-bp1m12saqteraw3rp****
VSwitchCidrReservationType	string	No	The type of the reserved CIDR block for a vSwitch. Valid values: prefix, which indicates that addresses are allocated by CIDR block. Note When users and cloud services automatically allocate CIDR blocks for elastic network interfaces (ENIs), the CIDR blocks must be allocated from the reserved CIDR blocks. If all addresses in the reserved CIDR blocks are allocated, the system returns an error.	prefix
IpVersion	string	No	The IP version of the reserved CIDR block for a vSwitch. Valid values: IPv4 (default): IPv4. IPv6: IPv6.	IPv4
NextToken	string	No	The token for the next query. Valid values: Leave this parameter empty for the first query and when no next query is required. If a next query is required, set this parameter to the NextToken value returned from the previous API call.	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 region IDs.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45
NextToken	string	The token for the next query. Valid values: If NextToken is empty, no next query is required. If NextToken returns a value, the value indicates the token used to start the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries.	10
MaxResults	integer	The number of entries returned per page.	10
VSwitchCidrReservations	array<object>	The list of reserved CIDR blocks for a vSwitch.
	array<object>	The details of the reserved CIDR block for a vSwitch.
VpcId	string	The VPC to which the reserved CIDR block for a vSwitch belongs.	vpc-bp1wdz2pdhgurz1od****
VSwitchId	string	The ID of the vSwitch to which the reserved CIDR block for a vSwitch belongs.	vsw-25navfgbue4g****
VSwitchCidrReservationId	string	The instance ID of the reserved CIDR block for a vSwitch.	vcr-bp1m12saqteraw3rp****
VSwitchCidrReservationCidr	string	The reserved CIDR block for a vSwitch.	192.168.1.64/28
VSwitchCidrReservationName	string	The name of the reserved CIDR block for a vSwitch.	ReservationName
VSwitchCidrReservationDescription	string	The description of the reserved CIDR block for a vSwitch.	ReservationDescription
IpVersion	string	The IP version of the reserved CIDR block for a vSwitch. Valid values: IPv4 (default): IPv4. IPv6: IPv6.	IPv4
CreationTime	string	The time when the reserved CIDR block was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format and is displayed in UTC.	2023-03-14T10:02:37Z
Type	string	The type of the reserved CIDR block for a vSwitch. Valid values: prefix (default), which indicates that addresses are allocated by CIDR block.	prefix
AvailableCidrCount	integer	The number of available prefix CIDR blocks in the reserved CIDR block for a vSwitch.	10
AssignedCidrCount	integer	The number of used prefix CIDR blocks in the reserved CIDR block for a vSwitch.	6
Status	string	The status of the reserved CIDR block. Valid values: Assigning: The CIDR block is being allocated. Assigned: The CIDR block is allocated. Releasing: The CIDR block is being released. Released: The CIDR block is released.	Assigned
Tags	array<object>	The list of tags.
	object	The tag.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 10,
  "MaxResults": 10,
  "VSwitchCidrReservations": [
    {
      "VpcId": "vpc-bp1wdz2pdhgurz1od****",
      "VSwitchId": "vsw-25navfgbue4g****",
      "VSwitchCidrReservationId": "vcr-bp1m12saqteraw3rp****",
      "VSwitchCidrReservationCidr": "192.168.1.64/28",
      "VSwitchCidrReservationName": "ReservationName",
      "VSwitchCidrReservationDescription": "ReservationDescription",
      "IpVersion": "IPv4",
      "CreationTime": "2023-03-14T10:02:37Z",
      "Type": "prefix",
      "AvailableCidrCount": 10,
      "AssignedCidrCount": 6,
      "Status": "Assigned",
      "Tags": [
        {
          "Key": "FinanceDept",
          "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.