Creates a hosted connection.

Usage notes

Before you call this operation, learn about the workflow for creating a hosted connection and the environment requirements. For more information, see Overview and Operation guide for Express Connect partners.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateVirtualPhysicalConnection

The operation that you want to perform. Set the value to CreateVirtualPhysicalConnection.

OrderMode String Yes PayByVirtualPhysicalConnectionOwner

The payer for the hosted connection. Valid values:

  • PayByPhysicalConnectionOwner: The partner pays for the hosted connection.
  • PayByVirtualPhysicalConnectionOwner: The tenant pays for the hosted connection.
VlanId Long Yes 4

The virtual local area network (VLAN) ID of the hosted connection. Valid values: 0 to 2999.

  • If the VLAN ID is set to 0, it indicates that the switch port of the virtual border router (VBR) is a Layer 3 router interface instead of a VLAN interface. When a Layer 3 router interface is used, each Express Connect circuit corresponds to a VBR.
  • If the VLAN ID is set to a value from 1 to 2999, the switch port of the VBR is a Layer 3 VLAN subinterface. When a Layer 3 VLAN subinterface is used, each VLAN ID corresponds to one VBR. In this case, the Express Connect circuit with which the VBR is associated can be used to connect to virtual private clouds (VPCs) that belong to different Alibaba Cloud accounts. VBRs in different VLANs are isolated from each other at Layer 2.
Spec String Yes 50M

The bandwidth value of the hosted connection.

Valid values: 50M, 100M, 200M, 300M, 400M, 500M, 1G, 2G, 5G, 8G, and 10G.

Note By default, 2G, 5G, 8G, and 10G are unavailable. If you want to specify these values, contact your account manager.

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

VpconnAliUid Long Yes 1210123456123456

The Alibaba Cloud account ID of the tenant.

PhysicalConnectionId String Yes pc-bp1ciz7ekd2grn1as****

The ID of the Express Connect circuit over which the hosted connection is created.

Name String No nametest

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 http:// or https://.

Token String No CBCE910E-D396-4944-8****

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 all requests. The token can contain only ASCII characters.

Note If you do not specify this parameter, ClientToken is set to the value of RequestId. RequestId may be different for each API request.
DryRun Boolean No false

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run. The system checks the required parameters, request syntax, and instance status. If the request fails the dry run, the corresponding error message is returned. If the request passes the check, DRYRUN.SUCCESS is returned.
  • false: sends the request. If the request passes the check, the hosted connection is created. This is the default value.
Description String No desctest

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 http:// or https://.

RegionId String Yes cn-hangzhou

The region ID of the hosted connection.

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

ResourceGroupId String No rg-aekzjty2chzuqky

The ID of the resource group to which the hosted connection belongs.

Tag.N.Key String No FinanceDept

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 aliyun or acs:. The key cannot contain http:// or https://.

Tag.N.Value String No FinanceJoshua

The tag value. You can specify at most 20 tag values. It can be an empty string.

The value cannot exceed 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). The value must start with a letter but cannot start with aliyun or acs:. The value cannot contain http:// or https://.

Response parameters

Parameter Type Example Description
RequestId String CD14EA74-E9C3-59A9-942A-DFEC7E12818D

The ID of the request.

VirtualPhysicalConnection String pc-bp1mrgfbtmc9brre7****

The ID of the hosted connection.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateVirtualPhysicalConnection
&OrderMode=PayByVirtualPhysicalConnectionOwner
&VlanId=4
&Spec=50M
&VpconnAliUid=1210123456123456
&PhysicalConnectionId=pc-bp1ciz7ekd2grn1as****
&Name=nametest
&Token=CBCE910E-D396-4944-8****
&DryRun=false
&Description=desctest
&RegionId=cn-hangzhou
&ResourceGroupId=rg-aekzjty2chzuqky
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateVirtualPhysicalConnectionResponse>
    <RequestId>CD14EA74-E9C3-59A9-942A-DFEC7E12818D</RequestId>
    <VirtualPhysicalConnection>pc-bp1mrgfbtmc9brre7****</VirtualPhysicalConnection>
</CreateVirtualPhysicalConnectionResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CD14EA74-E9C3-59A9-942A-DFEC7E12818D",
  "VirtualPhysicalConnection" : "pc-bp1mrgfbtmc9brre7****"
}

Error codes

HttpCode Error code Error message Description
400 OperationFailed.VbrBindedPconn The operation is failed because of VbrBindedPconn. The error message returned because a hosted connection is created for the VBR.
400 IllegalParam.Bandwidth The param of Bandwidth [%s] is illegal. The error message returned because the specified bandwidth value is invalid.
400 ResourceNotFound.PhysicalConnectionId The specified PhysicalConnectionId [%s] is not found. The error message returned because the PhysicalConnectionId parameter is set to an invalid value.
400 OperationFailed.VPconnCreated The operation is failed because of VPconnCreated. The error message returned because the hosted connection cannot be created.
400 MissingParam.Spec The param of Spec is missing. The error message returned because the Spec parameter is not set.
400 IllegalParam.Spec The param of Spec is illegal. The error message returned because the Spec parameter is set to an invalid value.
400 IllegalParam.VlanId The param of VlanId is illegal. The error message returned because the VlanId parameter is set to an invalid value.
400 InvalidPhysicalConnectionId.NotFound The specified PhysicalConnectionId is not found. The error message returned because 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. The error message returned because the PhysicalConnectionId parameter is not specified.
400 InvalidPhysicalConnectionId.NotEnabled The specified PhysicalConnectionId is not in Enabled state. The error message returned because the Express Connect circuit is in an invalid state. Check the Express Connect circuit and try again.
400 InvalidVlanId.Malformed The specified VlanId is not valid. The error message returned because the VlanId parameter is set to an invalid value.
400 InvalidName.Malformed The specified Name is not valid. The error message returned because the Name parameter is set to an invalid value.
400 InvalidDescription.Malformed The specifid Description is not valid. The error message returned because the Description parameter is set to an invalid value.
400 ResourceNotEnough.Bandwidth The specified resource of Bandwidth is not enough. The error message returned because bandwidth resources are insufficient.
400 IllegalParam.VpconnAliUid The specified AliUid of Vpconn is illegal. The error message returned because the AliUid parameter of the hosted connection is set to an invalid value.
400 IllegalParam.OrderMode The param of OrderMode is illegal. The error message returned because the OrderMode parameter is set to an invalid value.
400 OperationDenied.CreateVpconn You are not allowed to create virtual physical connection. Please contact you CBM. The error message returned because you do not have the permissions to create a hosted connection. Contact your account manager.
400 Forbidden.VpconnAliUid Vpconn UID is forbidden to belong to a RAM account or partner account. The error message returned because 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 error message returned because the number of shared ports created for an Express Connect circuit exceeds the upper limit.

For a list of error codes, see VPC error codes.