Docs

Direct Connect

DC Gateway route

DescribeDirectConnectGatewayRouteAttributes - Querying a specified DC Gateway route

Call DescribeDirectConnectGatewayRouteAttributes to query the detailed information of a specified Direct Connect (DC) Gateway route.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.

Action String required Example: DescribeDirectConnectGatewayRouteAttributes

The interface name. The current API name is DescribeDirectConnectGatewayRouteAttributes.

Version String required Example: 2020-04-01

The interface version. The current API version is 2020-04-01.

DirectConnectGatewayRouteId String required Example: dcr-2752hzaqrwfeo7f****

The ID of the DC Gateway to be queried.

You can call DescribeDirectConnectGatewayRoutes to query the ID of the static route for the DC Gateway.

Response parameters

The following only details response parameters specific to this API. For more information, see Response structure.

AccountId String Example: 21000*****

The ID of the account to which the DC Gateway route belongs.

DirectConnectGatewayId String Example: dcg-7qthudw0ll6jmc****

The ID of the DC Gateway.

DirectConnectGatewayRouteId String Example: dcr-2752hzaqrwfeo7f****

The ID of the DC Gateway route.

DestinationCidrBlock String Example: 172.XX.XX.0/24

The destination CIDR block of the DC Gateway route.

NextHopId String Example: dcv-13fszmm1xdssg3n6nu4x9****

The ID of the next hop instance for the DC Gateway route.

NextHopType String Example: VIF

The type of the next hop instance for the DC Gateway route. Values:

VIF: DC Virtual Interface

CEN: Cloud Enterprise Network

TransitRouter: Transit Router (TR)

RouteType String Example: Static

The type of the DC Gateway route. Values:

BGP: BGP dynamic route

Static: Static route

CEN: CEN route. The routes synchronized from a CEN after a DC Gateway are attached to it.

CreationTime String Example: 2021-04-09T08:36:47+08:00

The time when the DC Gateway route is created.

Status String Example: Available

The status of the DC Gateway route.

Creating

Deleting

Pending: In the configuring process.

Available

Request examples

GET /?Action=DescribeDirectConnectGatewayRouteAttributes&Version=2020-04-01&DirectConnectGatewayRouteId=dcr-2752hzaqrwfeo7f**** HTTP/1.1​
Host: directconnect.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/directconnect/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
    "ResponseMetadata": {​
        "RequestId": "2021111616110801021214619****",​
        "Action": "DescribeDirectConnectGatewayRouteAttributes",​
        "Version": "2020-04-01",​
        "Service": "directconnect",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "RequestId": "2021111616110801021214619****",​
        "AccountId": "210000****",​
        "DirectConnectGatewayId": "dcg-7qthudw0ll6jmc****",​
        "DirectConnectGatewayRouteId": "dcr-2752hzaqrwfeo7f****",​
        "DestinationCidrBlock": "172.XX.XX.0/24",​
        "NextHopId": "dcv-13fszmm1xdssg3n6nu4x9****",​
        "NextHopType": "VIF",​
        "RouteType": "Static",​
        "CreationTime": "2021-12-15T17:05:42+08:00",​
        "Status": "Available"​
    }​
}​

Error codes

The table below describes the error codes for this API that are associated with business logic. For more information, see Common error codes.

Status code	Error codes	Error message	Description
404	InvalidDirectConnectGatewayRoute.NotFound	The specified direct connect gateway route does not exist.	The specified DC Gateway route does not exist.

Last updated: 2026.02.28 14:52:33