ListVpcPeerConnections - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the details of one or more VPC peering connections.

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

list

*VpcPeer

acs:vpc:*:{#AccountId}:vpcpeer/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the VPC peering connection. You can call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
InstanceId	string	No	The ID of the VPC peering connection.	pcc-lnk0m24khwvtkm****
VpcId	array	No	The ID of a VPC in the peering connection. You can specify the ID of the requester or accepter VPC. If you specify only one VPC ID, the query returns all peering connections that involve the specified VPC.
	string	No	The ID of the requester or accepter VPC.	vpc-bp1gsk7h12ew7oegk****
Name	string	No	The name of the VPC peering connection.	vpcpeer
NextToken	string	No	The token that is used for the next query. Valid values: Do not specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	20
Tags	array<object>	No	The tags.
	object	No	The tags.
Value	string	No	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	FinanceJoshua
Key	string	No	The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string. The key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	FinanceDept
ResourceGroupId	string	No	The ID of the resource group. For more information about resource groups, see What is a resource group?.	rg-acfmxazb4ph6aiy****

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED39DCAC0
TotalCount	integer	The number of entries.	1
MaxResults	integer	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	20
NextToken	string	The token that is used for the next query. Valid values: If NextToken is empty, no more results are available. If a value is returned for NextToken, the value is the token that you can use in the next request to retrieve more results.	FFmyTO70tTpLG6I3FmYAXGKPd****
VpcPeerConnects	array<object>	The details of the VPC peering connections.
	object	The details of the VPC peering connection.
AcceptingOwnerUid	integer	The ID of the Alibaba Cloud account to which the accepter VPC belongs.	25346073170691****
Status	string	The status of the VPC peering connection. Valid values: Creating Accepting Updating Rejected Expired Activated Deleting Deleted For more information about the states of a VPC peering connection, see VPC Peering Connection Overview.	Activated
ManagedService	string	The Alibaba Cloud service to which the resource belongs.	SWAS
Description	string	The description of the VPC peering connection.	test
ResourceGroupId	string	The ID of the resource group.	rg-acfmxazb4ph6aiy****
InstanceId	string	The ID of the VPC peering connection.	pcc-lnk0m24khwvtkm****
AcceptingRegionId	string	The region ID of the accepter VPC.	cn-hangzhou
GmtModified	string	The time when the VPC peering connection was modified. The time is displayed in UTC in the `YYYY-MM-DDThh:mm:ssZ` format.	2022-04-24T19:20:45Z
Vpc	object	The details of the requester VPC.
VpcId	string	The ID of the requester VPC.	vpc-bp1gsk7h12ew7oegk****
Ipv6Cidrs	array	The IPv6 CIDR block of the requester VPC.
	string	The IPv6 CIDR block of the requester VPC.	2408:XXXX:3c5:6e00::/56
Ipv4Cidrs	array	The IPv4 CIDR block of the requester VPC.
	string	The IPv4 CIDR block of the requester VPC.	192.168.0.0/16
GmtExpired	string	The time when the VPC peering connection expires. The time is displayed in UTC in the `YYYY-MM-DDThh:mm:ssZ` format. This parameter is returned only when the VPC peering connection is in the Accepting or Expired state. For other states, this parameter is empty.	2022-05-01T09:02:36Z
Name	string	The name of the VPC peering connection.	vpcpeer
BizStatus	string	The business status of the VPC peering connection. Valid values: Normal FinancialLocked: The VPC peering connection is locked due to an overdue payment.	Normal
GmtCreate	string	The time when the VPC peering connection was created. The time is displayed in UTC in the `YYYY-MM-DDThh:mm:ssZ` format.	2022-04-24T09:02:36Z
OwnerId	integer	The ID of the Alibaba Cloud account to which the requester VPC belongs.	25346073170691****
Bandwidth	integer	The bandwidth of the VPC peering connection. Unit: Mbit/s. The value must be an integer that is greater than 0. Note A value of -1 indicates that no limit is imposed on the bandwidth. Default values: The default bandwidth for a cross-region VPC peering connection is 1024 Mbit/s. The default bandwidth for an intra-region VPC peering connection is -1. This value indicates that no limit is imposed on the bandwidth.	1024
RegionId	string	The region ID of the requester VPC.	cn-hangzhou
AcceptingVpc	object	The details of the accepter VPC.
VpcId	string	The ID of the accepter VPC.	vpc-bp1vzjkp2q1xgnind****
Ipv6Cidrs	array	The IPv6 CIDR block of the accepter VPC.
	string	The IPv6 CIDR block of the accepter VPC.	2408:XXXX:3b8:3a00::/56
Ipv4Cidrs	array	The IPv4 CIDR block of the accepter VPC.
	string	The IPv4 CIDR block of the accepter VPC.	10.0.0.0/16
LinkType	string	The link type of the VPC peering connection. Default values: The default link type for a cross-region VPC peering connection is Gold. The default link type for an intra-region VPC peering connection is empty.	Gold
Tags	array<object>	The tags.
	object	The tags.
Value	string	The tag value.	FinanceJoshua
Key	string	The tag key.	FinanceDept

Examples

Success response

JSON format

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED39DCAC0",
  "TotalCount": 1,
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "VpcPeerConnects": [
    {
      "AcceptingOwnerUid": 0,
      "Status": "Activated",
      "ManagedService": "SWAS",
      "Description": "test",
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "InstanceId": "pcc-lnk0m24khwvtkm****",
      "AcceptingRegionId": "cn-hangzhou",
      "GmtModified": "2022-04-24T19:20:45Z",
      "Vpc": {
        "VpcId": "vpc-bp1gsk7h12ew7oegk****",
        "Ipv6Cidrs": [
          "2408:XXXX:3c5:6e00::/56"
        ],
        "Ipv4Cidrs": [
          "192.168.0.0/16"
        ]
      },
      "GmtExpired": "2022-05-01T09:02:36Z",
      "Name": "vpcpeer",
      "BizStatus": "Normal",
      "GmtCreate": "2022-04-24T09:02:36Z",
      "OwnerId": 0,
      "Bandwidth": 1024,
      "RegionId": "cn-hangzhou",
      "AcceptingVpc": {
        "VpcId": "vpc-bp1vzjkp2q1xgnind****",
        "Ipv6Cidrs": [
          "2408:XXXX:3b8:3a00::/56"
        ],
        "Ipv4Cidrs": [
          "10.0.0.0/16"
        ]
      },
      "LinkType": "Gold",
      "Tags": [
        {
          "Value": "FinanceJoshua",
          "Key": "FinanceDept"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.