Query physical connections in a region.

Debug

Perform a debug in OpenAPI Explorer. We recommend that you use OpenAPI Explorer. By using OpenAPI Explorer, you can call APIs, generate SDK code examples automatically, and search APIs, allowing you to quickly and easily get started with using APIs on the cloud.

Request parameters

Parameter Type Required? Example value Description
Action String Yes DescribePhysicalConnections

The action to perform.

Valid value: DescribePhysicalConnections

RegionId String Yes cn-hangzhou

The ID of the region where the leased line is deployed.

You can obtain the region ID by calling the DescribeRegions API.

ClientToken String No 23243242rggyt

Optional. It is used to guarantee the idempotence of requests. This parameter is generated by clients. It must be unique for each request and must not exceed 64 ASCII characters in length.

Filter.N.Key String No 1

Optional. The filter conditions. 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 type of the physical connection
  • LineOperator: the service provider of the leased line
  • 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 this filter condtion is met when at least one of the specififed value is returned. The relationship of multiple filter conditions is AND, which means a physical connection is displayed in the query result only when it meets all the specified conditions.

Filter.N.Value.N RepeatList No 1

Optional. Values of filter conditions. 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 of the physical connection list. Default value: 1.

PageSize Integer No 1

Optional. The number of rows per page. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example value Description
PhysicalConnectionSet

Details of physical connections

  └AccessPointId String eip-2zeerraiwb7uj6i0d0fo3

The access point ID of the physical connection

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

The location where the leased line is connected

  └Bandwidth Long 10

The bandwidth of the physical connection

  └BusinessStatus String Normal

The payment status of the physical connection. Valid values:

  • Normal
  • FinancialLocked: locked due to overdue payment
  • SecurityLocked: locked due to security reasons
  └ChargeType String Prepaid

The billing method of the physical connection

  └CircuitCode String longtel001

The number of the leased line from the service provider

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

The time when the physical connection is established

  └Description String Physical connection

A description about 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 subscription messages are received

  └LineOperator String CT

The service provider that provides 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 IDC

  └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 type of physical connection ports:

  • 100Base-T: 100M electrical ports
  • 1000Base-T (default value): Gigabit electrical ports
  • 1000Base-LX: 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 effective time of a renewal

  └ReservationInternetChargeType String PayByBandwidth

The type of renewal

  └ReservationOrderType String RENEW

The type of the renewal order

  └Spec String Large

The specification of the physical connection

  └Status String Initial

The status of the physical connection. Valid values:

  • Initial: The physical connection has been applied for and is under review by Alibaba Cloud.
  • Approved: The application is approved.
  • Allocating: Resources are being allocated.
  • Allocated: The leased line is being installed.
  • Confirmed: The completed leased line installation needs to be confirmed by the customer.
  • Enabled: The physical connection interface is enabled.
  • Rejected: The application is rejected.
  • Canceled: The application is canceled.
  • Allocation Failed: Failed to allocate resources.
  • Terminated: The physical connection is terminated.
  └Type String VPC

The type of the physical connection. Default value: VPC.

TotalCount Integer 10

The number of items in a list

PageNumber Integer 10

The current page number

PageSize Integer 10

The number of items per page

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

The ID of the request

Example

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 Road--XXX District</PeerLocation>
      <CreationTime>2017-12-13T02:28:42Z</CreationTime>
      <Name>TEST</Name>
      <Status>Enabled</Status>
      <AdLocation>CabinetXXUDataCenterXXX--XXX--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":"XXXRoad-XXDistrict--XXX",
				"CreationTime":"2017-12-13T02:28:42Z",
				"Name":"TEST",
				"Status":"Enabled",
				"AdLocation":"CabinetXXUDataCenterXX--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
			}
		]
	}
}

Error codes

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

Click here to view the error codes.