DescribePhysicalConnections-阿里云帮助中心

Queries information about Express Connect circuits in a specified region.

Operation description

By default, the system queries information about all Express Connect circuits in the specified region. You can use the filter options provided by the DescribePhysicalConnections operation to query information about specific Express Connect circuits. For the supported filter options, see the description of Key in the request parameters section of this topic.

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

list

*PhysicalConnection

acs:vpc:{#regionId}:{#accountId}:physicalconnection/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Express Connect circuit. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paged query. Default value: 10. Valid values: 1 to 50.	10
IncludeReservationData	boolean	No	Specifies whether to return data of orders that have not taken effect. Valid values: true: Returns data of orders that have not taken effect. false (default): Does not return data of orders that have not taken effect.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters.	02fb3da4-130e-11e9-8e44-001
Filter	array<object>	No	The list of filter conditions.
	object	No	The filter condition.
Key	string	No	The filter condition. Valid values: PhysicalConnectionId: the Express Connect circuit ID. AccessPointId: the access point ID. Type: the Express Connect circuit type. This filter condition supports only the value VPC. LineOperator: the carrier of the Express Connect circuit. This filter condition supports the following values: CT: China Telecom. CU: China Unicom. CM: China Mobile. CO: other carriers in China. Equinix: Equinix. Other: other carriers outside China. Spec: the specification of the Express Connect circuit. This filter condition supports the following values: 1G and below. 10G. 40G. 100G. Note The 40G and 100G specifications are not available by default. Only users who have committed an application to their account manager and received approval can use these values. Status: the status of the Express Connect circuit. This filter condition supports the following values: Initial: pending application. Approved: approved. Allocating: allocating resources. Allocated: under construction. Confirmed: pending user confirmation. Enabled: enabled. Rejected: application denied. Canceled: canceled. Allocation Failed: resource allocation failed. Terminating: stopping. Terminated: stopped. Name: the name of the Express Connect circuit. ProductType: the circuit type. Valid values: VirtualPhysicalConnection: shared Express Connect circuit. PhysicalConnection: dedicated Express Connect circuit. You can specify up to 5 filter conditions at a time. The filter conditions have an AND relationship. Results are returned only when all filter conditions are met.	Name
Value	array	No	The list of filter values.	1
	string	No	The filter value that corresponds to the filter condition. Each filter condition supports up to 5 filter values. Multiple filter values have an OR relationship. A record is considered to match the filter condition if it matches any of the filter values.	nametest
Tags	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	FinanceJoshua
ResourceGroupId	string	No	The ID of the resource group to which the Express Connect circuit belongs.	rg-aek2yvwibxr****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0E6D0EC4-7C91-53E2-9F65-64BF713114B0
PageNumber	integer	The page number of the list. Default value: 1.	1
PageSize	integer	The number of entries per page in a paged query. Default value: 10. Valid values: 1 to 50.	10
TotalCount	integer	The total number of entries returned.	1
PhysicalConnectionSet	object
PhysicalConnectionType	array<object>	The list of Express Connect circuits.
	array<object>	The details of the Express Connect circuit.
Type	string	The type of resource to which the Express Connect circuit is connected. Only VPC may be returned.	VPC
Status	string	The status of the Express Connect circuit. Valid values: Initial Approved Allocating Allocated Confirmed Enabled Rejected Canceled Allocation Failed Terminating Terminated	Enabled
CreationTime	string	The time when the Express Connect circuit was created.	2021-08-24T07:30:58Z
AdLocation	string	The location of the access point.	浙江省杭州市XX区XX镇XX路10号
ReservationActiveTime	string	The time when the pending order takes effect.	2022-02-25T11:01:04Z
ReservationOrderType	string	The type of the pending order. If the value is RENEW, it indicates that the order is placed for service renewal.	RENEW
PortNumber	string	The ID of the port on the access device.	1/1/1
Spec	string	The specification of the Express Connect circuit. Unit: G (Gbit/s).	10G
ChargeType	string	The billing method of the Express Connect circuit. If Prepaid is returned, it indicates that the Express Connect circuit is billed on a subscription basis.	Prepaid
ReservationInternetChargeType	string	The billing method of the pending order. If PayByBandwidth is returned, it indicates that the Express Connect circuit is billed on a pay-by-bandwidth basis.	PayByBandwidth
Description	string	The description of the Express Connect circuit.	desctest
Bandwidth	integer	The maximum bandwidth of the Express Connect circuit. Unit: Mbit/s.	10
EnabledTime	string	The time when the Express Connect circuit was enabled.	2021-08-24T07:33:18Z
LineOperator	string	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.	CT
PeerLocation	string	The geographical location of the data center.	浙江省杭州市XX区XX镇XX路XX号
RedundantPhysicalConnectionId	string	The ID of the standby Express Connect circuit.	pc-119mfjzm****
Name	string	The name of the Express Connect circuit.	nametest
CircuitCode	string	The circuit code of the Express Connect circuit. The circuit code is provided by the connectivity provider.	longtel001
EndTime	string	The time when the Express Connect circuit expires.	2022-04-24T16:00:00Z
PortType	string	The port type of the Express Connect circuit. 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 km) 10GBase-T: 10,000 Mbit/s copper Ethernet port 10GBase-LR: 10,000 Mbit/s single-mode optical port (10 km) 40GBase-LR: 40,000 Mbit/s single-mode optical port 100GBase-LR: 100,000 Mbit/s single-mode optical port Note Whether 40GBase-LR and 100GBase-LR ports can be created depends on resource supplies. For more information, contact your account manager.	10GBase-LR
BusinessStatus	string	The status of the Express Connect circuit. Valid values: Normal: enabled FinancialLocked: locked due to overdue payments SecurityLocked: locked for security reasons	Normal
LoaStatus	string	The status of the letter of authorization (LOA). Valid values: Applying: The LOA is pending for 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.	Available
AccessPointId	string	The ID of the Express Connect circuit.	ap-cn-hangzhou-finance-yh-E
AccessPointType	string	The type of the access point.	VPC
HasReservationData	string	Indicates whether the data about pending orders is returned. Valid values: true false	false
PhysicalConnectionId	string	The ID of the Express Connect circuit.	pc-bp1ciz7ekd2grn1as****
ProductType	string	The type of the Express Connect circuit. Valid values: VirtualPhysicalConnection: shared Express Connect circuit PhysicalConnection: dedicated Express Connect circuit	PhysicalConnection
VirtualPhysicalConnectionCount	integer	The number of Express Connect circuits that are established.	0
ParentPhysicalConnectionId	string	The ID of the parent Express Connect circuit.	pc-bp1ciz7ekd2grn1as****
ParentPhysicalConnectionAliUid	integer	The ID of the Alibaba Cloud account to which the parent Express Connect circuit belongs.	132193271328****
VlanId	string	The VLAN ID of the shared Express Connect circuit.	10
OrderMode	string	The payer for the hosted connection. Valid values: PayByPhysicalConnectionOwner: The partner pays for the shared Express Connect circuit. PayByVirtualPhysicalConnectionOwner: The tenant pays for the shared Express Connect circuit.	PayByPhysicalConnectionOwner
VpconnStatus	string	The status of the shared Express Connect circuit. Valid values: Confirmed UnConfirmed Deleted	Confirmed
ExpectSpec	string	The estimated maximum bandwidth of the shared Express Connect circuit. The estimated bandwidth takes effect after you complete the payment. Unit: M (Mbit/s) and G (Gbit/s).	50M
ResourceGroupId	string	The resource group ID to which the instance belongs.	rg-acfmwu3k52p****
AdDetailLocation	string	The information about the data center and rack.	浙江省杭州市XX区XX镇XX路10号, XX机房, ET135ET135-XX-2包间, JXX机柜, position30
Tags	object
tags	array<object>	The tags that are added to the cluster.
	object
