ListVirtualPhysicalConnections API Overview - Express Connect - Alibaba Cloud - Express Connect

Queries information about shared Express Connect circuits.

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

list

*PhysicalConnection

acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#PhysicalConnectionId}

None

Request parameters

Parameter	Type	Required	Description	Example
PhysicalConnectionId	string	No	The ID of the Express Connect circuit associated with the shared Express Connect circuits. In the following content of this topic, the Express Connect circuit associated with the shared Express Connect circuits is referred to as the Express Connect circuit, to distinguish it from the shared Express Connect circuits.	pc-bp1ciz7ekd2grn1as****
VirtualPhysicalConnectionBusinessStatus	string	No	The business status of the shared Express Connect circuits. Valid values: Normal: Normal. FinancialLocked: Locked due to overdue payment. SecurityLocked: Locked for security reasons.	Normal
VirtualPhysicalConnectionIds	array	No	The shared Express Connect circuits information.	pc-xxx
	string	No	The instance ID of the shared Express Connect circuits. You can specify multiple instance IDs. Valid values of N: 1 to 20.	pc-bp1mrgfbtmc9brre7****
IsConfirmed	boolean	No	Specifies whether the shared Express Connect circuits have been confirmed and accepted by the tenant. Valid values: true: Yes. false: No.	true
VirtualPhysicalConnectionStatuses	array	No	The business status information of the shared Express Connect circuits.	pc-xxx
	string	No	The business status of the shared Express Connect circuits. Valid values: Confirmed: The shared Express Connect circuits have been accepted. UnConfirmed: The shared Express Connect circuits have not been accepted. Deleted: The shared Express Connect circuits have been deleted. You can specify multiple business statuses. Valid values of N: 1 to 20.	Confirmed
VirtualPhysicalConnectionAliUids	array	No	The Alibaba Cloud account information of the shared Express Connect circuits owner.	189xxx
	string	No	The Alibaba Cloud account ID of the shared Express Connect circuits owner. You can specify multiple Alibaba Cloud account IDs. Valid values of N: 1 to 20.	15346073170691****
VlanIds	array	No	The VLAN ID of the shared Express Connect circuits.	pc-xxx
	string	No	The VLAN ID of the shared Express Connect circuits. You can specify multiple VLAN IDs. Valid values of N: 1 to 20.	10
MaxResults	integer	No	The number of entries per page when you query results by page. Valid values: 1 to 100. Default value: 20.	20
NextToken	string	No	Specifies whether a next query token exists. Valid values: You do not need to specify this parameter for the first query or if no next query exists. If a next query exists, set this parameter to the NextToken value returned by the previous API call.	dd20****
RegionId	string	Yes	The region ID of the shared Express Connect circuits. You can invoke the DescribeRegions operation to query the region ID.	cn-shanghai
Tags	array<object>	No	The tag list.
	object	No	The tag list.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua
ResourceGroupId	string	No	The ID of the resource group to which the shared Express Connect circuits belong.	rg-acfmxazb4p****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	2A55F69E-EE3D-5CBE-8805-734F7D5B46B9
VirtualPhysicalConnections	array<object>	The list of shared Express Connect circuits.
	array<object>	The details of the shared Express Connect circuits.
