Help Center/ Enterprise Router/ API Reference/ APIs/ Routes/ Querying Details About a Static Route

Updated on 2026-03-20 GMT+08:00

View PDF

Querying Details About a Static Route

Function

This API is used to query the details about a static route.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
er:staticRoutes:get	Read	routeTables *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	er:routes:get	-

URI

GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
route_table_id	Yes	String	Route table ID
route_id	Yes	String	Route ID

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
route	Route object	Route
request_id	String	Request ID

**Table 3** Route
Parameter	Type	Description
id	String	Route ID
type	String	Definition: Route type. Range: static: Static route.
state	String	Definition: Route status. Range: pending available modifying deleting deleted failed
is_blackhole	Boolean	Whether the route is a blackhole route
destination	String	Destination address of a route
attachments	Array of RouteAttachment objects	Next hops
route_table_id	String	Route table ID
created_at	String	Creation time in the format of YYYY-MM-DDTHH:mm:ss.sssZ
updated_at	String	Update time in the format of YYYY-MM-DDTHH:mm:ss.sssZ
description	String	Route description

**Table 4** RouteAttachment
Parameter	Type	Description
resource_id	String	Attached resource ID
resource_type	String	Attachment type. vpc: VPC vpn: VPN gateway vgw: Direct Connect virtual gateway peering: peering connection. A cloud connection is used to connect two enterprise routers from different regions to form a peering connection attachment. gdgw: global DC gateway
attachment_id	String	Attachment ID

Example Requests

GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/19d334b7-78c1-4e0e-ba29-b797e641e23c/static-routes/19d334b7-78c1-4e0e-ba29-b797e641e23c

Example Responses

Status code: 200

{
  "route" : {
    "id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
    "type" : "static",
    "destination" : "192.168.0.0/16",
    "description" : "static route",
    "attachments" : [ {
      "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
      "resource_type" : "VPC",
      "attachment_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289"
    } ],
    "route_table_id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
    "is_blackhole" : false,
    "state" : "pending",
    "created_at" : "2020-03-11T15:13:31",
    "updated_at" : "2020-03-11T15:13:31"
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}