Queries physical connections in a specified region.

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
Action String  Yes DescribePhysicalConnections

The name of this action.

Value: DescribePhysicalConnections

RegionId String  Yes cn-hangzhou

The ID of the region to which the physical connection belongs.

To query the region ID, call DescribeRegions.

ClientToken String  No 23243242rggyt

Optional. The client token. It is used to guarantee the idempotence of the request. The value of this parameter is generated by the client and is unique among different requests. It can contain up to 64 ASCII characters.

Filter.N.Key String  No 1

Optional. The filter condition. Value range of N: 1 to 5. Supported filter conditions include:

  • PhysicalConnectionId: the ID of the physical connection
  • AccessPointId: the ID of the access point
  • Type: the leased line type
  • LineOperator: the service provider of the physical connection
  • Spec: the specification of the physical connection
  • Status: the status of the physical connection
  • Name: the name of the physical connection

The relationship of multiple filter condition values is OR, which means that a physical connection is returned in the query result when it meets any of the specified values. The relationship of multiple filter conditions is AND, which means a physical connection is returned in the query result only when it meets all the specified conditions.

Filter.N.Value.N RepeatList No 1

Optional. The value of the corresponding filter condition. Value range of N: 1 to 5

IncludeReservationData Boolean No false

Optional. Indicates whether to return invalid orders.

PageNumber Integer No 10

Optional. The page number. Default value: 1

PageSize Integer No 1

Optional. The number of rows per page for a paged query. Maximum value: 50. Default value: 10

Response parameters

Parameter Type Example value Description
PhysicalConnectionSet

The list of physical connections.

AccessPointId String  eip-2zeerraiwb7uj6i0d0fo3

The ID of the physical connection access point.

AdLocation String  Room Ax-x, Building B, No. x of xxx Avenue, New York, US

The location of the physical connection device.

Bandwidth Long 10

The bandwidth of the physical connection.

BusinessStatus String  Normal

The payment status of the physical connection. Valid values:

  • Normal: Indicates that the payment is normal.
  • FinancialLocked: Indicates that the physical connection is locked due to overdue payments.
  • SecurityLocked: Indicates that the physical connection is locked due to security reasons.
ChargeType String  Prepaid

The billing method of the physical connection

CircuitCode String  longtel001

The leased line code provided by the service provider for the physical connection.

CreationTime String  2017-06-08T12:20:55

The time when the physical connection is established.

Description String  Physical connection

The description of the physical connection.

EnabledTime String  2017-06-08T12:20:55

The time when the physical connection is enabled.

EndTime String  2019-02-25T11:01:04Z

The time when the physical connection expires.

HasReservationData String  true

Indicates whether any renewal is made.

LineOperator String  CT

The service provider of the leased line. Valid values:

  • CT: China Telecom
  • CU: China Unicom
  • CM: China Mobile
  • CO: Other Chinese service providers
  • Equinix: Equinix
  • Other: Other service providers outside Mainland China
LoaStatus String  Available

The status of the LOA.

Name String  name

The name of the physical connection.

PeerLocation String  Zhejiang --- vfjdbg_21e

The location of the on-premises data center.

PhysicalConnectionId String  pc-119mfjzm7

The ID of the physical connection.

PortNumber String  80

The port number of the physical connection device.

PortType String  1000Base-T

The port type of the physical connection:

  • 100Base-T: 100M electrical ports
  • 1000Base-T (default value): 1 Gigabit electrical ports
  • 1000Base-LX: 1 Gigabit single-mode optical ports (10 km)
  • 10GBase-T: 10-GE electrical ports
  • 10GBase-LR: 10-GE single-mode optical ports (10 km)
RedundantPhysicalConnectionId String  pc-119mfjzm7

The ID of the redundant physical connection.

ReservationActiveTime String  2019-02-25T11:01:04Z

The time when the renewal takes effect.

ReservationInternetChargeType String  PayByBandwidth

The billing method of the physical connection after the renewal.

ReservationOrderType String  RENEW

The type of the renewal order.

Spec String  Large

The specification of the physical connection.

Spec String  Large

The specification of the physical connection.

Status String  Initial

The status of the physical connection. Valid values:

  • Initial: Indicates that the physical connection application is being reviewed.
  • Approved: Indicates that the physical connection application is approved.
  • Allocating: Indicates that resources are being allocated.
  • Allocated: Indicates that cables are being installed at the data center.
  • Confirmed: Indicates that the physical connection is waiting for user confirmation.
  • Enabled: Indicates that the physical connection is enabled.
  • Rejected: Indicates that the physical connection application is rejected.
  • Canceled: Indicates that the physical connection is canceled.
  • Allocation Failed: Indicates that the resource allocation fails.
  • Terminated: Indicates that the physical connection is terminated.
Type String  VPC

The type of the physical connection. Default value: VPC

TotalCount Integer 10

The total number of queried VBRs.

PageNumber Integer 10

The current page number.

PageSize Integer 10

The number of VBRs per page.

RequestId String  EEC8EAB1-F299-4F5C-8E54-0A3129164C27

The request ID.

Examples

Request example


https://vpc.aliyuncs.com/?Action=DescribePhysicalConnections
&RegionId=cn-hangzhou
&<CommonParameters>

Response examples

XML format

<DescribePhysicalConnectionsResponse>
	  <PageNumber>1</PageNumber>
	  <TotalCount>1</TotalCount>
	  <PageSize>10</PageSize>
	  <RequestId>7C07B0AF-4FC0-4BB2-9667-F75812824BCD</RequestId>
	  <PhysicalConnectionSet>
		    <PhysicalConnectionType>
			      <Type>VPC</Type>
			      <PhysicalConnectionId>pc-2zeoaxkq3jot5p71qcnuy</PhysicalConnectionId>
			      <PeerLocation>XXX-XX Building-XX City</PeerLocation>
			      <CreationTime>2017-12-13T02:28:42Z</CreationTime>
			      <Name>TEST</Name>
			      <Status>Enabled</Status>
			      <AdLocation>Cabinet XXU-Room XX-XX-XXX</AdLocation>
			      <EnabledTime>2017-12-18T04:01:30Z</EnabledTime>
			      <BusinessStatus>Normal</BusinessStatus>
			      <LineOperator>CT</LineOperator>
			      <PortNumber>1/1/4</PortNumber>
			      <AccessPointId>ap-cn-beijing-dx-A</AccessPointId>
			      <PortType>100Base-T</PortType>
			      <Bandwidth>2</Bandwidth>
		    </PhysicalConnectionType>
	  </PhysicalConnectionSet>	
</DescribePhysicalConnectionsResponse>

JSON format

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":10,
	"RequestId":"7C07B0AF-4FC0-4BB2-9667-F75812824BCD",
	"PhysicalConnectionSet":{
		"PhysicalConnectionType":[
			{
				"Type":"VPC",
				"PhysicalConnectionId":"pc-2zeoaxkq3jot5p71qcnuy",
				"PeerLocation":"XXX-XX Building-XX City",
				"CreationTime":"2017-12-13T02:28:42Z",
				"Name":"TEST",
				"Status":"Enabled",
				"AdLocation":"Cabinet XXU-Room XXX-XX-XXX",
				"EnabledTime":"2017-12-18T04:01:30Z",
				"BusinessStatus":"Normal",
				"LineOperator":"CT",
				"PortNumber":"1/1/4",
				"AccessPointId":"ap-cn-beijing-dx-A",
				"PortType":"100Base-T",
				"Bandwidth":2
			}
		]
	}
}

Errors

HTTP status code Error code Error message Description
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key The specified filter key is not supported.

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