Create a Hosted Connection for Partners via Express Connect - Express Connect - Alibaba Cloud - Express Connect

Invokes the CreateVirtualPhysicalConnection operation to create shared Express Connect circuits.

Operation description

Before calling this operation, familiarize yourself with the creation process and environment requirements for shared Express Connect circuits. For more information, see Overview of shared Express Connect circuits and Partner operation guide.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:CreateVirtualPhysicalConnection

create

*PhysicalConnection

acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#physicalconnectionId}

None

Request parameters

Parameter	Type	Required	Description	Example
OrderMode	string	Yes	The payer of the shared Express Connect circuits. Valid values: PayByPhysicalConnectionOwner: The partner pays. PayByVirtualPhysicalConnectionOwner: The tenant pays.	PayByVirtualPhysicalConnectionOwner
VlanId	integer	Yes	The VLAN ID of the shared Express Connect circuits. Valid values: 0 to 2999. If the VLAN ID is set to 0, the physical switch port of the Virtual Border Router (VBR) uses Layer 3 routing interface mode instead of VLAN mode. In Layer 3 routing interface mode, each Express Connect circuit corresponds to one VBR. If the VLAN ID is set to a value from 1 to 2999, the physical switch port of the VBR uses VLAN-based Layer 3 subinterface mode. In Layer 3 subinterface mode, each VLAN ID corresponds to one VBR. In this case, the Express Connect circuit of the VBR can connect to VPCs under multiple accounts. VBRs in different VLANs have Layer 2 network isolation and cannot communicate with each other.	4
Spec	string	Yes	The bandwidth value of the shared Express Connect circuits. Valid values: 50M, 100M, 200M, 300M, 400M, 500M, 1G, 2G, 5G, 8G, and 10G. Note The bandwidth values 2G, 5G, 8G, and 10G are not available by default. To use these values, contact your account manager. Unit: M indicates Mbit/s. G indicates Gbit/s.	50M
VpconnAliUid	integer	Yes	The Alibaba Cloud account ID of the tenant.	1210123456123456
PhysicalConnectionId	string	Yes	The ID of the Express Connect circuit associated with the shared Express Connect circuits.	pc-bp1ciz7ekd2grn1as****
Name	string	No	The name of the shared Express Connect circuits. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. It can contain digits, underscores (_), and hyphens (-) but cannot start with `http://` or `https://`.	nametest
Token	string	No	The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	CBCE910E-D396-4944-8****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without creating the shared Express Connect circuits. The system checks the required parameters, request format, and instance status. If the check fails, the corresponding error is returned. If the check succeeds, `DRYRUN.SUCCESS` is returned. false (default): sends a Normal request. After the request passes the check, the shared Express Connect circuits are created.	false
Description	string	No	The description of the shared Express Connect circuits. The description must be 2 to 256 characters in length and must start with a letter or a Chinese character. It cannot start with `http://` or `https://`.	desctest
RegionId	string	Yes	The region ID of the shared Express Connect circuits. You can invoke the DescribeRegions operation to query the region ID.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group to which the shared Express Connect circuits belong.	rg-aekzjty2chzuqky
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key 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
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value 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

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	CD14EA74-E9C3-59A9-942A-DFEC7E12818D
VirtualPhysicalConnection	string	The instance ID of the shared Express Connect circuits.	pc-bp1mrgfbtmc9brre7****

Examples

Success response

JSON format

{
  "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.
400	InvalidPhysicalConnectionId.NotEnabled	The specified PhysicalConnectionId is not in Enabled state.
400	OperationFailed.PconnAllocateVlan0	The operation is failed because of PconnAllocatedResource.
400	InvalidVlanId.Malformed	The specified VlanId is not valid.
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.
400	Forbidden.VpconnCrossBid	Not allow to create across bid virtual physical connection.
400	IncorrectStatus.PhysicalConnection	Invalid physical connection status.	The Express Connect circuit is in an invalid state.
400	OperationDenied.PhysicalConnectionNotSupportMPBGPAndMPBGP-v6	The operation is not allowed because this physical connection not support MPBGP and MPBGP-v6.	The operation is not allowed because the current physical port does not support advanced capabilities such as MPBGP and MPBGP-v6.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.