Queries Express Connect circuits in a region.

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 DescribePhysicalConnections

The operation that you want to perform.

Set the value to DescribePhysicalConnections .

RegionId String Yes cn-hangzhou

The ID of the region where the Express Connect circuit is deployed.

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

PageNumber Integer No 10

The number of the page to return. Default value: 1.

PageSize Integer No 1

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Filter.N.Key String No 1

The filter condition. Valid values of N are 1 to 5. The following filter conditions are supported:

  • PhysicalConnectionId: the ID of the Express Connect circuit
  • AccessPointId: the ID of the access point
  • Type: the type of the Express Connect circuit
  • LineOperator: the Internet service provider (ISP) of the Express Connect circuit.
  • Spec: the specification of the Express Connect circuit
  • Status: the status of the Express Connect circuit
  • Name: the name of the Express Connect circuit

The logical operator between values in a filter condition is OR, which means that the filter condition is met if one of the values is met.

The logical operator between filter conditions is AND. In this case, the result is returned only when all conditions are met.

Filter.N.Value.N RepeatList No 1

The value of the filter condition. Valid values of N are 1 to 5.

IncludeReservationData Boolean No false

Specifies whether to return the orders that have not taken effect.

  • true: yes
  • false: no
ClientToken String No 23243242rggy****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Response parameters

Parameter Type Example Description
PhysicalConnectionSet Array of PhysicalConnectionType

The description of the Express Connect circuit.

PhysicalConnectionType
AccessPointId String eip-2zeerraiwb7uj6i0*******

The ID of the access point.

AdLocation String Room Ax-x Bxx, building xx, xxx Avenue, Nanshan District, Shenzhen, Guangdong

The geographical location of the access device.

Bandwidth Long 10

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

BusinessStatus String Normal

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

  • Normal: enabled
  • FinancialLocked: locked due to overdue payments
  • SecurityLocked: locked for security reasons
ChargeType String Prepaid

The billing method.

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

CircuitCode String longtel001

The circuit code provided by the ISP for the Express Connect circuit.

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

The time when the Express Connect circuit was created.

Description String The Express Connect circuit

The description of the Express Connect circuit.

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

The time when the Express Connect circuit was created.

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

The time when the Express Connect circuit expires.

HasReservationData String true

Indicates whether you have subscription messages.

  • true: yes
  • false: no
LineOperator String CT

The ISP of the Express Connect circuit. Valid values:

  • CT: China Telecom
  • CU: China Unicom
  • CM: China Mobile
  • CO: other ISPs in China
  • Equinix: Equinix
  • Other: other ISPs outside China
LoaStatus String Available

The status of the letter of authorization (LOA).

  • 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.
Name String name

The name of the Express Connect circuit.

PeerLocation String Building XX, XX Avenue, XX District, Hangzhou, Zhejiang

The geographical location of the data center.

PhysicalConnectionId String pc-119mfjzm*****

The ID of the Express Connect circuit.

PortNumber String 80

The port number of the access device.

PortType String 1000Base-T

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

  • 100Base-T: a copper port that supports 100 Mbit/s
  • 1000Base-T: a copper port that supports 1,000 Mbit/s
  • 1000Base-LX: a single-mode optical port that supports 1,000 Mbit/s (10 kilometers of communication distance)
  • 10GBase-T: a copper port that supports 10 Gbit/s
  • 10GBase-LR: a single-mode optical port that supports 10 Gbit/s (10 kilometers of communication distance)
RedundantPhysicalConnectionId String pc-119mfjzm*******

The ID of the redundant Express Connect circuit.

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

The time when the renewal takes effect.

ReservationInternetChargeType String PayByBandwidth

The renewal type.

ReservationOrderType String RENEW

The type of the renewal order.

Spec String Large

The specification of the Express Connect circuit.

Status String Enabled

The status of the Express Connect circuit. Valid values:

  • Initial: pending approval
  • Approved: approved
  • Allocating: allocating resources
  • Allocated: under construction
  • Confirmed: waiting for user confirmation
  • Enabled: enabled
  • Rejected: rejected
  • Canceled: canceled
  • Allocation Failed: resource allocation failed
  • Terminated: disabled
