All Products
Search
Document Center

Virtual Private Cloud:DescribeVpnCrossAccountAuthorizations

Last Updated:Nov 13, 2024

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

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeVpnCrossAccountAuthorizationsget
  • VpnConnections
    acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region to which the IPsec-VPN connection belongs.

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

cn-hangzhou
VpnConnectionIdstringYes

The ID of the IPsec-VPN connection.

vco-p0w2jpkhi2eeop6q6****
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.

10
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. ClientToken can contain only ASCII characters.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId of each API request may be different.
123e4567-e89b-12d3-a456-4266****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

DB04E39A-6F0C-36AC-BCA0-B6D371B90062
TotalCountinteger

The number of entries returned.

1
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

10
CrossAccountAuthorizationsarray<object>

The cross-account authorization information about the IPsec-VPN connection.

CrossAccountAuthorizationobject
VpnConnectionIdstring

The ID of the IPsec-VPN connection.

vco-p0w2jpkhi2eeop6q6****
BindUidlong

The ID of the Alibaba Cloud account whose resource the IPsec-VPN connection can be associated with.

1210123456123456
BindProductstring

The resource type of the authorization.

The value is set to CEN, which indicates that the IPsec-VPN connection can be associated with a transit router of a Cloud Enterprise Network (CEN) instance that belongs to another Alibaba Cloud account.

CEN
BindInstancestring

The ID of the CEN instance.

cen-vv8h0t3klfpaae****
AliUidlong

The ID of the Alibaba Cloud account to which the IPsec-VPN connection belongs.

1250123456123456
CreationTimelong

The timestamp when the authorization for the IPsec-VPN connection was created.

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.

1658201810000

Examples

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
No change history