edit-icon download-icon

DescribeCustomerGateway

Last Updated: Apr 12, 2018

Description

Query the detailed information of a customer gateway.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: DescribeCustomerGateway

RegionId String Yes

The region of the customer gateway.

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

CustomerGatewayId String Yes The ID of the customer gateway.

Response parameters

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 creation time of the customer gateway.

Error codes

See VPC API Error Center.

Examples

Request example

  1. https://vpc.aliyuncs.com/?Action=DescribeCustomerGateway
  2. &RegionID=cn-beijing
  3. &CustomerGatewayId=cgw-bp1pvpl9r9adju6l5nxck
  4. &<CommonParameters>

Response example

XML format

  1. <DescribeCustomerGatewayResponse>
  2. <Name>test</Name>
  3. <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5nxck</CustomerGatewayId>
  4. <CreateTime>1492747187000</CreateTime>
  5. <RequestId>99506ECB-218F-45A5-AE8E-79518451F615</RequestId>
  6. <IpAddress>139.196.32.167</IpAddress>
  7. </DescribeCustomerGatewayResponse>

JSON format

  1. {
  2. "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5nxck",
  3. "Name": "test",
  4. "RequestId": "A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2",
  5. "CreateTime": 1492747187000,
  6. "IpAddress": "139.196.32.167"
  7. }
Thank you! We've received your feedback.