Use DescribeVpnCrossAccountAuthorizations to query cross-account authorizations for IPsec-VPN connections - VPN Gateway - Alibaba Cloud - VPN Gateway

Queries the cross-account authorization information of an IPsec-VPN connection.

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:DescribeVpnCrossAccountAuthorizations

get

*VpnConnections

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPsec-VPN connection. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
VpnConnectionId	string	Yes	The ID of the IPsec-VPN connection.	vco-p0w2jpkhi2eeop6q6****
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paged query. Default value: 10. Valid values: 1 to 50.	10
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API request.	123e4567-e89b-12d3-a456-4266****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	DB04E39A-6F0C-36AC-BCA0-B6D371B90062
TotalCount	integer	The total number of entries returned.	1
PageNumber	integer	The page number of the list.	1
PageSize	integer	The number of entries per page in a paging query.	10
CrossAccountAuthorizations	array<object>	The list of cross-account authorization information for the IPsec-VPN connection.
	object	The cross-account authorization information of the IPsec-VPN connection.
VpnConnectionId	string	The ID of the IPsec-VPN connection.	vco-p0w2jpkhi2eeop6q6****
BindUid	integer	The ID of the Alibaba Cloud account to which the IPsec-VPN connection is authorized.	1210123456123456
BindProduct	string	The type of resource to which the IPsec-VPN connection is authorized. The value is CEN only, which indicates that the IPsec-VPN connection is authorized to a cross-account Cloud Enterprise Network (CEN) instance. The IPsec-VPN connection can be attached to a transit router instance under the cross-account CEN instance.	CEN
BindInstance	string	The instance ID of the CEN instance to which the IPsec-VPN connection authorization is granted.	cen-vv8h0t3klfpaae****
AliUid	integer	The ID of the Alibaba Cloud account to which the IPsec-VPN connection belongs.	1250123456123456
CreationTime	integer	The timestamp when the cross-account authorization was created for the IPsec-VPN connection. The timestamp is in the UNIX format and represents the total number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC to the time when the cross-account authorization was created.	1658201810000

Examples

Success response

JSON format

{
  "RequestId": "DB04E39A-6F0C-36AC-BCA0-B6D371B90062",
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "CrossAccountAuthorizations": [
    {
      "VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
      "BindUid": 1210123456123456,
      "BindProduct": "CEN",
      "BindInstance": "cen-vv8h0t3klfpaae****",
      "AliUid": 1250123456123456,
      "CreationTime": 1658201810000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.