All Products
Search
Document Center

Virtual Private Cloud:GetVSwitchCidrReservationUsage

Last Updated:Oct 26, 2026

Queries the usage of the reserved CIDR block 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:GetVSwitchCidrReservationUsage

get

*VSwitchCidrReservation

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

None None

Request parameters

Parameter

Type

Required

Description

Example

VSwitchCidrReservationId

string

Yes

The instance ID of the reserved CIDR block for a vSwitch that you want to query.

vcr-bp1m12saqteraw3rp****

NextToken

string

No

The token for the next query. Valid values:

  • Leave this parameter empty for the first request or when no next query is required.

  • If a next query is required, set the value 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 subsequent query is required.

  • If NextToken is returned, the value indicates the token for the next query.

FFmyTO70tTpLG6I3FmYAXGKPd****

TotalCount

integer

The total number of entries.

10

MaxResults

integer

The number of entries returned per page.

10

CidrReservationUsages

array<object>

The list of allocated reserved CIDR block for a vSwitch.

object

The list of allocated reserved CIDR block for a vSwitch.

VSwitchCidrReservationId

string

The instance ID of the reserved CIDR block for a vSwitch.

vcr-bp1m12saqteraw3rp****

VSwitchId

string

The ID of the vSwitch to which the reserved CIDR block belongs.

vsw-25navfgbue4g****

ResourceId

string

The instance ID of the elastic network interfaces (ENIs) allocated from the reserved CIDR block.

eni-bp14v2sdd3v8htln****

ResourceType

string

The type of the instance allocated from the reserved CIDR block. Valid values: NetworkInterface, which indicates elastic network interfaces (ENIs).

NetworkInterface

IpPrefixId

string

The instance ID of the reserved CIDR block that is allocated by prefix.

vcr-bp1m12saqteraw3rp****

IpPrefixCidr

string

The prefix CIDR block allocated to elastic network interfaces (ENIs) from the current reserved CIDR block.

192.168.1.64/28

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 10,
  "MaxResults": 10,
  "CidrReservationUsages": [
    {
      "VSwitchCidrReservationId": "vcr-bp1m12saqteraw3rp****",
      "VSwitchId": "vsw-25navfgbue4g****",
      "ResourceId": "eni-bp14v2sdd3v8htln****",
      "ResourceType": "NetworkInterface",
      "IpPrefixId": "vcr-bp1m12saqteraw3rp****",
      "IpPrefixCidr": "192.168.1.64/28"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 IllegalParam.NextToken The specified NextToken is invalid. The specified NextToken is invalid.
404 ResourceNotFound.CidrReservation The specified resource of VSwitchCidrReservation is not found. The error message returned because VSwitchCidrReservation is set to an invalid value.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.