DescribeCustomerGateway - API reference| Alibaba Cloud Documentation Center

Description

Query the detailed information of a customer gateway.

Request parameters

Name Type Required Description

Action

String

Yes

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.

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

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

Response example

XML format

<DescribeCustomerGatewayResponse>
    <Name>test</Name>
    <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5nxck</CustomerGatewayId>
    <CreateTime>1492747187000</CreateTime>
    <RequestId>99506ECB-218F-45A5-AE8E-79518451F615</RequestId>
    <IpAddress>139.196.32.167</IpAddress>
</DescribeCustomerGatewayResponse>

JSON format

{
  "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5nxck",
  "Name": "test",
  "RequestId": "A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2",
  "CreateTime": 1492747187000,
  "IpAddress": "139.196.32.167"
}