All Products
Search
Document Center

ENS:DescribeEnsRouteEntryList

Last Updated:Mar 12, 2024

Queries route entries.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RouteTableIdstringYes

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

vtb-hp3wdhynneo7fsclox8hs
RouteEntryIdstringNo

The ID of the route that you want to query.

rte-8vbdw66evgv44u2u7v3hx
DestinationCidrBlockstringNo

The destination Classless Inter-Domain Routing (CIDR) block of the route entry.

11.0.0.0/16
RouteEntryTypestringNo

The route type. Valid values:

  • Custom: custom route
  • System: system route
Custom
NextHopTypestringNo

The type of next hop of the custom route entry. Valid values:

  • Instance: an ENS instance.
Instance
NextHopIdstringNo

The ID of the next hop.

i-2zecshuv3axtr2gc4noa
RouteEntryNamestringNo

The name of the route.

test0
PageNumberintegerNo

The page number of the returned page. Valid values: integers that are greater than 0. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Valid values: 10 to 100.

10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
RouteEntrysobject []

The information about the route.

Statusstring

The status of the route entry. Valid values:

Available
Typestring

The type of the route entry.

Custom
Descriptionstring

Enter a description for the route.

RouteEntryNamestring

The name of the route.

test0
DestinationCidrBlockstring

The destination CIDR block of the route.

101.0.45.0/24
RouteEntryIdstring

The ID of the route.

rte-2zeksx7h436f5unk349m1
RouteTableIdstring

The ID of the route table.

vtb-uf62p9o5cn35fi8xgurnm
NextHopsobject []

The information about the next hop.

NextHopIdstring

The ID of the next hop.

i-bp1111yup9991890woxq
NextHopTypestring

The type of the next hop. Valid values:

Instance
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The number of returned entries.

7

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "RouteEntrys": [
    {
      "Status": "Available",
      "Type": "Custom",
      "Description": "",
      "RouteEntryName": "test0",
      "DestinationCidrBlock": "101.0.45.0/24",
      "RouteEntryId": "rte-2zeksx7h436f5unk349m1",
      "RouteTableId": "vtb-uf62p9o5cn35fi8xgurnm",
      "NextHops": [
        {
          "NextHopId": "i-bp1111yup9991890woxq",
          "NextHopType": "Instance"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 7
}

Error codes

HTTP status codeError codeError message
400ens.interface.error An error occurred while call the API.
400Invalid%sThe specified parameter %s is invalid.
400Missing%sYou must specify the parameter %s.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

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

Change history

Change timeSummary of changesOperation
No change history