DescribeCustomerGateway - VPN Gateway - Alibaba Cloud Documentation Center

Queries details of a customer gateway.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeCustomerGateway	get	*CustomerGateway `acs:vpc:{#regionId}:{#accountId}:customergateway/{#CustomerGatewayId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the customer gateway is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
CustomerGatewayId	string	Yes	The ID of the customer gateway.	cgw-bp1pvpl9r9adju6l5****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Asn	long	The autonomous system number (ASN) of the gateway device in the data center.	65535
RequestId	string	The request ID.	A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2
IpAddress	string	The public IP address of the gateway device in the data center.	139.32.XX.XX
Description	string	The description of the customer gateway.	desctest
CustomerGatewayId	string	The ID of the customer gateway.	cgw-bp1pvpl9r9adju6l5****
CreateTime	long	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.	1492747187000
Name	string	The name of the customer gateway.	nametest
AuthKey	string	The authentication key of the Border Gateway Protocol (BGP) routing protocol for the gateway device in the data center.	AuthKey****
Tags	array<object>	The list of tags added to the customer gateway.
Tag	object
Key	string	The key of tag N.	TagKey
Value	string	The value of tag N.	TagValue
ResourceGroupId	string	The ID of the resource group to which the customer gateway belongs. You can call the ListResourceGroups operation to query resource groups.	rg-acfmzs372yg****

Examples

Sample success responses

JSONformat

{
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-10-19	API Description Update. The Error code has changed. The response structure of the API has changed	View Change Details