edit-icon download-icon

DescribeVpnGateways

最終更新日: May 05, 2018

説明

VPN Gateway のリストを照会します。

リクエストパラメーター

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

実行するアクション。

有効値:DescribeVpnGateways

RegionId String はい

VPN Gateway のリージョン。

リージョン ID を取得するには、DescribeRegions API を呼び出します。

VpcId String いいえ VPN Gateway が属する VPC の ID。
Status String いいえ

VPN Gateway のステータス。

有効値:init | provisioning | active | updating | deleting

BusinessStatus String いいえ

VPN Gateway のビジネスステータス。

有効値:Normal | FinancialLocked

PageNumber Integer いいえ 戻されるページ数。デフォルト値は 1 です。
PageSize Integer いいえ 1 ページあたりの行数。最大値は 50、デフォルト値は 10 です。

レスポンスパラメーター

名前 説明
RequestId String リクエストの ID。
VpnGateways JSON String 照会された VPN Gateway のリスト。
TotalCount Integer 照会されたエントリの数。
PageNumber Integer 現在のページ数。
PageSize Integer 現在のページのエントリ数。
VpnGateways objects
名前 説明
VpnGatewayId String VPN Gateway の ID。
VpcId String VPN Gateway が属する VPC の ID。
VSwitchId String VPN Gateway が属する VSwitch の ID。
InternetIp String パブリック IP アドレス。
CreateTime Long VPN Gateway の作成時間。
EndTime Long VPN Gateway の有効期限。
Spec String VPN Gateway の仕様。
Name String VPN Gateway の名前。
Description String VPN Gateway の説明。
Status String VPN Gateway のステータス。
BusinessStatus String VPN Gateway のビジネスステータス。

エラーコード

VPC API Error Center」をご参照ください。

リクエストの例

  1. https://vpc.aliyuncs.com/?Action=DescribeVpnGateways
  2. &RegionID=cn-hangzhou
  3. &<CommonParameters>

レスポンスの例

XML 形式

  1. <DescribeVpnGatewaysResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>1</TotalCount>
  4. <PageSize>10</PageSize>
  5. <VpnGateways>
  6. <VpnGateway>
  7. <Status>active</Status>
  8. <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj0fiu</VpnGatewayId>
  9. <BusinessStatus>Normal</BusinessStatus>
  10. <Spec>5M</Spec>
  11. <CreateTime>1492753580000</CreateTime>
  12. <InternetIp>116.62.69.64</InternetIp>
  13. <EndTime>1495382400000</EndTime>
  14. <VSwitchId>vsw-bp1y9ovl1cu9ou4tvma0l</VSwitchId>
  15. <VpcId>vpc-bp1ub1yt9cvakoelj1y9c</VpcId>
  16. </VpnGateway>
  17. </VpnGateways>
  18. <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
  19. </DescribeVpnGatewaysResponse>

JSON 形式

  1. {
  2. "PageNumber":1,
  3. "TotalCount":1,
  4. "VpnGateways":{
  5. "VpnGateway":[
  6. {
  7. "Status":"active",
  8. "VpnGatewayId":"vpn-bp1q8bgx4xnkm2ogj0fiu",
  9. "BusinessStatus":"Normal",
  10. "Spec":"5M",
  11. "CreateTime":1492753580000,
  12. "InternetIp":"116.62.69.64",
  13. "EndTime":1495382400000,
  14. "VSwitchId":"vsw-bp1y9ovl1cu9ou4tvma0l",
  15. "VpcId":"vpc-bp1ub1yt9cvakoelj1y9c"
  16. }
  17. ]
  18. },
  19. "PageSize":10,
  20. "RequestId":"B2CD1315-CA2B-47B1-9DA5-8F1D69C48E82"
  21. }