All Products
Search
Document Center

Virtual Private Cloud:ListVirtualPhysicalConnections

Last Updated:Jul 10, 2024

Queries hosted connections.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PhysicalConnectionIdstringNo

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

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

pc-bp1ciz7ekd2grn1as****
VirtualPhysicalConnectionBusinessStatusstringNo

The business status of the hosted connection. Valid values:

  • Normal
  • FinancialLocked
  • SecurityLocked
Normal
VirtualPhysicalConnectionIdsarrayNo

The information about the hosted connection.

stringNo

The ID of the hosted connection.

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

pc-bp1mrgfbtmc9brre7****
IsConfirmedbooleanNo

Specifies whether the hosted connection is accepted by the tenant. Valid values:

  • true
  • false
true
VirtualPhysicalConnectionStatusesarrayNo

The business status of the hosted connection.

stringNo

The status of the hosted connection. Valid values:

  • Confirmed
  • UnConfirmed
  • Deleted

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

Confirmed
VirtualPhysicalConnectionAliUidsarrayNo

The information about the Alibaba Cloud account that owns the hosted connection.

stringNo

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.

253460731706911258
VlanIdsarrayNo

The VLAN ID of the hosted connection.

stringNo

The VLAN ID of the hosted connection.

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

10
MaxResultsintegerNo

The number of entries per page. Valid values: 1 to 100. Default value: 20.

20
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. Valid values:

  • You do not need to specify this parameter for the first request.
  • You must specify the token that is obtained from the previous query as the value of NextToken.
dd20****
RegionIdstringYes

The region ID of the hosted connection.

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

cn-shanghai
Tagsarray<object>No

The tag list.

objectNo
KeystringNo

The key of tag N to add to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string.

It 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
ValuestringNo

The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string.

It 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
ResourceGroupIdstringNo

The ID of the resource group to which the hosted connection belongs.

rg-acfmxazb4p****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

2A55F69E-EE3D-5CBE-8805-734F7D5B46B9
VirtualPhysicalConnectionsarray<object>

The list of hosted connections returned.

object
Typestring

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

VPC
Statusstring

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.
Enabled
CreationTimestring

The time when the Express Connect circuit was created.

2021-06-08T12:20:55
AdLocationstring

The geographical location of the access device.

Yuhang Economic Development Zone XXX Intersection, Yuhang XX Machine Room, E*** Suite.
PortNumberstring

The ID of the port on the access device.

80
Specstring

The bandwidth value of the hosted connection.

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

50M
ChargeTypestring

The billing method of the Express Connect circuit.

If Prepaid is returned, it indicates that the Express Connect circuit is billed on a subscription basis.

Prepaid
Descriptionstring

The description of the Express Connect circuit.

desctest
Bandwidthlong

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

50
EnabledTimestring

The time when the Express Connect circuit is enabled.

2021-10-08T10:44Z
LineOperatorstring

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.
CU
PeerLocationstring

The geographical location of the data center.

XX Number, XX Road, XX Town, XX District, Hangzhou City, Zhejiang Province.
RedundantPhysicalConnectionIdstring

The ID of the redundant Express Connect circuit.

pc-119mfjzm****
Namestring

The name of the Express Connect circuit.

nametest
CircuitCodestring

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

longtel001
EndTimestring

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.

2021-11-08T16:00:00Z
PortTypestring

The port type. 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 km)
  • 10GBase-T: 10,000 Mbit/s copper Ethernet port
  • 10GBase-LR: 10,000 Mbit/s single-mode optical port (10 km)
  • 40GBase-LR: 40,000 Mbit/s single-mode optical port
  • 100GBase-LR: 100,000 Mbit/s single-mode optical port
10GBase-LR
BusinessStatusstring

The status of the Express Connect circuit. Valid values:

  • Normal
  • FinancialLocked
  • SecurityLocked
Normal
LoaStatusstring

