DescribePhysicalConnections - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries physical connections.

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribePhysicalConnections for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribePhysicalConnections

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes
PageNumber	integer	No
PageSize	integer	No
ClientToken	string	No
UserCidr	string	No
Filter	array<object>	No
	object	No
Key	string	No
Value	array	No
	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string
PageNumber	integer
PageSize	integer
TotalCount	integer
PhysicalConnectionSet	object
PhysicalConnectionType	array<object>
	object
AdLocation	string
CreationTime	string
Status	string
Type	string
PortNumber	string
CircuitCode	string
Spec	string
Bandwidth	integer
Description	string
PortType	string
EnabledTime	string
BusinessStatus	string
LineOperator	string
Name	string
RedundantPhysicalConnectionId	string
PeerLocation	string
AccessPointId	string
PhysicalConnectionId	string

Examples

Success response

JSON format

{
  "RequestId": "",
  "PageNumber": 0,
  "PageSize": 0,
  "TotalCount": 0,
  "PhysicalConnectionSet": {
    "PhysicalConnectionType": [
      {
        "AdLocation": "",
        "CreationTime": "",
        "Status": "",
        "Type": "",
        "PortNumber": "",
        "CircuitCode": "",
        "Spec": "",
        "Bandwidth": 0,
        "Description": "",
        "PortType": "",
        "EnabledTime": "",
        "BusinessStatus": "",
        "LineOperator": "",
        "Name": "",
        "RedundantPhysicalConnectionId": "",
        "PeerLocation": "",
        "AccessPointId": "",
        "PhysicalConnectionId": ""
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.