edit-icon download-icon

DescribeBgpPeers

最終更新日: May 18, 2018

説明

あるリージョンの BGP ピアを照会します。

リクエストパラメータ

名前 必須かどうか 説明
Action String はい

実行するアクション。

有効な値: DescribeBgpPeers

RegionId String はい

BGP ピアのリージョン。

リージョン ID は DescribeRegions API を呼び出すことで取得できます。

BgpPeerIdStringいいえBGP ピアの ID。
RouterIdStringいいえVBR の ID。
PageNumberIntegerいいえ返すページ数。デフォルト値は 1 です。
PageSizeIntegerいいえ1 ページあたりの行数。最大値は 50、デフォルト値は 10 です。

レスポンスパラメータ

名前 説明
RequestId String リクエストの ID。
BgpPeers JSON string 照会された BGP ピアの詳細情報。
TotalCountInteger照会された項目の数。
PageNumberInteger現在のページ番号。
PageSizeInteger現在のページのエントリ数。
BgpPeers オブジェクト
BGPPeerId String BGP ピアの ID。
NameStringBGP ピアの名前。
LocalIpAddressStringAlibaba Cloud 側の IP アドレス。
PeerIpAddressStringBGP ピアの IP アドレス。
PeerASNIntegerBGP ピアの ASN。
AuthKeyStringBGP グループが使用する鍵。
BGPStatusString BGP の接続状態。
RouterIdString VBR の ID。
StatusStringBGP ピアのステータス。

エラーコード

VPC API Error Center を参照してください。

リクエストの例

  1. https://vpc.aliyuncs.com/?Action=DescribeBgpPeers
  2. &VRouterId=vrt-25u5f8u2q
  3. &<CommonParameters>

レスポンスの例

XML 形式

  1. <DescribeBgpPeersResponse>
  2. <TotalCount>1</TotalCount>
  3. <BgpPeers>
  4. <BgpPeer>
  5. <Status>Available</Status>
  6. <LocalAsn>45104</LocalAsn>
  7. <Description></Description>
  8. <BgpPeerId>bgp-2ze0dxfpp6fuw7gmzpaaa</BgpPeerId>
  9. <RegionId>cn-beijing</RegionId>
  10. <PeerIpAddress>11.11.11.11</PeerIpAddress>
  11. <IsFake>true</IsFake>
  12. <RouteLimit>99</RouteLimit>
  13. <PeerAsn>2010</PeerAsn>
  14. <AuthKey>888</AuthKey>
  15. <RouterId>vbr-2zeff11o2sqhnp1u7ci93</RouterId>
  16. <BgpGroupId>bgpg-2zeibi8idqnkhhgxgdcw9</BgpGroupId>
  17. <BgpStatus></BgpStatus>
  18. <Name></Name>
  19. <Hold>30</Hold>
  20. <Keepalive>10</Keepalive>
  21. </BgpPeer>
  22. </BgpPeers>
  23. <RequestId>3D6B3CB0-BEEE-4F30-8559-B3DA14AD705F</RequestId>
  24. <PageSize>10</PageSize>
  25. </DescribeBgpPeersResponse>

JSON 形式

  1. {
  2. "TotalCount": 1,
  3. "BgpPeers": {
  4. "BgpPeer": [
  5. {
  6. "Status": "Available",
  7. "LocalAsn": 45104,
  8. "Description": "",
  9. "BgpPeerId": "bgp-2ze0dxfpp6fuw7gmzpaaa",
  10. "RegionId": "cn-beijing",
  11. "PeerIpAddress": "11.11.11.11",
  12. "IsFake": true,
  13. "RouteLimit": 99,
  14. "PeerAsn": 2010,
  15. "AuthKey": "888",
  16. "RouterId": "vbr-2zeff11o2sqhnp1u7ci93",
  17. "BgpGroupId": "bgpg-2zeibi8idqnkhhgxgdcw9",
  18. "BgpStatus": "",
  19. "Name": "",
  20. "Hold": 30,
  21. "Keepalive": 10
  22. }
  23. ]
  24. },
  25. "RequestId": "3D6B3CB0-BEEE-4F30-8559-B3DA14AD705F",
  26. "PageSize": 10
  27. }