All Products
Search

This Product

    Virtual Private Cloud:GetVSwitchCidrReservationUsage

    Document Center

    Virtual Private Cloud:GetVSwitchCidrReservationUsage

    Last Updated:Aug 28, 2026

    Queries the usage of a reserved CIDR block in 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 ID of the reserved CIDR block.

    vcr-bp1m12saqteraw3rp****
    NextToken

    string

    No

    The pagination token that is used in the next request to retrieve a new page of results. Valid values:

    • You do not need to specify this parameter for the first request.

    • If a value is returned for NextToken, specify the value in the next request to retrieve a new page of results.

    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 to return per page.

    10
    CidrReservationUsages

    array<object>

    A list of reserved CIDR blocks that are in use.

    object

    VSwitchCidrReservationId

    string

    The ID of the reserved CIDR block.

    vcr-bp1m12saqteraw3rp****
    VSwitchId

    string

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

    vsw-25navfgbue4g****
    ResourceId

    string

    The ID of the elastic network interface (ENI) whose CIDR block is allocated from the reserved CIDR block.

    eni-bp14v2sdd3v8htln****
    ResourceType

    string

    The type of resource that uses a CIDR block from the reservation. Only NetworkInterface (ENI) may be returned.

    NetworkInterface
    IpPrefixId

    string

    The ID of the reserved CIDR block.

    vcr-bp1m12saqteraw3rp****
    IpPrefixCidr

    string

    The CIDR block allocated to the ENI from the reserved CIDR block.

    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.