Queries the detailed information of a customer gateway.


By using API Explorer, you can easily debug APIs, automatically generate SDK code examples, and quickly search for APIs.

Request parameters

Parameter Type Required? Example value Description
Action String Yes DescribeCustomerGateway

The name of this action. Value:


CustomerGatewayId String Yes vpn-bp1q8bgx4xnkm2ogj0fiu

The ID of the customer gateway.

RegionId String Yes cn-shanghai

The ID of the region to which the customer gateway belongs.

To query the region ID, call DescribeRegions.

Response parameters

Parameter Type Example value Description
CustomerGatewayId String cgw-bp1pvpl9r9adju6l5nxck

The ID of the customer gateway.

Name String test

The name of the customer gateway.

Description String test

The description of the customer gateway.

IpAddress String 139.196.32.xxx

The IP address of the customer gateway.

RequestId String 99506ECB-218F-45A5-AE8E-79518451F615

The ID of the request.

CreateTime Long 1492747187000

The time at which the customer gateway was created.


Request example

Response example
  • XML format

  • JSON format


Error codes

HTTP status code Error code Error message Description
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user. You are not authorized to operate on this resource. Please apply for the permission and try again later.
403 Forbidden User not authorized to operate on the specified resource. You are not authorized to operate on this resource. For more information, open a ticket.
404 InvalidCustomerGatewayInstanceId.NotFound The specified customer gateway instance id does not exist. The specified instance does not exist.

See common error codes