説明
カスタマーゲートウェイのリストを照会します。
リクエストパラメータ
名前 | 型 | 必須かどうか | 説明 |
---|---|---|---|
Action | String | はい | 実行するアクション。 有効な値: |
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 を参照してください。
例
リクエストの例
https://vpc.aliyuncs.com/?Action=DescribeCustomerGateways
&RegionID=cn-beijing
&<CommonParameters>
レスポンスの例
XML
形式
<DescribeCustomerGatewaysResponse>
<PageNumber>1</PageNumber>
<TotalCount>3</TotalCount>
<PageSize>10</PageSize>
<RequestId>5BE01CD7-5A50-472D-AC14-CA181C5C03BE</RequestId>
<CustomerGateways>
<CustomerGateway>
<Name>test</Name>
<CustomerGatewayId>cgw-bp1pvpl9r9adju6l5nxck</CustomerGatewayId>
<CreateTime>1492747187000</CreateTime>
<IpAddress>139.196.32.167</IpAddress>
</CustomerGateway>
</CustomerGateways>
</DescribeCustomerGatewaysResponse>
JSON
形式
{
"PageNumber": 1,
"TotalCount": 3,
"PageSize": 10,
"RequestId": "E82612A9-CB90-4D7E-B394-1DB7F6509B29",
"CustomerGateways": {
"CustomerGateway": [
{
"Name": "test",
"CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5nxck",
"CreateTime": 1492747187000,
"IpAddress": "139.196.32.167"
}
]
}
}