DescribeBgpPeers - - Alibaba Cloud ドキュメントセンター

デバッグ

OpenAPI Explorer を使用して、デバッグ操作の実行、SDK コード例の生成を行います。

リクエストパラメーター


パラメータ	データ型	必須	値の例	説明
Action	String	必須	DescribeBgpPeers	呼び出される API の名前。値： DescribeBgpPeers
RegionId	String	必須	cn-shanghai	BGP グループが属するリージョンの ID。リージョン ID を照会するには、DescribeRegions を呼び出します。
BgpGroupId	String	任意	bgpg-2zev8h2wo414xxxxxxx	任意。 BGP グループの ID。
BgpPeerId	String	任意	bgp-2ze3un0ft1jd1xxxxxxxx	任意。 BGP ピアのID。
IsDefault	Boolean	任意	false	任意。 BGP グループがデフォルトの BGP グループかどうかを示します。
OwnerAccount	String	任意	xxx@aliyun.com	任意。ご自分のアカウントです。
PageNumber	Integer	No	1	任意。 BGP ピアリストのページ番号。規定値：1
PageSize	Integer	No	1	任意。ページクエリの 1 ページあたりの行数です。最大値：50 デフォルト値：1
RouterId	String	任意	vrt-acfmxazxxxxxxxx	任意。 VRouter の ID 。

応答パラメーター


パラメーター	データ型	値の例	説明
BgpPeers			BGP ピアのリスト。
└Name	String	test	BGP ピアの名前。
└PeerIpAddress	String	116.62.xx.xx	BGP ピアの IP アドレス。
└AuthKey	String	! PWZ2wsq	BGP グループの認証キー。
└RouterId	String	vbr-2zecmmvg5gvu8xxxxxxxx	VRouter の ID。
└Status	String	active	BGP ピアのステータス。
└BgpGroupId	String	bgp-wz977wcrmb69axxxxxxxx	BGP グループの ID。
└BgpPeerId	String	bgp-wz977wcrmb69axxxxxxxx	BGP ピアの ID。
└BgpStatus	String	Established	BGP 接続ステータス。
└Description	String	xxxxxxxxx	BGP グループの説明
BEnableBfd	Boolean	true	BFD 機能を有効にするかどうかを示します。有効値： true：BFD 機能を有効にします。 false：BFD 機能を有効にしません。
└Hold	String	30	待機時間。
└IsFake	String	true	Fake ASN が有効かどうかを示します。
Keepalive	String	10	キープアライブ時間。
└LocalAsn	String	45104	ローカル ASN。
└PeerAsn	String	active	BGP ピアの ASN。
└RegionId	String	cn-shanghai	BGP グループが属するリージョンの ID。
└RouteLimit	String	99	ルートクォータ。
TotalCount	Integer	10	照会されたエントリの数。
PageNumber	Integer	1	現在のページ番号。
PageSize	Integer	2	1 ページあたりのエントリ数。
RequestId	String	DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6	リクエストの ID です。

例

要求の例


https://vpc.aliyuncs.com/?Action=DescribeBgpPeers
&RegionId=cn-shanghai
&<CommonParameters>

レスポンスの例

XML 形式

<DescribeBgpPeers>
  <TotalCount>2</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>16DFA5E6-9771-41B7-B079-DD7C2DF49BE6</RequestId>
  <BgpPeers>
    <BgpPeer>
      <BgpGroupId>bgpg-2zev8h2wo414sxxxxxxxx</BgpGroupId>
      <LocalAsn>45104</LocalAsn>
      <PeerIpAddress>11.11.xx.xx</PeerIpAddress>
      <Hold>30</Hold>
      <Description/>
      <AuthKey/>
      <IsFake>true</IsFake>
      <PeerAsn>234</PeerAsn>
      <Keepalive>10</Keepalive>
      <RouteLimit>99</RouteLimit>
      <BgpPeerId>bgp-2ze3un0ft1jd1xxxxxxxx</BgpPeerId>
      <Name/>
      <Status>Available</Status>
      <BgpStatus/>
      <RouterId>vbr-2zecmmvg5gvu8xxxxxxxx</RouterId>
      <RegionId>cn-beijing</RegionId>
    </BgpPeer>
    <BgpPeer>
      <BgpGroupId>bgpg-2zev8h2wo414sxxxxxxxx</BgpGroupId>
      <LocalAsn>45104</LocalAsn>
      <PeerIpAddress>11.11.xx.xx</PeerIpAddress>
      <Hold>30</Hold>
      <Description/>
      <AuthKey/>
      <IsFake>true</IsFake>
      <PeerAsn>234</PeerAsn>
      <Keepalive>10</Keepalive>
      <RouteLimit>99</RouteLimit>
      <BgpPeerId>bgp-2zeu54rbreqqzxxxxxxxx</BgpPeerId>
      <Name/>
      <Status>Available</Status>
      <BgpStatus/>
      <RouterId>vbr-2zecmmvg5gvu8xxxxxxxx</RouterId>
      <RegionId>cn-beijing</RegionId>
    </BgpPeer>
  </BgpPeers>
</DescribeBgpPeers>

JSON 形式

{
	"TotalCount":2,
	"PageSize":10,
	"RequestId":"16DFA5E6-9771-41B7-B079-DD7C2DF49BE6",
	"BgpPeers":{
		"BgpPeer":[
			{
				"BgpGroupId":"bgpg-2zev8h2wo414sxxxxxxxx",
				"LocalAsn":45104,
				"PeerIpAddress":"11.11.xx.xx",
				"Hold":30,
				"Description":"",
				"AuthKey":"",
				"IsFake":true,
				"PeerAsn":234,
				"Keepalive":10,
				"RouteLimit":99,
				"BgpPeerId":"bgp-2ze3un0ft1jd1xxxxxxxx",
				 "Name":"",
				"Status":"Available",
				"BgpStatus":"",
				"RouterId":"vbr-2zecmmvg5gvu8xxxxxxxx",
				"RegionId":"cn-beijing"
			},
			{
				"BgpGroupId":"bgpg-2zev8h2wo414sxxxxxxxx",
				"LocalAsn":45104,
				"PeerIpAddress":"11.11.xx.xx",
				"Hold":30,
				"Description":"",
				"AuthKey":"",
				"IsFake":true,
				"PeerAsn":234,
				"Keepalive":10,
				"RouteLimit":99,
				"BgpPeerId":"bgp-2zeu54rbreqqzxxxxxxxx",
				"Name":"",
				"Status":"Available",
				"BgpStatus":"",
				"RouterId":"vbr-2zecmmvg5gvu8xxxxxxxx",
				"RegionId":"cn-beijing"
			}
		]
	}
}

Error codes


HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	The request processing has failed due to some unknown error.	不明なエラーのため、リクエストは処理されませんでした。
404	InvalidRegionId.NotFound	指定された RegionId はレコードに存在しません。	指定されたリージョン ID は無効です。指定のリージョンでクラウドサービスが利用可能か確認してください。

一般的なエラーコードをご参照ください。