All Products
Search
Document Center

Virtual Private Cloud:GetVpcRouteEntrySummary

Last Updated:Nov 13, 2024

Queries route types.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:GetVpcRouteEntrySummarylist
  • RouteTable
    acs:vpc:{#regionId}:{#accountId}:routetable/{#routetableId}
  • VPC
    acs:vpc:{#regionId}:{#accountId}:vpc/{#vpcId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VpcIdstringYes

The ID of the virtual private cloud (VPC) to which the route table belongs.

vpc-bp15zckdt37pq72****
RouteTableIdstringNo

The ID of the route table that you want to query.

vtb-bp145q7glnuzdvzu2****
RouteEntryTypestringYes

The type of the route. Valid values:

  • All: all route types
  • Custom: a custom route
  • System: a system route
  • BGP: a BGP route
  • CEN: a Cloud Enterprise Network (CEN) route
Custom
RegionIdstringYes

The region ID of the route table.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

DC668356-BCB4-42FD-9BC3-FA2B2E04B634
RouteEntrySummarysarray<object>

The information about the routes in the route tables.

RouteEntrySummarysobject
RouteTableIdstring

The ID of the route table.

vtb-bp145q7glnuzdvzu2****
EntrySummarysarray<object>

The information about the routes of different types in one route table.

EntrySummarysobject
RouteEntryTypestring

The type of the route. Valid values:

  • All: all route types
  • Custom: a custom route
  • System: a system route
  • BGP: a BGP route
  • CEN: a CEN route
Custom
Countinteger

The number of entries returned.

10

Examples

Sample success responses

JSONformat

{
  "RequestId": "DC668356-BCB4-42FD-9BC3-FA2B2E04B634",
  "RouteEntrySummarys": [
    {
      "RouteTableId": "vtb-bp145q7glnuzdvzu2****",
      "EntrySummarys": [
        {
          "RouteEntryType": "Custom",
          "Count": 10
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-07-31The Error code has changedView Change Details
2023-07-21API Description UpdateView Change Details