BGPグループを照会します。

デバッグ

API Explorer を使用して、API のデバッグ、SDK コード例の自動生成、API の迅速な検索を簡単にすることができます。

リクエストパラメーター

パラメータ データ型 必須 値の例 説明　
Action String 必須 DescribeBgpGroupsDescribeBgpGroups

このアクションの名前。 値:

DescribeBgpGroups
RegionId String 必須 cn-shanghai

BGP グループが属するリージョン。

リージョン ID をクエリするには、DescribeRegions を呼び出します。

BgpGroupId String 任意 bgpg-wz9f62v4fbg2gxxxxxxxx

BGP グループの ID。
IsDefault Boolean 任意 false

指定された BGP グループがデフォルトの BGP グループかどうかを示します。
OwnerAccount String 任意 1234abcd@aliyun.com

所有者アカウント。

PageNumber Integer 任意 1

返すページ数。 既定値：1
PageSize Integer 任意 1

1 ページあたりの行数。 最大値：50 既定値：1
RouterId String 任意 vrt-kojok19x3j0q6kx

BGP グループに関連付けられている VBR の ID。

応答パラメーター

パラメーター データ型 値の例 説明　
TotalCount Integer 10

照会されたエントリの数。

PageNumber Integer 1

現在のページ番号。
PageSize Integer 5

1 ページあたりのエントリー数。
BgpGroups

BGP グループのリスト。
└AuthKey String !PWZ2wsq

BGP グループで使用する認証キー。
└BgpGroupId String bgp-wz977wcrmb69axxxxxxxx

BGP グループの ID。
└Description String The

BGP グループの説明。
└Hold String 30

BGP メッセージを待機する時間。 待機時間に達したときに BGP メッセージを受信していない場合、BGP ピアは切断されます。
└IsFake String true

偽のASN かどうかを示します。
└Keepalive String 10

キープアライブ時間。
└LocalAsn String 45104

ローカル ASN。

└Name String BGPName

BGP グループの名前。

└PeerAsn String 1111

BGP ピアの ASN。

└RegionId String cn-shanghai

BGP グループのリージョン ID 。 詳細については、「リージョンとゾーン」をご参照ください。

└RouteLimit String 99

ルートクォータ。

└RouterId String vrt-bp1lhl0taikrteen80oxx

VBR の ID。

└Status String active

BGP ピアのステータス。
RequestId String 1D0971B2-A35A-42C1-A44C-E91360C36C0B

リクエストの ID です。

例

要求の例


https://vpc.aliyuncs.com/?Action=DescribeBgpGroups
&RegionId=cn-shanghai
&<CommonParameters>
戻り値の例

  • XML 形式

    <DescribeBgpGroupsResponse>
  <TotalCount>1</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>09E2C0FD-37FF-4737-80DF-517AC36D43DB</RequestId>
  <BgpGroups>
    <BgpGroup>
      <BgpGroupId>bgpg-2zev8h2wo414sfhjgdlhh</BgpGroupId>
      <LocalAsn>45104</LocalAsn>
      <Hold>30</Hold>
      <Description/>
      <AuthKey/>
      <IsFake>true</IsFake>
      <PeerAsn>234</PeerAsn>
      <Keepalive>10</Keepalive>
      <RouteLimit>99</RouteLimit>
      <Name>Group1</Name>
      <Status>Pending</Status>
      <RouterId>vbr-2zecmmvg5gvu8i4telkhw</RouterId>
      <RegionId>cn-beijing</RegionId>
    </BgpGroup>
  </BgpGroups>
</DescribeBgpGroupsResponse>

  • JSON 形式

    {
	"TotalCount":1,
	"PageSize":10,
	"RequestId":"09E2C0FD-37FF-4737-80DF-517AC36D43DB",
	"BgpGroups":{
		"BgpGroup":[
			{
				"BgpGroupId":"bgpg-2zev8h2wo414sfhjgdlhh",
				"LocalAsn":45104,
				 "Hold":30,
				"Description":"",
				"AuthKey":"",
				 "IsFake":true,
				"PeerAsn":234,
				"Keepalive":10,
				"RouteLimit":99,
				"Name":"Group1",
				"Status":"Pending",
				"RouterId":"vbr-2zecmmvg5gvu8i4telkhw",
				"RegionId":"cn-beijing"
			}
		]
	}
}

Error codes

HTTP ステータスコード エラーコード エラーメッセージ 説明
500 InternalError The request processing has failed due to some unknown error. リクエストの処理中にエラーが発生しました。
404 InvalidRegionId.NotFound 指定された RegionId はレコードに存在しません。 指定された リージョン ID は存在しません。

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