All Products
Search
Document Center

Virtual Private Cloud:CreateVirtualPhysicalConnection

Last Updated:Jun 18, 2024

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:CreateVirtualPhysicalConnectionWrite
  • PhysicalConnection
    acs:vpc:{#regionId}:{#accountId}:physicalconnection/{#physicalconnectionId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderModestringYes

The payer for the hosted connection. Valid values:

  • PayByPhysicalConnectionOwner: The partner pays for the hosted connection.
  • PayByVirtualPhysicalConnectionOwner: The tenant pays for the hosted connection.
PayByVirtualPhysicalConnectionOwner
VlanIdlongYes

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.
4
SpecstringYes

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
VpconnAliUidlongYes

The Alibaba Cloud account ID of the tenant.

1210123456123456
PhysicalConnectionIdstringYes

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

pc-bp1ciz7ekd2grn1as****
NamestringNo

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://.

nametest
TokenstringNo

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****
DryRunbooleanNo

Specifies whether to perform a dry run, without performing the actual request. Default value: 45104. Valid values:

  • true: performs a dry run. The system checks the request for potential issues, including required parameters, request syntax, and instance status. If the request fails the dry run, an error code is returned. If the request passes the dry run, DRYRUN.SUCCESS is returned.
  • false: performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
false
DescriptionstringNo

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://.

desctest
RegionIdstringYes

The region ID of the hosted connection.

You can call the DescribeRegions operation to obtain the region ID.

cn-hangzhou
ResourceGroupIdstringNo

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

rg-aekzjty2chzuqky
Tagobject []No

The tags.

KeystringNo

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://.

FinanceDept
ValuestringNo

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

FinanceJoshua

Response parameters

ParameterTypeDescriptionExample
object

The request ID.

RequestIdstring

The request ID.

CD14EA74-E9C3-59A9-942A-DFEC7E12818D
VirtualPhysicalConnectionstring

The ID of the hosted connection.

pc-bp1mrgfbtmc9brre7****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400OperationFailed.VbrBindedPconnThe operation is failed because of VbrBindedPconn.A hosted connection is created for the VBR.
400IllegalParam.BandwidthThe param of Bandwidth [%s] is illegal.The specified bandwidth value is invalid.
400ResourceNotFound.PhysicalConnectionIdThe specified PhysicalConnectionId [%s] is not found.PhysicalConnectionId is set to an invalid value.
400OperationFailed.VPconnCreatedThe operation is failed because of VPconnCreated.You cannot create an Express Connect circuit.
400MissingParam.SpecThe param of Spec is missing.The Spec parameter is not set.
400IllegalParam.SpecThe param of Spec is illegal.The Spec parameter is set to an invalid value.
400IllegalParam.VlanIdThe param of VlanId is illegal.The VlanId parameter is set to an invalid value.
400VLAN_ID_HAS_BEEN_USED_IN_PHYSICAL_CONNECTIONvlan id has been used in physical connection-
400InvalidPhysicalConnectionId.NotFoundThe specified PhysicalConnectionId is not found.The specified Express Connect circuit ID does not exist.
400MissingParameterThe input parameter 'PhysicalConnectionId' that is mandatory for processing this request is not supplied.PhysicalConnectionId is not specified.
400InvalidPhysicalConnectionId.NotEnabledThe specified PhysicalConnectionId is not in Enabled state.The Express Connect circuit is in an invalid state. Check the Express Connect circuit and try again.
400OperationFailed.PconnAllocateVlan0The operation is failed because of PconnAllocatedResource.-
400InvalidVlanId.MalformedThe specified VlanId is not valid.VlanId is set to an invalid value.
400InvalidName.MalformedThe specified Name is not valid.The Name parameter is set to an invalid value.
400ResourceNotEnough.BandwidthThe specified resource of Bandwidth is not enough.The specified resource of Bandwidth is insufficient.
400IllegalParam.VpconnAliUidThe specified AliUid of Vpconn is illegal.The AliUid parameter of the Express Connect circuit is set to an invalid value.
400IllegalParam.OrderModeThe param of OrderMode is illegal.The OrderMode parameter is set to an invalid value.
400Forbidden.VpconnAliUidVpconn 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.
400QuotaExceeded.VPCONNThe quota of VPCONN_COUNT_PER_PCONN is exceededThe number of shared ports created for an Express Connect circuit exceeds the upper limit.
400OperationDenied.CreateVpconnYou 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.
400InvalidDescription.MalformedThe specified Description is not valid.Parameter Description value is illegal

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-05-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2024-02-01API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-12-21The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-03-14The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tag
2021-11-17The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2021-09-27The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2021-09-27Add Operationsee changesets
2021-09-27The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400