Creates a hosted connection over Express Connect circuit.
Operation description
Description
Before you call this operation, we recommend that you learn about the workflow for creating a hosted connection and the environment requirements. For more information, see Overview of hosted connections and Operations performed by Express Connect partners.
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:CreateVirtualPhysicalConnection | create | *PhysicalConnection acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#physicalconnectionId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| OrderMode | string | Yes | The payer for the hosted connection. Valid values:
| PayByVirtualPhysicalConnectionOwner |
| VlanId | long | Yes | The virtual local area network (VLAN) ID of the hosted connection. Valid values: 0 to 2999.
| 4 |
| Spec | string | Yes | The bandwidth value of the hosted connection. Valid values: 50M, 100M, 200M, 300M, 400M, 500M, 1G, 2G, 5G, 8G, and 10G. Note
2G, 5G, 8G, and 10G are unavailable by default. If you want to use these bandwidth values, contact your account manager.
M indicates Mbit/s and G indicates Gbit/s. | 50M |
| VpconnAliUid | long | Yes | The Alibaba Cloud account ID of the tenant. | 1210123456123456 |
| PhysicalConnectionId | string | Yes | The ID of the Express Connect circuit over which the hosted connection is created. | pc-bp1ciz7ekd2grn1as**** |
| Name | string | No | The name of the hosted connection. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter but cannot start with | nametest |
| Token | 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 client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| CBCE910E-D396-4944-8**** |
| DryRun | boolean | No | Specifies whether to perform a dry run, without performing the actual request. Default value: 45104. Valid values:
| false |
| Description | string | No | The description of the hosted connection. The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with | desctest |
| RegionId | string | Yes | The region ID of the hosted connection. You can call the DescribeRegions operation to obtain the region ID. | cn-hangzhou |
| ResourceGroupId | string | No | The ID of the resource group to which the hosted connection belongs. | rg-aekzjty2chzuqky |
| Tag | array<object> | No | The tags. | |
| object | No | |||
| Key | string | No | The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string. The key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with | FinanceDept |
| Value | string | No | The tag value. You can specify at most 20 tag values. The tag value can be an empty string. The value can be up to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The value must start with a letter but cannot start with | FinanceJoshua |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "CD14EA74-E9C3-59A9-942A-DFEC7E12818D",
"VirtualPhysicalConnection": "pc-bp1mrgfbtmc9brre7****"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | OperationFailed.VbrBindedPconn | The operation is failed because of VbrBindedPconn. | A hosted connection is created for the VBR. |
| 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. |
| 400 | OperationFailed.VPconnCreated | The operation is failed because of VPconnCreated. | You cannot create an Express Connect circuit. |
| 400 | MissingParam.Spec | The param of Spec is missing. | The Spec parameter is not set. |
| 400 | IllegalParam.Spec | The param of Spec is illegal. | The Spec parameter is set to an invalid value. |
| 400 | IllegalParam.VlanId | The param of VlanId is illegal. | The VlanId parameter is set to an invalid value. |
| 400 | VLAN_ID_HAS_BEEN_USED_IN_PHYSICAL_CONNECTION | vlan id has been used in physical connection | - |
| 400 | InvalidPhysicalConnectionId.NotFound | The specified PhysicalConnectionId is not found. | The specified Express Connect circuit ID does not exist. |
| 400 | MissingParameter | The input parameter 'PhysicalConnectionId' that is mandatory for processing this request is not supplied. | PhysicalConnectionId is not specified. |
| 400 | InvalidPhysicalConnectionId.NotEnabled | The specified PhysicalConnectionId is not in Enabled state. | The Express Connect circuit is in an invalid state. Check the Express Connect circuit and try again. |
| 400 | OperationFailed.PconnAllocateVlan0 | The operation is failed because of PconnAllocatedResource. | - |
| 400 | InvalidVlanId.Malformed | The specified VlanId is not valid. | VlanId is set to an invalid value. |
| 400 | InvalidName.Malformed | The specified Name is not valid. | The Name parameter is set to an invalid value. |
| 400 | ResourceNotEnough.Bandwidth | The specified resource of Bandwidth is not enough. | The specified resource of Bandwidth is insufficient. |
| 400 | IllegalParam.VpconnAliUid | The specified AliUid of Vpconn is illegal. | The AliUid parameter of the Express Connect circuit is set to an invalid value. |
| 400 | IllegalParam.OrderMode | The param of OrderMode is illegal. | The OrderMode parameter is set to an invalid value. |
| 400 | Forbidden.VpconnAliUid | Vpconn UID is forbidden to belong to a RAM account or partner account. | The UID of a shared port cannot be the UID of a RAM user or a partner account. |
| 400 | QuotaExceeded.VPCONN | The quota of VPCONN_COUNT_PER_PCONN is exceeded | The number of shared ports created for an Express Connect circuit exceeds the upper limit. |
| 400 | OperationDenied.CreateVpconn | You are not allowed to create virtual physical connection. Please contact your CBM. | If you do not have permission to create a shared line, please contact the business manager. |
| 400 | InvalidDescription.Malformed | The specified Description is not valid. | Parameter Description value is illegal |
| 400 | EcAssociatedQoSPconnNotAllowCreateVpconn | The specified Pconn associated with Qos is not allowed to create Vpconn.Please contact the business manager. | Exclusive physical lines bound with QoS policies are not allowed to create shared physical lines. Please contact the business manager. |
| 400 | IllegalParam.ResourceGroupId | Invalid ResourceGroupld value. | The specified resource group is invalid or does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-08 | The Error code has changed | View Change Details |
| 2024-02-01 | API Description Update. The Error code has changed | View Change Details |
| 2023-12-21 | The Error code has changed | View Change Details |
| 2023-03-14 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2021-11-17 | The Error code has changed | View Change Details |
| 2021-09-27 | The Error code has changed | View Change Details |
| 2021-09-27 | Add Operation | View Change Details |
| 2021-09-27 | The Error code has changed | View Change Details |