Queries Express Connect circuits in a specified region.

Usage notes

By default, the system queries information about all Express Connect circuits in the specified region. You can query Express Connect circuits that meet specific conditions by specifying filter conditions provided by the DescribePhysicalConnections operation. For more information about the supported filter conditions, see Key in the Request parameters section.

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
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 1

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

PageSize Integer No 10

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

IncludeReservationData Boolean No false

Specifies whether to return the data about pending orders. Valid values:

  • true: yes
  • false (default): no
Action String Yes DescribePhysicalConnections

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

ClientToken String No 02fb3da4-130e-11e9-8e44-001

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.

Filter.N.Key String No Name

The filter condition. Valid values:

  • PhysicalConnectionId: the ID of the Express Connect circuit
  • AccessPointId: the ID of the access point
  • Type: the type of the Express Connect circuit. You can set Type only to VPC.
  • LineOperator: 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
  • Spec: the specification of the Express Connect circuit. Valid values:
    • 1G and below
    • 10G
    • 40G
    • 100G
      Note By default, you cannot set Spec to 40G or 100G. To query 40 Gbit/s or 100 Gbit/s Express Connect circuits, you must first submit an application to acquire the permissions.
  • Status: 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 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.
  • Name: the name of the Express Connect circuit

You can specify at most five filter conditions in each call. The logical relation among the filter conditions is AND. Therefore, an Express Connect circuit is returned only when all specified filter conditions are matched.

Filter.N.Value.N String No nametest

The value of the filter condition.

You can specify at most five values for a filter condition. The logical relation among the values of each filter condition is OR. Therefore, an Express Connect circuit is returned when one of the specified values is matched.

Response parameters

Parameter Type Example Description
RequestId String 0E6D0EC4-7C91-53E2-9F65-64BF713114B0

The ID of the request.

PageNumber Integer 1

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

PageSize Integer 10

The number of entries returned per page. Default value: 10. Valid values: 1 to 50.

TotalCount Integer 1

The number of entries returned.

PhysicalConnectionSet Array of PhysicalConnectionType

The list of Express Connect circuits.

PhysicalConnectionType
Type String VPC

The type of the Express Connect circuit. The value is fixed as 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 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 2021-08-24T07:30:58Z

The time when the Express Connect circuit was created.

AdLocation String EXX Server Room XX, Yuhang Data Center XX, Yuhang-EconomicDevelopmentZone-XXX

The geographical location of the access device.

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

The time when the pending order takes effect.

ReservationOrderType String RENEW

The type of the pending order.

If the value is set to RENEW, it indicates that the order is placed for service renewal.

PortNumber String 1/1/1

The ID of the port on the access device.

Spec String 10G

The specification of the Express Connect circuit.

Unit: G (Gbit/s).

ChargeType String Prepaid

The billing method of the Express Connect circuit.

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

ReservationInternetChargeType String PayByBandwidth

The billing method of the pending order.

If the value is set to PayByBandwidth, it indicates that the Express Connect circuit is billed on a pay-by-bandwidth basis.

Description String desctest

The description of the Express Connect circuit.

Bandwidth Long 10

The maximum bandwidth of the Express Connect circuit.

Unit: Gbit/s.

EnabledTime String 2021-08-24T07:33:18Z

The time when the Express Connect circuit is enabled.

LineOperator String CT

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 provided by the connectivity provider.

EndTime String 2022-04-24T16:00:00Z

The time when the Express Connect circuit expires.

PortType String 10GBase-LR

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 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 LOA. Valid values:

  • Applying: The LOA is pending 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.

AccessPointType String VPC

The type of the access point.

HasReservationData String false

Indicates whether the data about pending orders is returned. Valid values:

  • true: yes
  • false: no
PhysicalConnectionId String pc-bp1ciz7ekd2grn1as****

The ID of the Express Connect circuit.

ProductType String PhysicalConnection

The type of the Express Connect circuit. Valid values:

  • VirtualPhysicalConnection: a shared Express Connect circuit
  • PhysicalConnection: a dedicated Express Connect circuit
VirtualPhysicalConnectionCount Integer 0

The number of hosted connections that are established over the Express Connect circuit.

ParentPhysicalConnectionId String pc-bp1ciz7ekd2grn1as****

The ID of the Express Connect circuit that is used to create the hosted connection.

ParentPhysicalConnectionAliUid Long 283117732402483989

The Alibaba Cloud account ID of the Express Connect circuit that is used to create the hosted connection.

VlanId String 10

The VLAN ID of the hosted connection.

OrderMode String PayByPhysicalConnectionOwner

The payer for the hosted connection. Valid values:

  • PayByPhysicalConnectionOwner: The partner pays for the hosted connection.
  • PayByVirtualPhysicalConnectionOwner: The tenant pays for the hosted connection.
VpconnStatus String Confirmed

The service status of the hosted connection. Valid values:

  • Confirmed: accepted
  • UnConfirmed: pending acceptance
  • Deleted: deleted
