调用ListTransitRouterPeerAttachments接口查询企业版转发路由器下的跨地域连接信息。

使用说明

您可以通过以下两种方式查询企业版转发路由器下跨地域连接的信息:

  • 通过企业版转发路由器实例ID查询该实例下所有跨地域连接的信息。
  • 通过云企业网实例ID和企业版转发路由器实例所属地域ID查询该企业版转发路由器实例下所有跨地域连接的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTransitRouterPeerAttachments

系统规定参数。取值:ListTransitRouterPeerAttachments

CenId String cen-j3jzhw1zpau2km****

云企业网实例ID。

RegionId String cn-hangzhou

企业版转发路由器实例所属的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

TransitRouterAttachmentId String tr-attach-5u4qbayfv2io5v****

跨地域连接ID。

TransitRouterId String tr-bp1su1ytdxtataupl****

企业版转发路由器实例ID。

MaxResults Integer 20

分批次查询时每次显示的条目数。默认值为20,最大值为100

NextToken String 1

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。

返回数据

名称 类型 示例值 描述
NextToken String dd20****

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0

请求ID。

TotalCount Integer 1

列表条目数。

MaxResults Integer 20

分批次查询时每次显示的条目数。

TransitRouterAttachments Array of TransitRouterAttachment

跨地域连接信息列表。

CreationTime String 2021-06-16T02:50Z

跨地域连接的创建时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mmZ

Status String Attached

跨地域连接的状态。

  • Attached:已加载。
  • Attaching:加载中。
  • Detaching:卸载中。
  • Detached:已卸载。
TransitRouterAttachmentId String tr-attach-5u4qbayfv2io5v****

跨地域连接ID。

BandwidthType String BandwidthPackage

带宽的分配方式。取值:

BandwidthPackage:从带宽包中分配带宽。

CenBandwidthPackageId String cenbwp-3xrxupouolw5ou****

跨地域连接绑定的带宽包ID。

TransitRouterAttachmentDescription String testdesc

跨地域连接的描述信息。

RegionId String cn-hangzhou

企业版转发路由器所属地域ID。

PeerTransitRouterId String tr-m5eq27g6bndum7e88****

对端转发路由器实例ID。

TransitRouterId String tr-bp1su1ytdxtataupl****

企业版转发路由器实例ID。

PeerTransitRouterRegionId String cn-qingdao

对端转发路由器实例所属地域ID。

ResourceType String TR

连接所关联的资源类型。

  • VPC:专有网络实例。
  • CCN:云连接网实例。
  • VBR:边界路由器实例。
  • TR:转发路由器实例。
Bandwidth Integer 2

跨地域连接的带宽值。单位:Mbps。

GeographicSpanId String china_china

带宽包的互通区域。

PeerTransitRouterOwnerId Long 253460731706911258

对端转发路由器实例所属账号ID。

AutoPublishRouteEnabled Boolean false

企业版转发路由器实例是否自动发布跨地域连接的路由到对端地域。

  • false(默认值):否。
  • true:是。
TransitRouterAttachmentName String test

跨地域连接的名称。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTransitRouterPeerAttachments
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTransitRouterPeerAttachmentsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0</RequestId>
    <MaxResults>20</MaxResults>
    <TransitRouterAttachments>
        <TransitRouterAttachmentId>tr-attach-5u4qbayfv2io5v****</TransitRouterAttachmentId>
        <Status>Attached</Status>
        <GeographicSpanId>china_china</GeographicSpanId>
        <PeerTransitRouterOwnerId>253460731706911258</PeerTransitRouterOwnerId>
        <TransitRouterAttachmentName>test</TransitRouterAttachmentName>
        <ResourceType>TR</ResourceType>
        <BandwidthType>BandwidthPackage</BandwidthType>
        <AutoPublishRouteEnabled>false</AutoPublishRouteEnabled>
        <Bandwidth>0</Bandwidth>
        <CreationTime>2021-06-16T02:50Z</CreationTime>
        <BandwidthPackageId/>
        <PeerTransitRouterId>tr-m5eq27g6bndum7e88****</PeerTransitRouterId>
        <RegionId>cn-hangzhou</RegionId>
        <CenBandwidthPackageId/>
        <PeerTransitRouterRegionId>cn-qingdao</PeerTransitRouterRegionId>
        <TransitRouterId>tr-bp1su1ytdxtataupl****</TransitRouterId>
    </TransitRouterAttachments>
</ListTransitRouterPeerAttachmentsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0",
  "MaxResults" : 20,
  "TransitRouterAttachments" : [ {
    "TransitRouterAttachmentId" : "tr-attach-5u4qbayfv2io5v****",
    "Status" : "Attached",
    "GeographicSpanId" : "china_china",
    "PeerTransitRouterOwnerId" : "253460731706911258",
    "TransitRouterAttachmentName" : "test",
    "ResourceType" : "TR",
    "BandwidthType" : "BandwidthPackage",
    "AutoPublishRouteEnabled" : false,
    "Bandwidth" : 0,
    "CreationTime" : "2021-06-16T02:50Z",
    "BandwidthPackageId" : "",
    "PeerTransitRouterId" : "tr-m5eq27g6bndum7e88****",
    "RegionId" : "cn-hangzhou",
    "CenBandwidthPackageId" : "",
    "PeerTransitRouterRegionId" : "cn-qingdao",
    "TransitRouterId" : "tr-bp1su1ytdxtataupl****"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 IllegalParam.NextToken The specified NextToken is invalid. NextToken是无效的。
400 IllegalParam.TrInstance The specified TransitRouter is invalid. TransitRouter是无效的。
400 IllegalParam.CenId The specified CenId is invalid. 云企业网实例ID非法。

访问错误中心查看更多错误码。