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 region of the physical connection. 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:
The relationship of multiple filter condition values is OR, which means that the corresponding physical connection is returned when any one of the specified values is matched. 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. 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:
|
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 connections |
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 subscription messages are received. |
LineOperator | String | CT |
The service provider of the leased line. Valid values:
|
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:
|
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 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:
|
Type | String | VPC |
The type of the physical connection. Default value: VPC |
TotalCount | Integer | 10 |
The number of queried physical connections. |
PageNumber | Integer | 10 |
The current page number. |
PageSize | Integer | 10 |
The number of physical connections 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-XXBuidling--XXXCity</PeerLocation>
<CreationTime>2017-12-13T02:28:42Z</CreationTime>
<Name>TEST</Name>
<Status>Enabled</Status>
<AdLocation>XXX--CabinetXX-XXXXXRoomXXU</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-XXBuilding--XXXCity",
"CreationTime":"2017-12-13T02:28:42Z",
"Name":"TEST",
"Status":"Enabled",
"AdLocation":"XXX--XX-CabinetXXURoomXXXXX",
"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
HTTP status code | Error code | Error message | Description |
---|---|---|---|
404 | InvalidFilterKey.ValueNotSupported | Specified filter key is not supported: Filter.X.key | The filter key is not supported. |