edit-icon download-icon

DescribePhysicalConnections

Last Updated: Apr 09, 2018

Description

Query the created physical connections in the specified region.

The relationship between the values of a filter is “or”. The physical connection is returned as long as one filter is met.

The relationship between each filter is “and”. The physical connection is returned only when all the filters are met.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: DescribePhysicalConnections

RegionId String Yes

The region where the physical connection is located.

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

Filter.n.Key String No

Filter keys. Valid value for n is [1,5], up to five filters are supported. The following are available filter keys:

  • PhysicalConnectionId: The ID of the physical connection.

  • AccessPointId: The ID of the access point.

  • Type: The type of the physical connection, the valid value is VPC.

  • LineOperator: The network operator of the physical connection.

  • Status: The status of the physical connection.

  • Spec: The specification of the physical connection, such as 1 Gbps.

  • Name: The name of the physical connection.

Filter.n.Value.m String No The corresponding value of the specified filter key. The valid value of m is [1, 5].
PageNumber Integer No The number of pages to return. The default value is 1.
PageSize Integer No The number of rows per page. The maximum value is 50 and the default value is 10.

Response parameters

Name Type Description
RequestId String The ID of the request.
PhysicalConnectionSet JSON string

The detailed information of queried physical connections.

For more information, see PhysicalConnectionSetType.

TotalCount Integer The number of queried entries.
PageNumber Integer The current page number.
PageSize Integer The number of entries on the current page.

Error codes

See VPC API Error Center.

Examples

Request example

  1. http://vpc.aliyuncs.com/?Action=DescribePhysicalConnections
  2. &RegionId=cn-beijing
  3. &<CommonParameters>

Response example

JSON format

  1. {
  2. "PageNumber": 1,
  3. "TotalCount": 1,
  4. "PageSize": 10,
  5. "RequestId": "7C07B0AF-4FC0-4BB2-9667-F75812824BCD",
  6. "PhysicalConnectionSet": {
  7. "PhysicalConnectionType": [
  8. {
  9. "Type": "VPC",
  10. "PhysicalConnectionId": "pc-2zeoaxkq3jot5p71qcnuy",
  11. "PeerLocation": "XXX Street-XX District-Beijing City",
  12. "CreationTime": "2017-12-13T02:28:42Z",
  13. "Name": "TEST",
  14. "Status": "Enabled",
  15. "AdLocation": "XXU in XX network cabinet in XXX data center--XX--Beijing City",
  16. "EnabledTime": "2017-12-18T04:01:30Z",
  17. "BusinessStatus": "Normal",
  18. "LineOperator": "CT",
  19. "PortNumber": "1/1/4",
  20. "AccessPointId": "ap-cn-beijing-dx-A",
  21. "PortType": "100Base-T",
  22. "Bandwidth": 2
  23. }
  24. ]
  25. }
  26. }
Thank you! We've received your feedback.