Docs

Transit Router

DC gateway attachment

DescribeTransitRouterDirectConnectGatewayAttachments - Querying the list of DC Gateway attachments

Call DescribeTransitRouterDirectConnectGatewayAttachments to query Direct Connect (DC) Gateway attachments that meet the specified conditions.

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: DescribeTransitRouterDirectConnectGatewayAttachments

The interface name. The current API name is DescribeTransitRouterDirectConnectGatewayAttachments.

Version String required Example: 2020-04-01

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

TransitRouterId String required Example: tr-7qthudw0ll6jmc****

The ID of the Transit Router (TR) instance. You can call the DescribeTransitRouters API to obtain the TR instance ID.

PageNumber Integer optional Example: 1

The page number of the list. Default: 1.

PageSize Integer optional Example: 20

The number of entries on each page in a pagination query. Valid values: 1–100. Default: 20.

DirectConnectGatewayId String optional Example: dcgw-3tex2x1cwd4c6c0v****

The ID of the DC Gateway. You can call DescribeDirectConnectGateways to obtain the DC Gateway ID.

TagFilters.N.Key String optional Example: k1

The tag key of the network instance attachment.

N represents the serial number of the tag key, ranging from 1 to 10. Separate multiple tag keys with ampersands (&).

Specifying multiple tag keys means querying the network instance attachments that contain all specified tag keys.

TagFilters.N.Values.N String optional Example: v1

The tag value of the network instance attachment.

The first N represents the serial number of the tag key, ranging from 1 to 10.

The second N represents the serial number of the tag value, ranging from 1 to 3. The relationship between multiple tag values for the same tag key is a logical "OR". That is, the query returns resources tagged with any one of the specified values for that key.

Separate multiple tags with ampersands (&).

To provide this parameter, you must first provide TagFilters.N.Key.

When an empty value is set for this parameter, it means querying resources where the tag value is empty under the specified tag key.

TransitRouterAttachmentIds.N String optional Example: r-attach-7qthudw0ll6jmc****

The ID of the network instance attachment.

N represents the serial number of the network instance attachment, ranging from 1 to 100.

Separate multiple attachment IDs with ampersands (&).

Response parameters

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

PageSize Integer Example: 20

Number of entries per page in the current pagination.

PageNumber Integer Example: 1

The current page number.

TotalCount Integer Example: 2

The total number of qualified DC Gateway attachments.

TransitRouterAttachments Object[] Example: -

The details of qualified DC Gateway attachments.

TransitRouterId String Example: tr-7qthudw0ll6jmc****

The ID of the Transit Router (TR) instance.

TransitRouterAttachmentId String Example: tr-attach-13n2l4c****

The ID of the network instance attachment.

TransitRouterAttachmentName String Example: trattachment-01

The name of the network instance attachment.

Description String Example: This attachment is used for test.

The description of the network instance attachment.

DirectConnectGatewayId String Example: dcg-3tex2x1cwd4c6c0v****

The ID of the DC Gateway.

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

The time when the network instance attachment is created.

UpdateTime String Example: 2021-04-10T09:18:28+08:00

The time when the network instance attachment is last modified.

Tags Object[] Example: -

The tag information of the network instance attachment.

Key String Example: k1

The tag key of the tag.

Value String Example: v1

The tag value.

AccountId String Example: 210000****

The account ID of the network instance attachment.

Ipv6Enabled Boolean Example: false

Describe whether to enable IPv6.

true: Yes.

false: No.

AutoPublishRouteEnabled Boolean Example: false

Describe whether to automatically publish TR routes to the route table of the network instance.

true: Yes.

false: No.

Status String Example: Available

The status of the network instance attachment.

Creating

Deleting

Pending: Configuration in progress.

Available

Bandwidth Integer Example: 10

The maximum bandwidth for the network instance attachment, measured in Gbps.

Request examples

GET /?Action=DescribeTransitRouterDirectConnectGatewayAttachments&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc**** HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250804T034526Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
  "ResponseMetadata": {​
    "RequestId": "202508041145280620662330301548E8",​
    "Action": "DescribeTransitRouterDirectConnectGatewayAttachments",​
    "Version": "2020-04-01",​
    "Service": "transitrouter",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "PageSize": 20,​
    "PageNumber": 1,​
    "TotalCount": 2,​
    "TransitRouterAttachments": [​
      {​
        "TransitRouterId": "tr-7qthudw0ll6jmc****",​
        "TransitRouterAttachmentId": "tr-attach-13n2l4c****",​
        "TransitRouterAttachmentName": "trattachment-01",​
        "Description": "This attachment is used for test.",​
        "DirectConnectGatewayId": "dcg-3tex2x1cwd4c6c0v****",​
        "CreationTime": "2021-04-09T08:36:47+08:00",​
        "UpdateTime": "2021-04-10T09:18:28+08:00",​
        "Tags": [​
          {​
            "Key": "k1",​
            "Value": "v1"​
          }​
        ],​
        "AccountId": "210000****",​
        "Ipv6Enabled": "false",​
        "AutoPublishRouteEnabled": true,​
        "Status": "Available",​
        "Bandwidth": 10​
      }​
    ]​
  }​
}​

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	Explanation
400	InvalidPage.Malformed	The specified page is malformed.	The specified pagination parameter is invalid.
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	The index order format of the specified tag filter is invalid.
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	The tag key for filtering is invalid.
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	The tag value for filtering is invalid.
400	LimitExceeded.ResourceIds	You've reached the limit of 100 resource IDs that can be specified in this request.	The request contains invalid or unsupported parameters. The maximum number of resource query results is 100.
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	You have reached the maximum number of tag keys that you can specify for filtering in a single request.
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	You have reached the maximum number of tag values that you can specify for filtering in a single request.

Last updated: 2026.03.11 11:24:56