Use DescribeCustomerGateway to query customer gateway details - VPN Gateway - Alibaba Cloud - VPN Gateway

Queries the details of a created customer gateway.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeCustomerGateway

get

*CustomerGateway

acs:vpc:{#regionId}:{#accountId}:customergateway/{#CustomerGatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the customer gateway. You can call DescribeRegions to query region IDs.	cn-shanghai
CustomerGatewayId	string	Yes	The instance ID of the customer gateway.	cgw-bp1pvpl9r9adju6l5****

Response elements

Element	Type	Description	Example
	object	The response parameters.
Asn	integer	The autonomous system number of the on-premises data center gateway device.	65535
RequestId	string	The request ID.	A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2
IpAddress	string	The IP address of the on-premises data center gateway device.	139.32.XX.XX
Description	string	The description of the customer gateway.	desctest
CustomerGatewayId	string	The instance ID of the customer gateway.	cgw-bp1pvpl9r9adju6l5****
CreateTime	integer	The timestamp when the customer gateway was created. Unit: milliseconds. The timestamp is in the UNIX format and represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1492747187000
Name	string	The name of the customer gateway.	nametest
AuthKey	string	The authentication key of the BGP routing protocol for the on-premises data center gateway device.	AuthKey****
Tags	object
Tag	array<object>	The list of tags bound to the customer gateway.
	object	The tag information.
Key	string	The tag key.	TagKey
Value	string	The tag value.	TagValue
ResourceGroupId	string	The ID of the resource group to which the customer gateway belongs. You can call ListResourceGroups to query resource group information.	rg-acfmzs372yg****

Examples

Success response

JSON format

{
  "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": {
    "Tag": [
      {
        "Key": "TagKey",
        "Value": "TagValue"
      }
    ]
  },
  "ResourceGroupId": "rg-acfmzs372yg****"
}

Error codes

HTTP status code	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.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
404	InvalidCustomerGatewayInstanceId.NotFound	The specified customer gateway instance id does not exist.	The specified customer gateway does not exist. Check whether the ID of the customer gateway is correct.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.