Query the created customer gateways.

Request parameters

Name Type Required Description
Action String Yes

The action to perform. Valid value:

DescribeCustomerGateways

RegionId String Yes

The region of the customer gateway.

You can obtain the region ID by calling the DescribeRegions API.

CustomerGatewayId String No

The ID of the customer gateway.

PageNumber Integer No

The number of pages to return. The default value is 1.

PageSize Integer No

The number of rows per page. The maximum value is 50 and the default value is 10.

Response parameters

Name Type Description
RequestId String The ID of the request.
CustomerGateways List A list of customer gateways.
TotalCount Integer The number of queried entries.
PageNumber Integer The current page number.
PageSize Integer The number of entries on the current page.
CustomerGateways List A list of customer gateways.
Table 1. CustomerGateway
Name Type Description
CustomerGatewayId String The ID of the customer gateway.
Name String The name of the customer gateway.
Description String The description of the customer gateway.
IpAddress  String The IP address of the customer gateway.
CreateTime Long The time when the customer gateway was created.

Examples

Request example

https://vpc.aliyuncs.com/?Action=DescribeCustomerGateways
&RegionId=cn-beijing
&CommonParameters
Response example
  • XML format

    <? xml version="1.0" encoding="UTF-8"? >
    <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 format

    {
      "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"
          }
        ]
      }
    }