Queries details of a specified customer gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCustomerGateway

The operation that you want to perform. Set the value to DescribeCustomerGateway.

CustomerGatewayId String Yes cgw-bp1pvpl9r9adju6l5****

The ID of the customer gateway.

RegionId String Yes cn-shanghai

The ID of the region where the customer gateway is deployed.

You can call the DescribeRegions operation to query the most recent region list.

Response parameters

Parameter Type Example Description
CustomerGatewayId String cgw-bp1pvpl9r9adju6l5****

The ID of the customer gateway.

Name String nametest

The name of the customer gateway.

Description String desctest

The description of the customer gateway.

IpAddress String 139.XX.XX.32

The static public IP address of the gateway device in the data center.

RequestId String A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2

The ID of the request.

CreateTime Long 1492747187000

The timestamp generated when the customer gateway was created.

Asn Long 65535

The autonomous system number (ASN) of the gateway device in the data center.

AuthKey String AuthKey****

The authentication key of the BGP routing protocol for the gateway device in the data center.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCustomerGateway
&CustomerGatewayId=cgw-bp1pvpl9r9adju6l5****
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<DescribeCustomerGatewayResponse>
  <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5****</CustomerGatewayId>
  <Name>nametest</Name>
  <RequestId>A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2</RequestId>
  <CreateTime>1492747187000</CreateTime>
  <AuthKey>AuthKey****</AuthKey>
  <IpAddress>139.XX.XX.32</IpAddress>
  <Asn>65535</Asn>
</DescribeCustomerGatewayResponse>

JSON format

{
    "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
    "Name": "nametest",
    "RequestId": "A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2",
    "CreateTime": 1492747187000,
    "AuthKey": "AuthKey****",
    "IpAddress": "139.XX.XX.32",
    "Asn": 65535
}

Error codes

HttpCode 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. The error message returned because you are unauthorized to perform this operation on the specified resource. You can apply for the required permissions and try again.
403 Forbidden User not authorized to operate on the specified resource. The error message returned because you are unauthorized to perform this operation on the specified resource. To acquire the required permissions, submit a ticket.
404 InvalidCustomerGatewayInstanceId.NotFound The specified customer gateway instance id does not exist. The error message returned because the specified customer gateway does not exist. Check whether the ID of the customer gateway is correct.

For a list of error codes, visit the API Error Center.