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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| vpc:DescribePhysicalConnections | list |
|
| 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 most recent region list. | cn-hangzhou |
| PageNumber | integer | No | The page number. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Default value: 10. Valid values: 1 to 50. | 10 |
| IncludeReservationData | boolean | No | Specifies whether to return the data about pending orders. Valid values:
| false |
| ClientToken | string | No | 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 |
| Filter | array<object> | No | The filter keys. | |
| object | No | |||
| Key | string | No | The key of the filter. Valid values:
Note
By default, you cannot set the value to 40G or 100G. To use these values, you must first contact your account manager.
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 |
| Value | array | No | The filter values. | |
| string | No | 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 | |
| Tags | array<object> | No | The tag list. | |
| object | No | |||
| Key | string | No | 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 | FinanceDept |
| Value | string | No | 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 | FinanceJoshua |
| ResourceGroupId | string | No | The ID of the resource group to which the Express Connect circuit belongs. | rg-aek2yvwibxrmrkq |
Response parameters
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": "Position 30, Server Rack JXX, Booth ET135ET135-XX-2, Room XX, Building 10, XX Road, XX Town, XX District, Hangzhou, Zhejiang Province\n",
"Tags": {
"tags": [
{
"Key": "FinanceDept",
"Value": "FinanceJoshua"
}
]
},
"QosId": "qos-bp10s3szn8rgnxuw7****"
}
]
}
}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. |
| 404 | InvalidFilterKey.ValueNotSupported | Specified filter key is not supported: Filter.X.key | Filter.X.key is not supported. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-12 | The Error code has changed | View Change Details |
| 2024-06-13 | The Error code has changed | View Change Details |
| 2024-02-01 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-08-08 | API Description Update. The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-04-25 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2021-11-17 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2021-09-27 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2021-09-27 | The Error code has changed. The response structure of the API has changed | View Change Details |