Queries hosted connections.
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:ListVirtualPhysicalConnections | list |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PhysicalConnectionId | string | No | The ID of the Express Connect circuit over which the hosted connections are created. Express Connect circuits in this topic refer to Express Connect circuits over which hosted connections are created. | pc-bp1ciz7ekd2grn1as**** |
| VirtualPhysicalConnectionBusinessStatus | string | No | The business status of the hosted connection. Valid values:
| Normal |
| VirtualPhysicalConnectionIds | array | No | The information about the hosted connection. | |
| string | No | The ID of the hosted connection. You can specify multiple hosted connection IDs. Valid values of N: 1 to 20. | pc-bp1mrgfbtmc9brre7**** | |
| IsConfirmed | boolean | No | Specifies whether the hosted connection is accepted by the tenant. Valid values:
| true |
| VirtualPhysicalConnectionStatuses | array | No | The business status of the hosted connection. | |
| string | No | The status of the hosted connection. Valid values:
You can specify multiple states. Valid values of N: 1 to 20. | Confirmed | |
| VirtualPhysicalConnectionAliUids | array | No | The information about the Alibaba Cloud account that owns the hosted connection. | |
| string | No | The Alibaba Cloud account ID of the hosted connection owner. You can specify multiple Alibaba Cloud account IDs. Valid values of N: 1 to 20. | 253460731706911258 | |
| VlanIds | array | No | The VLAN ID of the hosted connection. | |
| string | No | The VLAN ID of the hosted connection. You can specify multiple VLAN IDs. Valid values of N: 1 to 20. | 10 | |
| MaxResults | integer | No | The number of entries per page. Valid values: 1 to 100. Default value: 20. | 20 |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. Valid values:
| dd20**** |
| RegionId | string | Yes | The region ID of the hosted connection. You can call the DescribeRegions operation to query the most recent region list. | cn-shanghai |
| 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 hosted connection belongs. | rg-acfmxazb4p**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "2A55F69E-EE3D-5CBE-8805-734F7D5B46B9",
"VirtualPhysicalConnections": [
{
"Type": "VPC",
"Status": "Enabled",
"CreationTime": "2021-06-08T12:20:55",
"AdLocation": "Yuhang Economic Development Zone XXX Intersection, Yuhang XX Machine Room, E*** Suite.",
"PortNumber": "80",
"Spec": "50M",
"ChargeType": "Prepaid",
"Description": "desctest",
"Bandwidth": 50,
"EnabledTime": "2021-10-08T10:44Z",
"LineOperator": "CU",
"PeerLocation": "XX Number, XX Road, XX Town, XX District, Hangzhou City, Zhejiang Province.",
"RedundantPhysicalConnectionId": "pc-119mfjzm****",
"Name": "nametest",
"CircuitCode": "longtel001",
"EndTime": "2021-11-08T16:00:00Z",
"PortType": "10GBase-LR",
"BusinessStatus": "Normal",
"LoaStatus": "Available",
"AccessPointId": "ap-cn-hangzhou-finance-yh-E",
"PhysicalConnectionId": "pc-bp1mrgfbtmc9brre7****",
"ProductType": "VirtualPhysicalConnection",
"ParentPhysicalConnectionId": "pc-bp1ciz7ekd2grn1as****",
"VirtualPhysicalConnectionStatus": "Confirmed",
"ParentPhysicalConnectionAliUid": "283117732402483989",
"OrderMode": "PayByPhysicalConnectionOwner",
"AliUid": "253460731706911258",
"VlanId": "10",
"ExpectSpec": "50M",
"ResourceGroupId": "rg-acfm3wmsyuimpma",
"Tags": [
{
"Key": "FinanceDept",
"Value": "FinanceJoshua"
}
]
}
],
"NextToken": "dd20****",
"TotalCount": 1,
"Count": 1
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | IllegalParam.Bandwidth | The param of Bandwidth [%s] is illegal. | The specified bandwidth value is invalid. |
| 400 | ResourceNotFound.PhysicalConnectionId | The specified PhysicalConnectionId [%s] is not found. | PhysicalConnectionId is set to an invalid value. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-08-08 | API Description Update. 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 | Add Operation | View Change Details |