DescribePhysicalConnections - API Reference| Alibaba Cloud Documentation Center

Queries Express Connect circuits in a specified region.

Description

By default, the system queries all Express Connect circuits in the specified region. You can also set the Filter.N.Key parameter to query a specified Express Connect circuit. 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 region ID of the Express Connect circuit. 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 pending orders. Valid values: true: yes false (default): no
Action	String	No	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 a token, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
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 resource to which the Express Connect circuit is connected. 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 mainland China Equinix: Equinix Other: other connectivity providers outside mainland China 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 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. Name: the name of the Express Connect circuit. You can specify at most five filter conditions in each request. 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 resource to which the Express Connect circuit is connected. Default value: 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 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.
CreationTime	String	2021-08-24T07:30:58Z	The time when the Express Connect circuit was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.
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 bandwidth limit 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 mainland China Equinix: Equinix Other: other connectivity providers outside mainland China
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 predefined 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: a 100 Mbit/s copper Ethernet port 1000Base-T: a 1,000 Mbit/s copper Ethernet port 1000Base-LX: a single-mode 1,000 Mbit/s optical port that supports a maximum transmission distance of 10 km 10GBase-T: a 10,000 Mbit/s copper Ethernet port 10GBase-LR: a single-mode 10,000 Mbit/s optical port that supports a maximum transmission distance of 10 km
BusinessStatus	String	Normal	The 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 letter of authorization (LOA). Valid values: Applying: The LOA is pending for review. 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.
HasReservationData	String	false	Indicates whether the pending orders are returned. 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. 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 account ID of the Express Connect circuit that is used to create the hosted connection.
VlanId	String	10	The VLAN ID of the shared Express Connect circuit.
OrderMode	String	PayByPhysicalConnectionOwner	Indicates the party that pays for the shared Express Connect circuit. Valid values: PayByPhysicalConnectionOwner: If the value is set to PayByPhysicalConnectionOwner, it indicates that the Express Connect partner pays for the shared Express Connect circuit. PayByVirtualPhysicalConnectionOwner: If the value is set to PayByVirtualPhysicalConnectionOwner, it indicates that the tenant pays for the shared Express Connect circuit.
VpconnStatus	String	Confirmed	The status of the shared Express Connect circuit. Valid values: Confirmed: accepted UnConfirmed: pending for acceptance Deleted: deleted

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&IncludeReservationData=false
&Action=DescribePhysicalConnections
&<Common request parameters>

Sample success responses

XML format

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

<DescribePhysicalConnectionsResponse>
    <PhysicalConnectionSet>
        <PhysicalConnectionType>
            <Status>Enabled</Status>
            <EndTime>2022-04-24T16:00:00Z</EndTime>
            <VirtualPhysicalConnectionCount>0</VirtualPhysicalConnectionCount>
            <LineOperator>CU</LineOperator>
            <PhysicalConnectionId>pc-bp1ciz7ekd2grn1as****</PhysicalConnectionId>
            <HasReservationData>false</HasReservationData>
            <ProductType>PhysicalConnection</ProductType>
            <RedundantPhysicalConnectionId/>
            <BusinessStatus>Normal</BusinessStatus>
            <Name>nametest</Name>
            <Type>VPC</Type>
            <AdLocation>EXX Server Room XX, Yuhang Data Center XX, Yuhang-EconomicDevelopmentZone-XXX</AdLocation>
            <ChargeType>Prepaid</ChargeType>
            <CreationTime>2021-08-24T07:30:58Z</CreationTime>
            <AccessPointId>ap-cn-hangzhou-finance-yh-E</AccessPointId>
            <EnabledTime>2021-08-24T07:33:18Z</EnabledTime>
            <PortNumber>1/1/1</PortNumber>
            <Spec>10G</Spec>
            <PortType>10GBase-LR</PortType>
        </PhysicalConnectionType>
    </PhysicalConnectionSet>
    <TotalCount>1</TotalCount>
    <RequestId>0E6D0EC4-7C91-53E2-9F65-64BF713114B0</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
</DescribePhysicalConnectionsResponse>

JSON format

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

{
  "PhysicalConnectionSet" : {
    "PhysicalConnectionType" : [ {
      "Status" : "Enabled",
      "EndTime" : "2022-04-24T16:00:00Z",
      "VirtualPhysicalConnectionCount" : 0,
      "LineOperator" : "CU",
      "PhysicalConnectionId" : "pc-bp1ciz7ekd2grn1as****",
      "HasReservationData" : false,
      "ProductType" : "PhysicalConnection",
      "RedundantPhysicalConnectionId" : "",
      "BusinessStatus" : "Normal",
      "Name" : "nametest",
      "Type" : "VPC",
      "AdLocation": "EXX Server Room XX, Yuhang Data Center XX, Yuhang-EconomicDevelopmentZone-XXX",
      "ChargeType" : "Prepaid",
      "CreationTime" : "2021-08-24T07:30:58Z",
      "AccessPointId" : "ap-cn-hangzhou-finance-yh-E",
      "EnabledTime" : "2021-08-24T07:33:18Z",
      "PortNumber" : "1/1/1",
      "Spec" : "10G",
      "PortType" : "10GBase-LR"
    } ]
  },
  "TotalCount" : 1,
  "RequestId" : "0E6D0EC4-7C91-53E2-9F65-64BF713114B0",
  "PageSize" : 10,
  "PageNumber" : 1
}

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 the filter condition is invalid.

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