Key	string	The key of tag N added to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	The value of tag N added to the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua
QosId	string	The ID of the QoS policy.	qos-bp10s3szn8rgnxuw7****
OpticalModuleModel	string
MacsecKeys	object
MacsecKey	array<object>
	object
CipherSuite	string
Ckn	string
Cak	string
StartOn	string
Status	string

Examples

Success response

JSON format

{
  "RequestId": "0E6D0EC4-7C91-53E2-9F65-64BF713114B0",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "PhysicalConnectionSet": {
    "PhysicalConnectionType": [
      {
        "Type": "VPC",
        "Status": "Enabled",
        "CreationTime": "2021-08-24T07:30:58Z",
        "AdLocation": "浙江省杭州市XX区XX镇XX路10号",
        "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": "浙江省杭州市XX区XX镇XX路XX号",
        "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": 0,
        "VlanId": "10",
        "OrderMode": "PayByPhysicalConnectionOwner",
        "VpconnStatus": "Confirmed",
        "ExpectSpec": "50M",
        "ResourceGroupId": "rg-acfmwu3k52p****",
        "AdDetailLocation": "浙江省杭州市XX区XX镇XX路10号, XX机房, ET135ET135-XX-2包间, JXX机柜,  position30",
        "Tags": {
          "tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "QosId": "qos-bp10s3szn8rgnxuw7****",
        "OpticalModuleModel": "",
        "MacsecKeys": {
          "MacsecKey": [
            {
              "CipherSuite": "",
              "Ckn": "",
              "Cak": "",
              "StartOn": "",
              "Status": ""
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationUnsupported.ResourceGroupId	ResourceGroupId in financial region is unsupported.	The operation is not supported because Alibaba Finance Cloud does not support resource group IDs.
400	InvalidTagKey.Malformed	The specified tag key is invalid.	Invalid tag key value. Specify a valid tag key value and try again.
400	OperationFailed.InternalError	The request processing has failed due to some unknown error.	Unknown error. Please retry the operation. The error still exists. Please submit the work order for processing.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	Filter.X.key is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.