The status of the letter of authorization (LOA). Valid values:

  • Applying
  • Accept
  • Available
  • Rejected
  • Completing
  • Complete
  • Deleted
Available
AccessPointIdstring

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

ap-cn-hangzhou-finance-yh-E
PhysicalConnectionIdstring

The ID of the hosted connection.

pc-bp1mrgfbtmc9brre7****
ProductTypestring

The type of the Express Connect circuit. Valid values:

  • VirtualPhysicalConnection: shared Express Connect circuit
  • PhysicalConnection: dedicated Express Connect circuit
VirtualPhysicalConnection
ParentPhysicalConnectionIdstring

The ID of the Express Connect circuit.

pc-bp1ciz7ekd2grn1as****
VirtualPhysicalConnectionStatusstring

The status of the hosted connection. Valid values:

  • Confirmed
  • UnConfirmed
  • Deleted
Confirmed
ParentPhysicalConnectionAliUidstring

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

283117732402483989
OrderModestring

The payer for the shared Express Connect circuit. Valid values:

  • PayByPhysicalConnectionOwner: the owner of the shared Express Connect circuit
  • PayByVirtualPhysicalConnectionOwner: the owner of the hosted connection
PayByPhysicalConnectionOwner
AliUidstring

The Alibaba Cloud account ID of the hosted connection owner.

253460731706911258
VlanIdstring

The VLAN ID of the hosted connection.

10
ExpectSpecstring

The estimated maximum bandwidth of the shared Express Connect circuit. The estimated bandwidth takes effect after you complete the payment.

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

50M
ResourceGroupIdstring

The ID of the resource group to which the hosted connection belongs.

rg-acfm3wmsyuimpma
Tagsarray<object>

The tag list.

object
Keystring

The key of tag N that is added to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string.

It 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
Valuestring

The value of tag N that is added to the resource. You can specify at most 20 tag values. The tag value can be an empty string.

It 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
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. Valid values:

  • If the value of NextToken is not returned, it indicates that no next query is to be sent.
  • If NextToken was returned in the previous query, specify the value to obtain the next set of results.
dd20****
TotalCountinteger

The total number of entries returned.

1
Countinteger

The number of entries returned in this query.

1

Examples

Sample success responses

JSONformat

{
  "RequestId": "2A55F69E-EE3D-5CBE-8805-734F7D5B46B9",
  "VirtualPhysicalConnections": [
    {
      "Type": "VPC",
      "Status": "Enabled",
      "CreationTime": "2021-06-08T12:20:55",
      "AdLocation": "Yuhang Economic Development Zone XXX Intersection, Yuhang XX Machine Room, E*** Suite.",
      "PortNumber": "80",
      "Spec": "50M",
      "ChargeType": "Prepaid",
      "Description": "desctest",
      "Bandwidth": 50,
      "EnabledTime": "2021-10-08T10:44Z",
      "LineOperator": "CU",
      "PeerLocation": "XX Number, XX Road, XX Town, XX District, Hangzhou City, 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": "283117732402483989",
      "OrderMode": "PayByPhysicalConnectionOwner",
      "AliUid": "253460731706911258",
      "VlanId": "10",
      "ExpectSpec": "50M",
      "ResourceGroupId": "rg-acfm3wmsyuimpma",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ],
  "NextToken": "dd20****",
  "TotalCount": 1,
  "Count": 1
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.BandwidthThe param of Bandwidth [%s] is illegal.The specified bandwidth value is invalid.
400ResourceNotFound.PhysicalConnectionIdThe specified PhysicalConnectionId [%s] is not found.PhysicalConnectionId is set to an invalid value.

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

Change history

Change timeSummary of changesOperation
2023-08-08API Description Update. The Error code has changed. The response structure of the API has changedView Change Details
2021-11-17The Error code has changed. The response structure of the API has changedView Change Details
2021-09-27Add OperationView Change Details