Queries information about hosted connections.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListVirtualPhysicalConnections

The operation that you want to perform. Set the value to ListVirtualPhysicalConnections.

PhysicalConnectionId String No pc-bp1ciz7ekd2grn1as****

The ID of the Express Connect circuit over which the hosted connections are created.

Express Connect circuits in this topic refer to shared Express Connect circuits over which hosted connections are created.

VirtualPhysicalConnectionBusinessStatus String No Normal

The business status of the hosted connections. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked for security reasons
IsConfirmed Boolean No true

Specifies whether the hosted connections are accepted by tenants. Valid values:

  • true: yes
  • false: no
MaxResults Integer No 20

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

NextToken String No dd20****

The token that is used for the next query.

RegionId String Yes cn-shanghai

The region ID of the hosted connections.

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

VirtualPhysicalConnectionIds.N String No pc-bp1mrgfbtmc9brre7****

The ID of the hosted connection.

You can specify multiple hosted connection IDs. Valid values of N: 1 to 20.

VirtualPhysicalConnectionStatuses.N String No Confirmed

The service status of the hosted connections. Valid values:

  • Confirmed: accepted
  • UnConfirmed: not accepted
  • Deleted: deleted

You can specify multiple states. Valid values of N: 1 to 20.

VirtualPhysicalConnectionAliUids.N String No 253460731706911258

The Alibaba Cloud account ID of the hosted connection owner.

You can specify multiple Alibaba Cloud account IDs. Valid values of N: 1 to 20.

VlanIds.N String No 10

The VLAN ID of the hosted connection.

You can specify multiple VLAN IDs. Valid values of N: 1 to 20.

Response parameters

Parameter Type Example Description
RequestId String 2A55F69E-EE3D-5CBE-8805-734F7D5B46B9

The ID of the request.

VirtualPhysicalConnections Array of VirtualPhysicalConnection

The list of hosted connections returned.

Type String VPC

The type of the Express Connect circuit. Default value: VPC.

Status String Enabled

The status of the Express Connect circuit. Valid values:

  • Initial: The application is under review.
  • Approved: The application is approved.
  • Allocating: The system is allocating resources.
  • Allocated: The Express Connect circuit is under construction.
  • Confirmed: The Express Connect circuit is pending for user confirmation.
  • Enabled: The Express Connect circuit is enabled.
  • Rejected: The application is rejected.
  • Canceled: The application is canceled.
  • Allocation Failed: The system failed to allocate resources.
  • Terminated: The Express Connect circuit is disabled.
CreationTime String 2017-06-08T12:20:55

The time when the Express Connect circuit was created.

AdLocation String Server Room E***, Data Center XX, XXX Intersection, Yuhang Economic Development Zone

The geographical location of the access device.

PortNumber String 80

The port number of the access device.

Spec String 50M

The bandwidth value of the hosted connection.

M indicates Mbit/s and G indicates Gbit/s.

ChargeType String Prepaid

The billing method of the Express Connect circuit.

The value is set to Prepaid, which indicates the subscription billing method.

Description String desctest

The description of the Express Connect circuit.

Bandwidth Long 50

The bandwidth of the Express Connect circuit. Unit: Mbit/s.

EnabledTime String 2021-10-08T10:44Z

The time when the Express Connect circuit was enabled.

LineOperator String CU

The connectivity provider of the Express Connect circuit. Valid values:

  • CT: China Telecom
  • CU: China Unicom
  • CM: China Mobile
  • CO: other connectivity providers in the Chinese mainland
  • Equinix: Equinix
  • Other: other connectivity providers outside the Chinese mainland
PeerLocation String Building XX, XX Avenue, XX District, Hangzhou, Zhejiang

The geographical location of the data center.

RedundantPhysicalConnectionId String pc-119mfjzm****

The ID of the redundant Express Connect circuit.

Name String nametest

The name of the Express Connect circuit.

CircuitCode String longtel001

The circuit code of the Express Connect circuit. The circuit code is predefined by the connectivity provider.

EndTime String 2021-11-08T16:00:00Z

The expiration date of the hosted connection.

The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

PortType String 10GBase-LR

The port type of the Express Connect circuit. Valid values:

  • 100Base-T: 100 Mbit/s copper Ethernet port
  • 1000Base-T: 1,000 Mbit/s copper Ethernet port
  • 1000Base-LX: 1,000 Mbit/s single-mode optical port (10 kilometers)
  • 10GBase-T: 10,000 Mbit/s copper Ethernet port
  • 10GBase-LR: 10,000 Mbit/s single-mode optical port (10 kilometers)
BusinessStatus String Normal

The business status of the Express Connect circuit. Valid values:

  • Normal: enabled
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked for security reasons
LoaStatus String Available

The status of the Letter of Authorization (LOA). Valid values:

  • Applying: The LOA is pending for approval.
  • Accept: The LOA is approved.
  • Available: The LOA is available.
  • Rejected: The LOA is rejected.
  • Completing: The Express Connect circuit is under construction.
  • Complete: The Express Connect circuit is installed.
  • Deleted: The LOA is deleted.
AccessPointId String ap-cn-hangzhou-finance-yh-E

The ID of the access point that is associated with the Express Connect circuit.

PhysicalConnectionId String pc-bp1mrgfbtmc9brre7****

The ID of the hosted connection.

ProductType String VirtualPhysicalConnection