Type	string	The type of the Express Connect circuit. Default value: VPC.	VPC
Status	string	The status of the Express Connect circuit. Valid values: Initial: The application is under review. Approved: The application is approved. Allocating: Resources are being allocated. Allocated: Under construction. Confirmed: Waiting for user confirmation. Enabled: Enabled. Rejected: The application is rejected. Canceled: Canceled. Allocation Failed: Resource allocation failed. Terminated: Terminated.	Enabled
CreationTime	string	The time when the Express Connect circuit was created. The time is displayed in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-06-08T12:20:55Z
AdLocation	string	The physical location of the access device for the Express Connect circuit.	Yuhang Economic Development Zone, XX Intersection, Yuhang XX Data Center, Room E***
PortNumber	string	The port number of the access device for the Express Connect circuit.	80
Spec	string	The bandwidth value of the shared Express Connect circuits. Unit: M indicates Mbit/s, and G indicates Gbit/s.	50M
ChargeType	string	The billing method of the Express Connect circuit. Valid values: Prepaid, which indicates subscription.	Prepaid
Description	string	The description of the Express Connect circuit.	desctest
Bandwidth	integer	The bandwidth of the Express Connect circuit. Unit: Mbit/s.	50
EnabledTime	string	The time when the Express Connect circuit was enabled. The time is displayed in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-10-08T10:44:00Z
LineOperator	string	The carrier that provides the physical line for access. Valid values: CT: China Telecom. CU: China Unicom. CM: China Mobile. CO: Other carriers in the Chinese mainland. Equinix: Equinix. Other: Other carriers outside the Chinese mainland.	CU
PeerLocation	string	The geographic location of the on-premises data center.	No. XX, XX Street, XX District, Hangzhou, Zhejiang Province
RedundantPhysicalConnectionId	string	The ID of the redundant Express Connect circuit.	pc-119mfjzm****
Name	string	The name of the Express Connect circuit.	nametest
CircuitCode	string	The circuit code provided by the carrier for the Express Connect circuit.	longtel001
EndTime	string	The expiration time of the shared Express Connect circuits. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2021-11-08T16:00:00Z
PortType	string	The port type of the access device for the Express Connect circuit. Valid values: 100Base-T: 100M Ethernet port. 1000Base-T: GE electrical port. 1000Base-LX: GE single-mode optical port (10 km). 10GBase-T: 10 GE electrical port. 10GBase-LR: 10 GE single-mode optical port (10 km). 40GBase-LR: 40 GE single-mode optical port. 100GBase-LR: 100 GE single-mode optical port.	10GBase-LR
BusinessStatus	string	The business status of the Express Connect circuit. Valid values: Normal: Enabled. FinancialLocked: Locked due to overdue payment. SecurityLocked: Locked for security reasons.	Normal
LoaStatus	string	The status of the Letter of Authorization (LOA). Valid values: Applying: The LOA application is being processed. Accept: The LOA application is approved. Available: The LOA is available. Rejected: The LOA application is rejected. Completing: The Express Connect circuit is under construction. Complete: The Express Connect circuit construction is complete. Deleted: The LOA is deleted.	Available
AccessPointId	string	The access point ID of the Express Connect circuit.	ap-cn-hangzhou-finance-yh-E
PhysicalConnectionId	string	The instance ID of the shared Express Connect circuits.	pc-bp1mrgfbtmc9brre7****
ProductType	string	The type of the Express Connect circuit. Valid values: VirtualPhysicalConnection: Shared Express Connect circuits. PhysicalConnection: Dedicated Express Connect circuit.	VirtualPhysicalConnection
ParentPhysicalConnectionId	string	The instance ID of the Express Connect circuit.	pc-bp1ciz7ekd2grn1as****
VirtualPhysicalConnectionStatus	string	The business status of the shared Express Connect circuits. Valid values: Confirmed: The shared Express Connect circuits have been accepted. UnConfirmed: The shared Express Connect circuits have not been accepted. Deleted: The shared Express Connect circuits have been deleted.	Confirmed
ParentPhysicalConnectionAliUid	string	The Alibaba Cloud account ID that owns the Express Connect circuit.	18311773240248****
OrderMode	string	The payer of the shared Express Connect circuits. Valid values: PayByPhysicalConnectionOwner: The owner of the Express Connect circuit associated with the shared Express Connect circuits is the payer. PayByVirtualPhysicalConnectionOwner: The owner of the shared Express Connect circuits is the payer.	PayByPhysicalConnectionOwner
AliUid	string	The Alibaba Cloud account ID of the shared Express Connect circuits owner.	15346073170691****
VlanId	string	The VLAN ID of the shared Express Connect circuits.	10
ExpectSpec	string	The expected bandwidth value of the shared Express Connect circuits. The expected bandwidth value takes effect only after payment is completed. Unit: M indicates Mbit/s, and G indicates Gbit/s.	50M
ResourceGroupId	string	The ID of the resource group to which the shared Express Connect circuits belong.	rg-acfm3wmsyui****
Tags	array<object>	The tag list.
	object	The tag list.
Key	string	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua
NextToken	string	Indicates whether a next query token exists. Valid values: If NextToken is empty, no next query exists. If NextToken has a return value, the value is the token for the next query.	dd20****
TotalCount	integer	The total number of entries returned.	1
Count	integer	The number of entries returned in the current query.	1

Examples

Success response

JSON format

{
  "RequestId": "2A55F69E-EE3D-5CBE-8805-734F7D5B46B9",
  "VirtualPhysicalConnections": [
    {
      "Type": "VPC",
      "Status": "Enabled",
      "CreationTime": "2021-06-08T12:20:55Z",
      "AdLocation": "Yuhang Economic Development Zone, XXX Intersection, Yuhang XX Data Center, Room E***",
      "PortNumber": "80",
      "Spec": "50M",
      "ChargeType": "Prepaid",
      "Description": "desctest",
      "Bandwidth": 50,
      "EnabledTime": "2021-10-08T10:44:00Z",
      "LineOperator": "CU",
      "PeerLocation": "No. XX, XX Street, XX District, Hangzhou, Zhejiang Province",
      "RedundantPhysicalConnectionId": "pc-119mfjzm****",
      "Name": "nametest",
      "CircuitCode": "longtel001",
      "EndTime": "2021-11-08T16:00:00Z",
      "PortType": "10GBase-LR",
      "BusinessStatus": "Normal",
      "LoaStatus": "Available",
      "AccessPointId": "ap-cn-hangzhou-finance-yh-E",
      "PhysicalConnectionId": "pc-bp1mrgfbtmc9brre7****",
      "ProductType": "VirtualPhysicalConnection",
      "ParentPhysicalConnectionId": "pc-bp1ciz7ekd2grn1as****",
      "VirtualPhysicalConnectionStatus": "Confirmed",
      "ParentPhysicalConnectionAliUid": "18311773240248****",
      "OrderMode": "PayByPhysicalConnectionOwner",
      "AliUid": "15346073170691****",
      "VlanId": "10",
      "ExpectSpec": "50M",
      "ResourceGroupId": "rg-acfm3wmsyui****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ],
  "NextToken": "dd20****",
  "TotalCount": 1,
  "Count": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.Bandwidth	The param of Bandwidth [%s] is illegal.	The specified bandwidth value is invalid.
400	ResourceNotFound.PhysicalConnectionId	The specified PhysicalConnectionId [%s] is not found.	PhysicalConnectionId is set to an invalid value.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.