ListVirtualPhysicalConnections-阿里云帮助中心

Call the ListVirtualPhysicalConnections operation to query virtual physical 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PhysicalConnectionId	string	No	The ID of the physical connection associated with the virtual physical connection.	pc-bp1ciz7ekd2grn1as****
VirtualPhysicalConnectionBusinessStatus	string	No	The business status of the virtual physical connection. Valid values: Normal: The connection is operating normally. FinancialLocked: The connection is locked due to an overdue payment. SecurityLocked: The connection is locked for security reasons.	Normal
VirtualPhysicalConnectionIds	array	No	The IDs of the virtual physical connections.	pc-xxx
	string	No	The ID of a virtual physical connection.	pc-bp1mrgfbtmc9brre7****
IsConfirmed	boolean	No	Indicates whether the tenant has accepted the virtual physical connection. Valid values: true: The connection has been accepted. false: The connection has not been accepted.	true
VirtualPhysicalConnectionStatuses	array	No	The business statuses of the virtual physical connections.	pc-xxx
	string	No	The business status of the virtual physical connection. Valid values: Confirmed: The connection has been accepted. UnConfirmed: The connection is pending acceptance. Deleted: The connection has been deleted.	Confirmed
VirtualPhysicalConnectionAliUids	array	No	The Alibaba Cloud accounts that own the virtual physical connections.	189xxx
	string	No	The ID of the primary account that owns the virtual physical connection.	15346073170691****
VlanIds	array	No	The VLAN IDs of the virtual physical connections.	pc-xxx
	string	No	The VLAN ID of the virtual physical connection.	10
MaxResults	integer	No	The number of entries to return per page. Valid values: 1 to 100. Default value: 20.	20
NextToken	string	No	The token used to retrieve the next page of results. Valid values: Leave this parameter empty for the first request. For subsequent requests, set this parameter to the `NextToken` value returned from the previous request.	dd20****
RegionId	string	Yes	The ID of the region where the virtual physical connection is located. You can call the DescribeRegions operation to obtain the latest list of regions.	cn-shanghai
Tags	array<object>	No	The list of tags.
	object	No	A tag, which consists of a key-value pair.
Key	string	No	The key of the tag. You can specify up to 20 tags. The tag key cannot be an empty string. The 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 value of the tag. You can specify up to 20 tags. The tag value can be an empty string. The 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 virtual physical connection belongs.	rg-acfmxazb4p****

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	2A55F69E-EE3D-5CBE-8805-734F7D5B46B9
VirtualPhysicalConnections	array<object>	A list of virtual physical connections.
	array<object>	The details of a virtual physical connection.
