Queries the detailed information about a specified customer gateway.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeCustomerGateway | The operation that you want to perform. Set the value to DescribeCustomerGateway. |
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. |
CustomerGatewayId | String | Yes | cgw-bp1pvpl9r9adju6l5**** | The ID of the customer gateway. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Asn | Long | 65535 | The autonomous system number (ASN) of the gateway device in the data center. |
RequestId | String | A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2 | The ID of the request. |
IpAddress | String | 139.32.XX.XX | The public IP address of the gateway device in the data center. |
Description | String | desctest | The description of the customer gateway. |
CustomerGatewayId | String | cgw-bp1pvpl9r9adju6l5**** | The ID of the customer gateway. |
CreateTime | Long | 1492747187000 | The timestamp generated when the customer gateway was created. Unit: milliseconds. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC. |
Name | String | nametest | The name of the customer gateway. |
AuthKey | String | AuthKey**** | The authentication key of the BGP routing protocol for the gateway device in the data center. |
Tags | Array of Tag | The list of tags added to the customer gateway. |
|
Tag | |||
Key | String | TagKey | The tag key. |
Value | String | TagValue | The tag value. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeCustomerGateway
&RegionId=cn-shanghai
&CustomerGatewayId=cgw-bp1pvpl9r9adju6l5****
&Common request parameters
Sample success response
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeCustomerGatewayResponse>
<Asn>65535</Asn>
<RequestId>A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2</RequestId>
<IpAddress>139.32.XX.XX</IpAddress>
<Description>desctest</Description>
<CustomerGatewayId>cgw-bp1pvpl9r9adju6l5****</CustomerGatewayId>
<CreateTime>1492747187000</CreateTime>
<Name>nametest</Name>
<AuthKey>AuthKey****</AuthKey>
<Tags>
<Key>TagKey</Key>
<Value>TagValue</Value>
</Tags>
</DescribeCustomerGatewayResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Asn" : 65535,
"RequestId" : "A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2",
"IpAddress" : "139.32.XX.XX",
"Description" : "desctest",
"CustomerGatewayId" : "cgw-bp1pvpl9r9adju6l5****",
"CreateTime" : 1492747187000,
"Name" : "nametest",
"AuthKey" : "AuthKey****",
"Tags" : [ {
"Key" : "TagKey",
"Value" : "TagValue"
} ]
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
403 | Forbidden.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. Acquire 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. Acquire the required permissions and try again. |
404 | InvalidCustomerGatewayInstanceId.NotFound | The specified customer gateway instance id does not exist. | The error message returned because the specified customer gateway instance does not exist. Check whether the ID of the customer gateway is valid. |
For a list of error codes, see Service error codes.