Enterprise Editionトランジットルーターのクロスリージョン接続を照会します。

説明

次の方法を使用して、Enterprise Editionトランジットルーターのクロスリージョン接続を照会できます。

  • Enterprise EditionトランジットルーターのIDを指定して、Enterprise Editionトランジットルーター上のすべてのクロスリージョン接続を照会します。
  • Cloud Enterprise Network (CEN) インスタンスのIDと、トランジットルーターがデプロイされているリージョンのIDを指定して、Enterprise Editionトランジットルーター上のすべてのクロスリージョン接続を照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 ListTransitRouterPeerAttachments

実行する操作です。 値をListTransitRouterPeerAttachmentsに設定します。

CenId String 任意 cen-j3jzhw1zpau2km ****

CEN インスタンスの ID。

RegionId String 任意 cn-hangzhou

Enterprise EditionトランジットルーターがデプロイされているリージョンのID。

DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

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

クロスリージョン接続のID。

TransitRouterId String 任意 tr-bp1su1ytdxtataupl ****

Enterprise EditionトランジットルーターのID。

MaxResults Integer 任意 20

The number of entries to return per page. デフォルト値は20です。 最大値は100です。

NextToken String 任意 1

次のクエリに使用されるトークン。 設定可能な値は以下のとおりです。

  • これが最初のクエリである場合、または次のクエリを送信しない場合は、このパラメーターを無視します。
  • 次のクエリを送信する場合は、前回の呼び出しから返されたNextTokenの値に値を設定します。

レスポンスパラメーター

パラメーター データ型 説明
NextToken String dd20 ****

次のクエリに使用されるトークン。 設定可能な値は以下のとおりです。

  • NextTokenの戻り値が空の場合、次のクエリは送信されないことを示します。
  • NextTokenの戻り値が空でない場合、値は次のクエリで使用されるトークンを示します。
RequestId String AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0

リクエストの ID です。

TotalCount Integer 1

返されたエントリの数。

MaxResults Integer 20

1 ページあたりで返されるエントリ数。

TransitRouterAttachments Array of TransitRouterAttachment

クロスリージョン接続のリスト。

CreationTime String 2021-06-16T02:50Z

クロスリージョン接続が作成された時刻。

YYYY-MM-ddTHH:mmZ形式のISO8601標準に従います。 時刻は UTC 表示です。

ステータス String Attached

クロスリージョン接続のステータス。 設定可能な値は以下のとおりです。

  • 添付: ローカルトランジットルーターがピアトランジットルーターに接続されています。
  • アタッチ: ローカルトランジットルーターがピアトランジットルーターに接続しています。
  • デタッチ: ローカルトランジットルーターがピアトランジットルーターから切断されています。
  • Detached: ローカル中継ルータがピア中継ルータから切断されています。
TransitRouterAttachmentId String tr-attach-5u4qbayfv2io5v ****

クロスリージョン接続のID。

BandwidthType String BandwidthPackage

帯域幅の割り当て方法。 設定可能な値は以下のとおりです。

BandwidthPackage: 帯域計画から帯域を割り当てる。

DataTransfer: データ転送ごとの帯域幅を使用します。

CenBandwidthPackageId String cenbwp-3xrxupouolw5ou ****

クロスリージョン接続に帯域幅を割り当てるために使用される帯域幅プランのID。

TransitRouterAttachmentDescription String testdesc

クロスリージョン接続の説明。

RegionId String cn-hangzhou

Enterprise EditionトランジットルーターがデプロイされているリージョンのID。

PeerTransitRouterId String tr-m5eq27g6bndum7e88 ****

ピア・トランジット・ルーターのID。

TransitRouterId String tr-bp1su1ytdxtataupl****

Enterprise EditionのトランジットルーターのIDです。

PeerTransitRouterRegionId String cn-qingdao

ピア中継ルータがデプロイされているリージョンのID。

ResourceType String TR

トランジットルーターが接続されているリソースのタイプ。 設定可能な値は以下のとおりです。

  • VPC: virtual private cloud (VPC)
  • CCN: Cloud Connect Network (CCN) インスタンス
  • VBR: 仮想ボーダールーター (VBR)
  • TR: トランジットルーター
帯域幅 Integer 2

クロスリージョン接続の帯域幅の値。 単位:Mbit/秒

  • BandwidthTypeBandwidthPackageに設定されている場合、このパラメーターは、クロスリージョン接続で使用できる帯域幅を示します。

  • BandwidthTypeDataTransferに設定されている場合、このパラメーターは、クロスリージョン接続の帯域幅制限を示します。
GeographicSpanId String china_china

帯域計画で接続される地域。

PeerTransitRouterOwnerId Long 253460731706911258

ピア中継ルータが属するAlibaba CloudアカウントのID。

AutoPublishRouteEnabled Boolean false

ローカルのEnterprise Editionトランジットルーターが、ピアのトランジットルーターへのクロスリージョン接続のルートを自動的にアドバタイズするかどうかを示します。 設定可能な値は以下のとおりです。

  • false (デフォルト): いいえ
  • true: はい
TransitRouterAttachmentName String test

クロスリージョン接続の名前。

リクエストの例

http(s)://[Endpoint]/?Action=ListTransitRouterPeerAttachments
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

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

<ListTransitRouterPeerAttachsResponse>
    <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> テスト </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>
</ListTransitRouterPeerAttachsResponse>

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 ****" 、
    "ステータス" : "添付" 、
    "GeographicSpanId" : "china_china" 、
    "PeerTransitRouterOwnerId" : "253460731706911258" 、
    "TransitRouterAttachmentName" : "test" 、
    "ResourceType" : "TR" 、
    "BandwidthType" : "BandwidthPackage" 、
    "AutoPublishRouteEnabled" : false、
    "帯域幅" : 0、
    "CreationTime" : "2021-06-16T02:50Z" 、
    "BandwidthPackageId" : "" 、
    "PeerTransitRouterId" : "tr-m5eq27g6bndum7e88 ****" 、
    "RegionId" : "cn-hangzhou" 、
    "CenBandwidthPackageId" : "" 、
    "PeerTransitRouterRegionId" : "cn-qingdao" 、
    "TransitRouterId" : "tr-bp1su1ytdxtataupl ****"
  } ]
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 IllegalParam.NextToken 指定されたNextTokenは無効です。 NextToken の値が無効であるため、エラーメッセージが返される。
400 IllegalParam.TrInstance 指定されたTransitRouterは無効です。 トランジットルーターのIDが無効であるため、エラーメッセージが返されました。
400 IllegalParam.CenId 指定されたCenIdは無効です。 CENインスタンスのIDが無効な場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。