edit-icon download-icon

DescribeCustomerGateways

最終更新日: May 05, 2018

説明

カスタマーゲートウェイのリストを照会します。

リクエストパラメータ

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

実行するアクション。

有効な値: DescribeCustomerGateways

RegionId String はい

カスタマーゲートウェイのリージョン

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

CustomerGatewayId String いいえ カスタマーゲートウェイの ID。
PageNumber Integer いいえ 返すページ数。デフォルト値は 1 です。
PageSize Integer いいえ 1 ページあたりの行数。最大値は 50、デフォルト値は 10 です。

レスポンスパラメータ

名前 説明
RequestId String リクエストの ID。
CustomerGateways JSON string 照会されたカスタマーゲートウェイのリスト。
TotalCount Integer 照会された項目の数。
PageNumber Integer 現在のページ番号。
PageSize Integer 現在のページのエントリ数。
CustomerGateway オブジェクト
名前 説明
CustomerGatewayId String カスタマーゲートウェイの ID。
Name String カスタマーゲートウェイの名前。
Description String カスタマーゲートウェイの説明。
IpAddress String カスタマーゲートウェイの IP アドレス。
CreateTime Long カスタマーゲートウェイの作成時間

エラーコード

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

リクエストの例

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

レスポンスの例

XML 形式

  1. <DescribeCustomerGatewaysResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>3</TotalCount>
  4. <PageSize>10</PageSize>
  5. <RequestId>5BE01CD7-5A50-472D-AC14-CA181C5C03BE</RequestId>
  6. <CustomerGateways>
  7. <CustomerGateway>
  8. <Name>test</Name>
  9. <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5nxck</CustomerGatewayId>
  10. <CreateTime>1492747187000</CreateTime>
  11. <IpAddress>139.196.32.167</IpAddress>
  12. </CustomerGateway>
  13. </CustomerGateways>
  14. </DescribeCustomerGatewaysResponse>

JSON 形式

  1. {
  2. "PageNumber": 1,
  3. "TotalCount": 3,
  4. "PageSize": 10,
  5. "RequestId": "E82612A9-CB90-4D7E-B394-1DB7F6509B29",
  6. "CustomerGateways": {
  7. "CustomerGateway": [
  8. {
  9. "Name": "test",
  10. "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5nxck",
  11. "CreateTime": 1492747187000,
  12. "IpAddress": "139.196.32.167"
  13. }
  14. ]
  15. }
  16. }