Type String VPC

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

TotalCount Integer 10

The total number of entries returned.

PageNumber Integer 10

The number of the page returned. Default value: 1.

PageSize Integer 10

The number of entries returned on each page. Maximum value: 50. Default value: 10.

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribePhysicalConnections
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format 

<DescribePhysicalConnectionsResponse>
      <PhysicalConnectionSet>
            <PhysicalConnectionType>
                  <Status>Enabled</Status>
                  <Description>Express Connect circuit</Description>
                  <EndTime>2019-02-25T11:01:04Z</EndTime>
                  <LineOperator>CT</LineOperator>
                  <CircuitCode>longtel001</CircuitCode>
                  <PhysicalConnectionId>pc-119mfjzm*****</PhysicalConnectionId>
                  <HasReservationData>true</HasReservationData>
                  <RedundantPhysicalConnectionId>pc-119mfjzm*******</RedundantPhysicalConnectionId>
                  <PeerLocation>Building XX, XX Avenue, XX District, Hangzhou, Zhejiang</PeerLocation>
                  <BusinessStatus>Normal</BusinessStatus>
                  <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
                  <Name>name</Name>
                  <ReservationOrderType>RENEW</ReservationOrderType>
                  <LoaStatus>Available</LoaStatus>
                  <Type>VPC</Type>
                  <AdLocation>Room Ax-x Bxx, building xx, xxx Avenue, Nanshan District, Shenzhen, Guangdong</AdLocation>
                  <ChargeType>Prepaid</ChargeType>
                  <Bandwidth>10</Bandwidth>
                  <CreationTime>2017-06-08T12:20:55</CreationTime>
                  <AccessPointId>eip-2zeerraiwb7uj6i0*******</AccessPointId>
                  <EnabledTime>2017-06-08T12:20:55</EnabledTime>
                  <ReservationActiveTime>2019-02-25T11:01:04Z</ReservationActiveTime>
                  <PortNumber>80</PortNumber>
                  <Spec>Large</Spec>
                  <PortType>1000Base-T</PortType>
            </PhysicalConnectionType>
      </PhysicalConnectionSet>
      <TotalCount>10</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>EEC8EAB1-F299-4F5C-8E54-0A3129164C27</RequestId>
      <PageNumber>10</PageNumber>
</DescribePhysicalConnectionsResponse>

JSON format 

{
    "PhysicalConnectionSet": {
        "PhysicalConnectionType": {
            "Status": "Enabled",
            "Description": "Express Connect circuit",
            "EndTime": "2019-02-25T11:01:04Z",
            "LineOperator": "CT",
            "CircuitCode": "longtel001",
            "PhysicalConnectionId": "pc-119mfjzm*****",
            "HasReservationData": true,
            "RedundantPhysicalConnectionId": "pc-119mfjzm*******",
            "PeerLocation": "Building XX, XX Avenue, XX District, Hangzhou, Zhejiang",
            "BusinessStatus": "Normal",
            "ReservationInternetChargeType": "PayByBandwidth",
            "Name": "name",
            "ReservationOrderType": "RENEW",
            "LoaStatus": "Available",
            "Type": "VPC",
            "AdLocation": "Room Ax-x Bxx, building xx, xxx Avenue, Nanshan District, Shenzhen, Guangdong",
            "ChargeType": "Prepaid",
            "Bandwidth": 10,
            "CreationTime": "2017-06-08T12:20:55",
            "AccessPointId": "eip-2zeerraiwb7uj6i0*******",
            "EnabledTime": "2017-06-08T12:20:55",
            "ReservationActiveTime": "2019-02-25T11:01:04Z",
            "PortNumber": 80,
            "Spec": "Large",
            "PortType": "1000Base-T"
        }
    },
    "TotalCount": 10,
    "PageSize": 10,
    "RequestId": "EEC8EAB1-F299-4F5C-8E54-0A3129164C27",
    "PageNumber": 10
}

Error codes

HttpCode Error code Error message Description
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key The error message returned because Filter.X.key is not supported.

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