Type	string	The type of the physical connection. The default value is VPC.	VPC
Status	string	The status of the physical connection. Valid values: Initial: The application is under review. Approved: The application is approved. Allocating: Resources are being allocated. Allocated: The connection is ready for provisioning. Confirmed: Awaiting user confirmation. Enabled: The connection is enabled. Rejected: The application is rejected. Canceled: The application is canceled. Allocation Failed: Resource allocation failed. Terminated: The connection is terminated.	Enabled
CreationTime	string	The time the physical connection was created.	2021-06-08T12:20:55
AdLocation	string	The physical location of the access device for the physical connection.	余杭经济开发区XXX交叉口, 余杭XX机房, E***包间
PortNumber	string	The port number of the access device for the physical connection.	80
Spec	string	The bandwidth of the virtual physical connection. M indicates Mbps, and G indicates Gbps.	50M
ChargeType	string	The billing method of the physical connection. The only valid value is Prepaid, which corresponds to the subscription billing method.	Prepaid
Description	string	The description of the physical connection.	desctest
Bandwidth	integer	The bandwidth of the physical connection. Unit: Mbps.	50
EnabledTime	string	The time the physical connection was enabled.	2021-10-08T10:44Z
LineOperator	string	The carrier that provides the physical connection. Valid values include: CT: China Telecom. CU: China Unicom. CM: China Mobile. CO: other Chinese carriers. Equinix: Equinix. Other: other carriers outside China.	CU
PeerLocation	string	The location of the on-premises data center.	浙江省杭州市XX区XX街道XX号
RedundantPhysicalConnectionId	string	The ID of the redundant physical connection.	pc-119mfjzm****
Name	string	The name of the physical connection.	nametest
CircuitCode	string	The circuit code of the physical connection, which is provided by the carrier.	longtel001
EndTime	string	The expiration time of the virtual physical connection. The time is in UTC and follows the `YYYY-MM-DDThh:mm:ssZ` format (ISO 8601).	2021-11-08T16:00:00Z
PortType	string	The port type of the physical connection access point. Valid values: 100Base-T: 100 Mbps copper port. 1000Base-T: 1 Gbps copper port. 1000Base-LX: 1 Gbps single-mode optical port (10 km). 10GBase-T: 10 Gbps copper port. 10GBase-LR: 10 Gbps single-mode optical port (10 km). 40GBase-LR: 40 Gbps single-mode optical port. 100GBase-LR: 100 Gbps single-mode optical port.	10GBase-LR
BusinessStatus	string	The business status of the physical connection. Valid values: Normal: The connection is running as expected. FinancialLocked: The connection is locked due to an overdue payment. SecurityLocked: The connection is locked for security reasons.	Normal
LoaStatus	string	The status of the Letter of Authorization (LOA). Valid values: Applying: The LOA request is being processed. Accept: The LOA application is approved. Available: The LOA is generated and ready for use. Rejected: The LOA request is rejected. Completing: The physical connection is being provisioned. Complete: Provisioning is complete. Deleted: The LOA is deleted.	Available
AccessPointId	string	The ID of the access point.	ap-cn-hangzhou-finance-yh-E
PhysicalConnectionId	string	The ID of the virtual physical connection.	pc-bp1mrgfbtmc9brre7****
ProductType	string	The type of the physical connection. Valid values: VirtualPhysicalConnection: a virtual physical connection. PhysicalConnection: a dedicated physical connection.	VirtualPhysicalConnection
ParentPhysicalConnectionId	string	The ID of the parent physical connection.	pc-bp1ciz7ekd2grn1as****
VirtualPhysicalConnectionStatus	string	The business status of the virtual physical connection. Valid values: Confirmed: The virtual physical connection has been accepted by the recipient. UnConfirmed: The virtual physical connection is awaiting acceptance. Deleted: The virtual physical connection is deleted.	Confirmed
ParentPhysicalConnectionAliUid	string	The ID of the Alibaba Cloud account that owns the parent physical connection.	18311773240248****
OrderMode	string	The billing method of the virtual physical connection. Valid values: PayByPhysicalConnectionOwner: The owner of the parent physical connection pays. PayByVirtualPhysicalConnectionOwner: The owner of the virtual physical connection pays.	PayByPhysicalConnectionOwner
AliUid	string	The ID of the Alibaba Cloud account that owns the virtual physical connection.	15346073170691****
VlanId	string	The VLAN ID of the virtual physical connection.	10
ExpectSpec	string	The expected bandwidth for the virtual physical connection. This bandwidth is applied after the payment is completed. M indicates Mbps, and G indicates Gbps.	50M
ResourceGroupId	string	The ID of the resource group to which the virtual physical connection belongs.	rg-acfm3wmsyui****
Tags	array<object>	A list of tags.
	object	The details of the tag.
Key	string	The tag key, which cannot be an empty string. You can specify up to 20 tag keys. The key can be up to 64 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	FinanceDept
Value	string	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 can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	FinanceJoshua
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Valid values: If NextToken is not returned, no more results are available. If a value is returned for NextToken, use it in the next request to retrieve the subsequent page of results.	dd20****
TotalCount	integer	The total number of entries.	1
Count	integer	The number of entries returned in this request.	1

Examples

Success response

JSON format

{
  "RequestId": "2A55F69E-EE3D-5CBE-8805-734F7D5B46B9",
  "VirtualPhysicalConnections": [
    {
      "Type": "VPC",
      "Status": "Enabled",
      "CreationTime": "2021-06-08T12:20:55",
      "AdLocation": "余杭经济开发区XXX交叉口, 余杭XX机房, E***包间",
      "PortNumber": "80",
      "Spec": "50M",
      "ChargeType": "Prepaid",
      "Description": "desctest",
      "Bandwidth": 50,
      "EnabledTime": "2021-10-08T10:44Z",
      "LineOperator": "CU",
      "PeerLocation": "浙江省杭州市XX区XX街道XX号",
      "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.