The type of the Express Connect circuit. Valid values:

  • VirtualPhysicalConnection: shared
  • PhysicalConnection: dedicated
ParentPhysicalConnectionId String pc-bp1ciz7ekd2grn1as****

The ID of the Express Connect circuit.

VirtualPhysicalConnectionStatus String Confirmed

The service status of the hosted connection. Valid values:

  • Confirmed: accepted
  • UnConfirmed: not accepted
  • Deleted: deleted
ParentPhysicalConnectionAliUid String 283117732402483989

The ID of the Alibaba Cloud account to which the Express Connect circuit belongs.

OrderMode String PayByPhysicalConnectionOwner

The party that pays for the hosted connection. Valid values:

  • PayByPhysicalConnectionOwner: the owner of the shared Express Connect circuit
  • PayByVirtualPhysicalConnectionOwner: the owner of the hosted connection
AliUid String 253460731706911258

The Alibaba Cloud account ID of the hosted connection owner.

VlanId String 10

The VLAN ID of the hosted connection.

ExpectSpec String 50M

The estimated bandwidth value of the hosted connection. The estimated bandwidth value takes effect after the payment is completed.

M indicates Mbit/s and G indicates Gbit/s.

NextToken String dd20****

The token that is used for the next query.

TotalCount Integer 1

The total number of entries returned.

Count Integer 1

The number of entries returned in this query.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListVirtualPhysicalConnections
&PhysicalConnectionId=pc-bp1ciz7ekd2grn1as****
&VirtualPhysicalConnectionBusinessStatus=Normal
&VirtualPhysicalConnectionIds=["pc-bp1mrgfbtmc9brre7****"]
&IsConfirmed=true
&VirtualPhysicalConnectionStatuses=["Confirmed"]
&VirtualPhysicalConnectionAliUids=["253460731706911258"]
&VlanIds=["10"]
&MaxResults=20
&NextToken=dd20****
&RegionId=cn-shanghai
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListVirtualPhysicalConnectionsResponse>
    <RequestId>2A55F69E-EE3D-5CBE-8805-734F7D5B46B9</RequestId>
    <VirtualPhysicalConnections>
        <Type>VPC</Type>
        <Status>Enabled</Status>
        <CreationTime>2017-06-08T12:20:55</CreationTime>
        <AdLocation>Server Room E***, Data Center XX, XXX Intersection, Yuhang Economic Development Zone</AdLocation>
        <PortNumber>80</PortNumber>
        <Spec>50M</Spec>
        <ChargeType>Prepaid</ChargeType>
        <Description>desctest</Description>
        <Bandwidth>50</Bandwidth>
        <EnabledTime>2021-10-08T10:44Z</EnabledTime>
        <LineOperator>CU</LineOperator>
        <PeerLocation>Building XX, XX Avenue, XX District, Hangzhou, Zhejiang</PeerLocation>
        <RedundantPhysicalConnectionId>pc-119mfjzm****</RedundantPhysicalConnectionId>
        <Name>nametest</Name>
        <CircuitCode>longtel001</CircuitCode>
        <EndTime>2021-11-08T16:00:00Z</EndTime>
        <PortType>10GBase-LR</PortType>
        <BusinessStatus>Normal</BusinessStatus>
        <LoaStatus>Available</LoaStatus>
        <AccessPointId>ap-cn-hangzhou-finance-yh-E</AccessPointId>
        <PhysicalConnectionId>pc-bp1mrgfbtmc9brre7****</PhysicalConnectionId>
        <ProductType>VirtualPhysicalConnection</ProductType>
        <ParentPhysicalConnectionId>pc-bp1ciz7ekd2grn1as****</ParentPhysicalConnectionId>
        <VirtualPhysicalConnectionStatus>Confirmed</VirtualPhysicalConnectionStatus>
        <ParentPhysicalConnectionAliUid>283117732402483989</ParentPhysicalConnectionAliUid>
        <OrderMode>PayByPhysicalConnectionOwner</OrderMode>
        <AliUid>253460731706911258</AliUid>
        <VlanId>10</VlanId>
        <ExpectSpec>50M</ExpectSpec>
    </VirtualPhysicalConnections>
    <NextToken>dd20****</NextToken>
    <TotalCount>1</TotalCount>
    <Count>1</Count>
</ListVirtualPhysicalConnectionsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2A55F69E-EE3D-5CBE-8805-734F7D5B46B9",
  "VirtualPhysicalConnections" : [ {
    "Type" : "VPC",
    "Status" : "Enabled",
    "CreationTime" : "2017-06-08T12:20:55",
    "AdLocation" : "Server Room E***, Data Center XX, XXX Intersection, Yuhang Economic Development Zone",
    "PortNumber" : "80",
    "Spec" : "50M",
    "ChargeType" : "Prepaid",
    "Description" : "desctest",
    "Bandwidth" : 50,
    "EnabledTime" : "2021-10-08T10:44Z",
    "LineOperator" : "CU",
    "PeerLocation" : "Building XX, XX Avenue, XX District, Hangzhou, Zhejiang",
    "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" : "283117732402483989",
    "OrderMode" : "PayByPhysicalConnectionOwner",
    "AliUid" : "253460731706911258",
    "VlanId" : "10",
    "ExpectSpec" : "50M"
  } ],
  "NextToken" : "dd20****",
  "TotalCount" : 1,
  "Count" : 1
}

Error codes

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

For a list of error codes, visit the API Error Center.