ListTransitRouterVpnAttachments - Cloud Enterprise Network - Alibaba Cloud ドキュメントセンター

ListTransitRouterVpnAttachments 操作を呼び出して、ステータス、IPsec 接続 ID、課金方法など、VPN 接続に関する情報をクエリできます。

操作説明

ListTransitRouterVpnAttachments 操作では、以下のクエリ方法をサポートしています。

特定の VPN 接続をクエリするには、TransitRouterAttachmentId のみ入力します。
指定されたトランジットルーターに関連付けられているすべての VPN 接続を照会するには、[TransitRouterId] のみを入力します。
CenId と RegionId を入力して、指定された Cloud Enterprise Network (CEN) インスタンスの特定のリージョンにある VPN 接続をクエリします。

ListTransitRouterVpnAttachments 操作を呼び出す際は、有効なパラメーター値を入力してください。無効なパラメーターを入力すると、システムは RequestId を返しますが、照会された VPN 接続情報は返しません。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cen:ListTransitRouterVpnAttachments

list

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

TransitRouterVpnAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/*

TransitRouterVpnAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

なし

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
CenId	string	任意	CEN インスタンスの ID。	cen-rsgxs8ng2awen2****
RegionId	string	任意	トランジットルーターがデプロイされているリージョンの ID。詳細については、「DescribeChildInstanceRegions」をご参照ください。	cn-hangzhou
TransitRouterAttachmentId	string	任意	VPN 接続の ID。	tr-attach-a6p8voaodog5c0****
TransitRouterId	string	任意	トランジットルーターの ID。	tr-p0wm740vjnbaprv0m****
MaxResults	integer	任意	各ページに返すエントリの数。デフォルト値: 20。	20
NextToken	string	任意	次のクエリに使用されるトークン。有効な値: これが最初のクエリである場合、または次のクエリが送信されない場合は、このパラメーターを指定する必要はありません。次のクエリを送信する場合は、値を最後の API 呼び出しから返された NextToken 値に設定します。	FFmyTO70tTpLG6I3FmYAXGKPd****
Tag	array<object>	任意	CEN インスタンスのタグ。一度に最大 20 個のタグをクエリできます。
	object	任意
Key	string	任意	タグキー。タグキーは空の文字列にすることはできません。タグキーは最大 64 文字の長さで、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。最大 20 個のタグキーを指定できます。	tagtest
Value	string	任意	タグ値。タグ値は空の文字列、または最大 128 文字の文字列にすることができます。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。各タグキーには一意のタグ値が必要です。最大 20 個のタグ値を指定できます。	value_A1

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	レスポンス。
NextToken	string	次のクエリに使用されるトークン。有効な値: NextToken が空の場合、後続のクエリはないことを示します。 NextToken の値が返された場合、その値は次のクエリで使用されるトークンです。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	リクエスト ID。	3D5530D2-3BBB-524E-8E98-59AB06A250E4
TotalCount	integer	エントリの総数。	1
MaxResults	integer	1 ページあたりに返されるエントリの数。	20
TransitRouterAttachments	array<object>	VPN 接続のリスト。
	object	VPN 接続に関する情報。
CreationTime	string	VPN 接続が作成された時刻。時刻は YYYY-MM-DDThh:mmZ 形式の ISO 8601 標準で表示されます。時刻は UTC で表示されます。	2022-07-08T08:45Z
Status	string	VPN 接続のステータス。 Attached: VPN 接続は接続されています。 Attaching: VPN 接続は接続中です。 Detaching: VPN 接続は切断中です。	Attached
TransitRouterAttachmentId	string	VPN 接続の ID。	tr-attach-a6p8voaodog5c0****
TransitRouterId	string	トランジットルーターの ID。	tr-p0wm740vjnbaprv0m****
ResourceType	string	VPN 接続のリソースタイプ。値は VPN に設定され、トランジットルーターが IPsec 接続に接続されていることを示します。	VPN
VpnOwnerId	integer	IPsec 接続が属する Alibaba Cloud アカウントの ID。	1210123456123456
VpnId	string	IPsec 接続の ID。	vco-p0wtu1xgd0l7fjo7k****
TransitRouterAttachmentDescription	string	VPN 接続の説明。	desctest
VpnRegionId	string	IPsec 接続がデプロイされているリージョンの ID。詳細については、「DescribeRegions」をご参照ください。	cn-hangzhou
AutoPublishRouteEnabled	boolean	トランジットルーターが IPsec 接続にルートを自動的にアドバタイズするかどうかを示します。有効な値: true: 有効。 false: 無効。	true
TransitRouterAttachmentName	string	VPN 接続の名前。	nametest
Zones	array<object>	VPN 接続がデプロイされているゾーンのリスト。
	object	VPN 接続がデプロイされているゾーン。
ZoneId	string	ゾーン ID。詳細については、「DescribeZones」をご参照ください。	cn-hangzhou-h
Tags	array<object>	タグのリスト。
	object
Key	string	タグキー。	test
Value	string	タグ値。	value_A1
ChargeType	string	VPN 接続の課金方法。値は POSTPAY に設定され、従量課金制を示します。	POSTPAY
CenId	string	CEN インスタンスの ID。	cen-j3jzhw1zpau2km****
OrderType	string	ネットワークインスタンスの料金を支払う当事者。有効な値: PayByCenOwner: ネットワークインスタンスの料金は、CEN インスタンスを所有するアカウントが支払います。 PayByResourceOwner: ネットワークインスタンスの料金は、ネットワークインスタンスを所有するアカウントが支払います。	PayByCenOwner

例

成功レスポンス

JSONJSON

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "3D5530D2-3BBB-524E-8E98-59AB06A250E4",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2022-07-08T08:45Z",
      "Status": "Attached",
      "TransitRouterAttachmentId": "tr-attach-a6p8voaodog5c0****",
      "TransitRouterId": "tr-p0wm740vjnbaprv0m****",
      "ResourceType": "VPN",
      "VpnOwnerId": 1210123456123456,
      "VpnId": "vco-p0wtu1xgd0l7fjo7k****",
      "TransitRouterAttachmentDescription": "desctest",
      "VpnRegionId": "cn-hangzhou",
      "AutoPublishRouteEnabled": true,
      "TransitRouterAttachmentName": "nametest",
      "Zones": [
        {
          "ZoneId": "cn-hangzhou-h"
        }
      ],
      "Tags": [
        {
          "Key": "test",
          "Value": "value_A1"
        }
      ],
      "ChargeType": "POSTPAY",
      "CenId": "cen-j3jzhw1zpau2km****\n",
      "OrderType": "PayByCenOwner"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalParam.NextToken	The specified NextToken is invalid.
400	IllegalParam.TrInstance	The specified TransitRouter is invalid.
400	IllegalParam.Region	The specified Region is invalid.
400	IllegalParam.CenId	The specified CenId is invalid.
400	IllegalParam.CenIdOrRegionId	The specified CenId or RegionId is invalid.
400	IllegalParam.TransitRouterId	The specified TransitRouterId is illegal.
400	IllegalParam.MaxResults	The specified MaxResults is invalid.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。