All Products
Search
Document Center

Virtual Private Cloud:DescribePhysicalConnections

Last Updated:Mar 04, 2024

Queries Express Connect circuits in a region.

Operation description

By default, the system queries information about all Express Connect circuits in the specified region. You can query Express Connect circuits that meet specific conditions by specifying filter conditions provided by the DescribePhysicalConnections operation. 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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribePhysicalConnectionsList
  • PhysicalConnection
    acs:vpc:{#regionId}:{#accountId}:physicalconnection/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the Express Connect circuit.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Valid values: 1 to 50.

10
IncludeReservationDatabooleanNo

Specifies whether to return the data about pending orders. Valid values:

  • true
  • false (default)
false
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.

02fb3da4-130e-11e9-8e44-001
Filterobject []No

The filter keys.

KeystringNo

The key of the filter. 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 the Chinese mainland.
    • Equinix: Equinix.
    • Other: other connectivity providers outside the Chinese mainland.
  • Spec: the specification of the Express Connect circuit. Valid values:

    • 1G and below
    • 10G
    • 40G
    • 100G
Note By default, you cannot set the value to 40G or 100G. To use these values, you must first contact your account manager.
  • 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.
    • Terminating: The Express Connect circuit is being disabled.
    • Terminated: The Express Connect circuit is disabled.
  • Name: the name of the Express Connect circuit.

  • ProductType: the type of the Express Connect circuit. Valid values:

    • VirtualPhysicalConnection: shared Express Connect circuit
    • PhysicalConnection: dedicated 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.

Name
ValuearrayNo

The filter values.

stringNo

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.

nametest
Tagsobject []No

The tag list.

KeystringNo

The key of tag N to add to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string.

It 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
ValuestringNo

The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string.

It 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
ResourceGroupIdstringNo

The ID of the resource group to which the Express Connect circuit belongs.

rg-aek2yvwibxrmrkq

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

0E6D0EC4-7C91-53E2-9F65-64BF713114B0
PageNumberinteger

The page number. Default value: 1.

1
PageSizeinteger

The number of entries per page. Default value: 10. Valid values: 1 to 50.

10
TotalCountinteger

The number of returned entries.

1
PhysicalConnectionSetobject []

The list of Express Connect circuits.

Typestring

The type of resource to which the Express Connect circuit is connected. Only VPC may be returned.

VPC
Statusstring

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.
  • Terminating: The Express Connect circuit is being disabled.
  • Terminated: The Express Connect circuit is disabled.
Enabled
CreationTimestring

The time when the Express Connect circuit was created.

2021-08-24T07:30:58Z
AdLocationstring

The location of the access point.

Number 10, XX Road, XX Town, XX District, Hangzhou City, Zhejiang Province.
ReservationActiveTimestring

The time when the pending order takes effect.

2022-02-25T11:01:04Z
ReservationOrderTypestring

The type of the pending order.

If the value is set to RENEW, it indicates that the order is placed for service renewal.

RENEW
PortNumberstring

The ID of the port on the access device.

1/1/1
Specstring

The specification of the Express Connect circuit.

Unit: G (Gbit/s).

10G
ChargeTypestring

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
ReservationInternetChargeTypestring

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
Descriptionstring

The description of the Express Connect circuit.

desctest
Bandwidthlong

The maximum bandwidth of the Express Connect circuit.

Unit: Gbit/s.

10
EnabledTimestring

The time when the Express Connect circuit is enabled.

2021-08-24T07:33:18Z
LineOperatorstring

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
PeerLocationstring

The geographical location of the data center.

XX Number, XX Road, XX Town, XX District, Hangzhou City, Zhejiang Province.
RedundantPhysicalConnectionIdstring

The ID of the redundant Express Connect circuit.

pc-119mfjzm****
Namestring

The name of the Express Connect circuit.

nametest
CircuitCodestring

The circuit code of the Express Connect circuit. The circuit code is provided by the connectivity provider.

longtel001
EndTimestring

The time when the Express Connect circuit expires.

2022-04-24T16:00:00Z
PortTypestring

The port type. 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 To create ports of 40GBase-LR and 100GBase-LR, you must first contact your account manager.
10GBase-LR
BusinessStatusstring

The status of the Express Connect circuit. Valid values:

  • Normal
  • FinancialLocked
  • SecurityLocked
Normal
LoaStatusstring

The status of the letter of authorization (LOA). Valid values:

  • Applying
  • Accept
  • Available
  • Rejected
  • Completing
  • Complete
  • Deleted
Available
AccessPointIdstring

The ID of the access point.

ap-cn-hangzhou-finance-yh-E
AccessPointTypestring

The type of the access point.

VPC
HasReservationDatastring

Indicates whether the data about pending orders is returned. Valid values:

  • true
  • false
false
PhysicalConnectionIdstring

The ID of the Express Connect circuit.

pc-bp1ciz7ekd2grn1as****
ProductTypestring

The type of the Express Connect circuit. Valid values:

  • VirtualPhysicalConnection: shared Express Connect circuit
  • PhysicalConnection: dedicated Express Connect circuit
PhysicalConnection
VirtualPhysicalConnectionCountinteger

The number of hosted connections that are established over the Express Connect circuit.

0
ParentPhysicalConnectionIdstring

The ID of the Express Connect circuit that is used to create the hosted connection.

pc-bp1ciz7ekd2grn1as****
ParentPhysicalConnectionAliUidlong

The ID of the Alibaba Cloud account to which the shared Express Connect circuit belongs.

283117732402483989
VlanIdstring

The VLAN ID of the shared Express Connect circuit.

10
OrderModestring

The payer for the shared Express Connect circuit. Valid values:

  • PayByPhysicalConnectionOwner: The partner pays for the shared Express Connect circuit.
  • PayByVirtualPhysicalConnectionOwner: The tenant pays for the shared Express Connect circuit.
PayByPhysicalConnectionOwner
VpconnStatusstring

The status of the hosted connection. Valid values:

  • Confirmed
  • UnConfirmed
  • Deleted
Confirmed
ExpectSpecstring

The estimated maximum bandwidth of the shared Express Connect circuit. The estimated bandwidth takes effect after you complete the payment.

M indicates Mbit/s and G indicates Gbit/s.

50M
ResourceGroupIdstring

The ID of the resource group to which the ACL belongs.

rg-acfmwu3k52prgdi
AdDetailLocationstring

The information about the data center and rack.

Tagsobject []

The tag list.

Keystring

The key of tag N added to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string.

It 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
Valuestring

The value of tag N added to the resource. You can specify at most 20 tag values. The tag value can be an empty string.

It 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

Examples

Sample success responses

JSONformat

{
  "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": "Number 10, XX Road, XX Town, XX District, Hangzhou City, Zhejiang Province.",
        "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 Number, XX Road, XX Town, XX District, Hangzhou City, Zhejiang Province.",
        "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": 283117732402484000,
        "VlanId": "10",
        "OrderMode": "PayByPhysicalConnectionOwner",
        "VpconnStatus": "Confirmed",
        "ExpectSpec": "50M",
        "ResourceGroupId": "rg-acfmwu3k52prgdi",
        "AdDetailLocation": "",
        "Tags": {
          "tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidFilterKey.ValueNotSupportedSpecified filter key is not supported: Filter.X.keyFilter.X.key is not supported.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-02-01The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.
2023-08-08API Description Update. The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 404 change
Output ParametersThe response structure of the API has changed.
2023-04-25The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.
2021-11-17The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.
2021-09-27The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.
2021-09-27The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.