ExpectSpec String 50M

The estimated bandwidth value of the hosted connection. The estimated bandwidth takes effect after you complete the payment.

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

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&IncludeReservationData=false
&Action=DescribePhysicalConnections
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&Filter=[{"Key":"Name","Value":["nametest"]}]
&Common request parameters

Sample success responses

XML format

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

<DescribePhysicalConnectionsResponse>
    <RequestId>0E6D0EC4-7C91-53E2-9F65-64BF713114B0</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>1</TotalCount>
    <PhysicalConnectionSet>
        <Type>VPC</Type>
        <Status>Enabled</Status>
        <CreationTime>2021-08-24T07:30:58Z</CreationTime>
        <AdLocation>EXX Server Room XX, Yuhang Data Center XX, Yuhang-EconomicDevelopmentZone-XXX</AdLocation>
        <ReservationActiveTime>2022-02-25T11:01:04Z</ReservationActiveTime>
        <ReservationOrderType>RENEW</ReservationOrderType>
        <PortNumber>1/1/1</PortNumber>
        <Spec>10G</Spec>
        <ChargeType>Prepaid</ChargeType>
        <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
        <Description>desctest</Description>
        <Bandwidth>10</Bandwidth>
        <EnabledTime>2021-08-24T07:33:18Z</EnabledTime>
        <LineOperator>CT</LineOperator>
        <PeerLocation>Building XX, XX Avenue, XX District, Hangzhou, Zhejiang</PeerLocation>
        <RedundantPhysicalConnectionId>pc-119mfjzm****</RedundantPhysicalConnectionId>
        <Name>nametest</Name>
        <CircuitCode>longtel001</CircuitCode>
        <EndTime>2022-04-24T16:00:00Z</EndTime>
        <PortType>10GBase-LR</PortType>
        <BusinessStatus>Normal</BusinessStatus>
        <LoaStatus>Available</LoaStatus>
        <AccessPointId>ap-cn-hangzhou-finance-yh-E</AccessPointId>
        <AccessPointType>VPC</AccessPointType>
        <HasReservationData>false</HasReservationData>
        <PhysicalConnectionId>pc-bp1ciz7ekd2grn1as****</PhysicalConnectionId>
        <ProductType>PhysicalConnection</ProductType>
        <VirtualPhysicalConnectionCount>0</VirtualPhysicalConnectionCount>
        <ParentPhysicalConnectionId>pc-bp1ciz7ekd2grn1as****</ParentPhysicalConnectionId>
        <ParentPhysicalConnectionAliUid>283117732402484000</ParentPhysicalConnectionAliUid>
        <VlanId>10</VlanId>
        <OrderMode>PayByPhysicalConnectionOwner</OrderMode>
        <VpconnStatus>Confirmed</VpconnStatus>
        <ExpectSpec>50M</ExpectSpec>
    </PhysicalConnectionSet>
</DescribePhysicalConnectionsResponse>

JSON format

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

{
  "RequestId" : "0E6D0EC4-7C91-53E2-9F65-64BF713114B0",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 1,
  "PhysicalConnectionSet" : [ {
    "Type" : "VPC",
    "Status" : "Enabled",
    "CreationTime" : "2021-08-24T07:30:58Z",
    "AdLocation": "EXX Server Room XX, Yuhang Data Center XX, Yuhang-EconomicDevelopmentZone-XXX",
    "ReservationActiveTime" : "2022-02-25T11:01:04Z",
    "ReservationOrderType" : "RENEW",
    "PortNumber" : "1/1/1",
    "Spec" : "10G",
    "ChargeType" : "Prepaid",
    "ReservationInternetChargeType" : "PayByBandwidth",
    "Description" : "desctest",
    "Bandwidth" : 10,
    "EnabledTime" : "2021-08-24T07:33:18Z",
    "LineOperator" : "CT",
    "PeerLocation" : "Building XX, XX Avenue, XX District, Hangzhou, Zhejiang",
    "RedundantPhysicalConnectionId" : "pc-119mfjzm****",
    "Name" : "nametest",
    "CircuitCode" : "longtel001",
    "EndTime" : "2022-04-24T16:00:00Z",
    "PortType" : "10GBase-LR",
    "BusinessStatus" : "Normal",
    "LoaStatus" : "Available",
    "AccessPointId" : "ap-cn-hangzhou-finance-yh-E",
    "AccessPointType" : "VPC",
    "HasReservationData" : "false",
    "PhysicalConnectionId" : "pc-bp1ciz7ekd2grn1as****",
    "ProductType" : "PhysicalConnection",
    "VirtualPhysicalConnectionCount" : 0,
    "ParentPhysicalConnectionId" : "pc-bp1ciz7ekd2grn1as****",
    "ParentPhysicalConnectionAliUid" : 283117732402484000,
    "VlanId" : "10",
    "OrderMode" : "PayByPhysicalConnectionOwner",
    "VpconnStatus" : "Confirmed",
    "ExpectSpec" : "50M"
  } ]
}

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.