すべてのプロダクト
Search

このプロダクト

    :ListTransitRouterVpnAttachments

    ドキュメントセンター

    :ListTransitRouterVpnAttachments

    最終更新日:Apr 03, 2024

    VPN添付ファイルに関する情報を照会します。

    使用状況ノート

    ListTransitRouterVpnAttachments操作を呼び出すときは、次の項目に注意してください。

    • CenIdとRegionIdのみを設定した場合、現在のリージョンのVPN添付ファイルが照会されます。

    • CenId、RegionId、およびTransitRouterAttachmentIdを設定した場合、指定されたVPN添付ファイルのみが照会されます。

    • CenIdとRegionIdを設定した場合、TransitRouterIdを設定する必要はありません。 TransitRouterIdを設定した場合、CenIdまたはRegionIdを設定する必要はありません。

    デバッグ

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

    リクエストパラメーター

    項目

    データ型

    必須／任意

    例:

    説明　

    操作

    String

    必須

    ListTransitRouterVpnAttachments

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

    CenId

    String

    任意

    cen-rsgxs8ng2awen2 ****

    Cloud Enterprise Network (CEN) インスタンスのID。

    RegionId

    String

    任意

    cn-hangzhou

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

    DescribeChildInstanceRegionsを呼び出して、最新のリージョンリストを照会できます。

    TransitRouterAttachmentId

    String

    任意

    tr-attach-a6p8voaodog5c0 ****

    VPN添付ファイルのID。

    TransitRouterId

    String

    任意

    tr-p0wm740vjnbaprv0m ****

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

    MaxResults

    Integer

    いいえ

    20

    各ページで返されるエントリ数。 デフォルト値: 20

    NextToken

    String

    任意

    FFmyTO70tTpLG6I3FmYAXGKPd ****

    クエリの開始点を決定するトークン。 有効な値：

    • これが最初のクエリである場合、または後続のクエリを送信しない場合は、このパラメーターを無視します。

    • 後続のクエリを送信する場合は、パラメーターを最後の呼び出しから返されたNextTokenの値に設定します。

    レスポンスパラメーター

    項目

    データ型

    例:

    説明　

    NextToken

    String

    FFmyTO70tTpLG6I3FmYAXGKPd ****

    クエリの開始点を決定するトークン。 有効な値：

    • NextTokenが返されなかった場合は、追加の結果が存在しないことを示します。

    • 前のクエリでNextTokenが返された場合は、値を指定して次の結果セットを取得します。

    RequestId

    String

    3D5530D2-3BBB-524E-8E98-59AB06A250E4

    リクエストの ID です。

    TotalCount

    Integer

    1

    返されたエントリの総数。

    MaxResults

    Integer

    20

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

    TransitRouterAttachments

    TransitRouterAttachmentの配列

    VPN添付ファイルに関する情報。

    CreationTime

    String

    2022-07-08T08:45Z

    VPN添付ファイルが作成された時刻。

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

    Status

    String

    Attached

    VPN添付ファイルのステータス。 有効な値：

    • 添付: VPC添付ファイルがトランジットルーターに作成されています。

    • 添付: VPC添付ファイルはトランジットルーターに作成中です。

    • デタッチ: VPC添付ファイルはトランジットルーターから削除中です。

    • Detached: ローカル中継ルータがピア中継ルータから切断されています。

    TransitRouterAttachmentId

    String

    tr-attach-a6p8voaodog5c0 ****

    VPN添付ファイルのID。

    TransitRouterId

    String

    tr-p0wm740vjnbaprv0m ****

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

    ResourceType

    String

    [VPN] >

    トランジットルーターが接続されているリソースのタイプ。

    有効値: VPN。IPsec-VPN接続がトランジットルーターに接続されていることを示します。

    VpnOwnerId

    Long

    1210123456123456

    IPsec-VPN接続を所有するAlibaba CloudアカウントのID。

    VpnId

    String

    vco-p0wtu1xgd0l7fjo7k ****

    IPsec-VPN 接続の ID。

    TransitRouterAttachmentDescription

    String

    desktest

    VPN添付ファイルの説明。

    VpnRegionId

    String

    cn-hangzhou

    IPsec-VPN 接続が属するリージョンの ID 。

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

    AutoPublishRouteEnabled

    ブール

    真実

    トランジットルーターがIPsec接続へのルートを自動的に通知できるようにするかどうかを示します。 有効な値：

    • true: はい

    • false: いいえ

    TransitRouterAttachmentName

    String

    nametest

    VPN添付ファイルの名前。

    Zones

    ZoneMappingの配列

    VPNアタッチメントがデプロイされているゾーン。

    ZoneId

    String

    cn-hangzhou-h

    ゾーン ID。

    DescribeZonesを呼び出して、IDでゾーンを照会できます。

    例

    リクエストの例

    http(s):// [エンドポイント]/?Action=ListTransitRouterVpnAttachments
&CenId=cen-rsgxs8ng2awen2 ****
&RegionId=cn-hangzhou
&TransitRouterAttachmentId=tr-attach-a6p8voaodog5c0 ****
&TransitRouterId=tr-p0wm740vjnbaprv0m ****
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd ****
&共通リクエストパラメータ

    レスポンスの例

    XML 形式

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

<ListTransitRouterVpnAttachmentsResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd ****</NextToken>
    <RequestId>3D5530D2-3BBB-524E-8E98-59AB06A250E4</RequestId>
    <TotalCount> 1 </ TotalCount>
    <MaxResults>20</MaxResults>
    <TransitRouterAttachments>
        <CreationTime>2022-07-08T08:45Z</CreationTime>
        <Status>Attached</Status>
        <TransitRouterAttachmentId>tr-attach-a6p8voaodog5c0 ****</TransitRouterAttachmentId>
        <TransitRouterId>tr-p0wm740vjnbaprv0m ****</TransitRouterId>
        <VpnOwnerId>1210123456123456</VpnOwnerId>
        <VpnId>vco-p0wtu1xgd0l7fjo7k ****</VpnId>
        <TransitRouterAttachmentDescription>desctest</TransitRouterAttachmentDescription>
        <VpnRegionId>cn-hangzhou</VpnRegionId>
        <AutoPublishRouteEnabled>true</AutoPublishRouteEnabled>
        <TransitRouterAttachmentName>nametest</TransitRouterAttachmentName>
        <Zones>
            <ZoneId>cn-hangzhou-h</ZoneId>
        </Zones>
    </TransitRouterAttachments>
</ListTransitRouterVpnAttachmentsResponse>

    JSON 形式

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

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd ****" 、
  "RequestId" : "3D5530D2-3BBB-524E-8E98-59AB06A250E4" 、
  "TotalCount" : 1、
  "MaxResults" : 20、
  "TransitRouterAttachments" : [ {
    "CreationTime" : "2022-07-08T08:45Z" 、
    "ステータス" : "添付" 、
    "TransitRouterAttachmentId" : "tr-attach-a6p8voaodog5c0 ****" 、
    "TransitRouterId" : "tr-p0wm740vjnbaprv0m ****" 、
    "VpnOwnerId" : 1210123456123456、
    "VpnId" : "vco-p0wtu1xgd0l7fjo7k ****" 、
    "TransitRouterAttachmentDescription" : "desktest" 、
    "VpnRegionId" : "cn-hangzhou" 、
    "AutoPublishRouteEnabled" : true、
    "TransitRouterAttachmentName" : "nametest" 、
    "ゾーン" : [ {
      "ZoneId" : "cn-hangzhou-h"
    } ]
  } ]
}

    エラーコード

    HttpCode

    エラーコード

    エラーメッセージ

    説明　

    400

    IllegalParam.NextToken

    指定されたNextTokenは無効です。

    NextTokenが無効な値に設定されている場合に返されるエラーメッセージ。

    400

    IllegalParam.TrInstance

    指定されたTransitRouterは無効です。

    TransitRouterが無効な値に設定されている場合に返されるエラーメッセージ。

    400

    IllegalParam.CenId

    指定されたCenIdは無効です。

    CENインスタンスのIDが無効な場合に返されるエラーメッセージ。

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