All Products
Search
Document Center

Virtual Private Cloud:CreateVpconnFromVbr

Last Updated:Jun 18, 2024

Adds a shared port to a hosted connection.

Operation description

If an Express Connect partner has created a virtual border router (VBR) for a tenant before, the Express Connect partner can push the Express Connect circuit that is associated with the VBR to the tenant account by adding a shared port for the tenant account. The service of the tenant is not interrupted in this process.

Preparations:

Before the Express Connect partner performs the operation, the Express Connect partner must notify the tenant and request the tenant to enable outbound data transfer billing. For more information, see Enable outbound data transfer billing.

What to do next:

  1. After the Express Connect partner performs the operation, a shared port is added for the tenant account. The tenant must call the ConfirmPhysicalConnection operation to accept the shared port.
  2. Then, the Express Connect partner must call the AttachVbrToVpconn operation to associate the VBR with the newly added shared port that belongs to the tenant account.

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:CreateVpconnFromVbrWrite
  • VirtualBorderRouter
    acs:vpc:{#regionId}:{#accountId}:virtualborderrouter/{#virtualborderrouterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderModestringNo

The payer for the shared Express Connect circuit. Valid values:

  • PayByPhysicalConnectionOwner: the owner of the shared Express Connect circuit
  • PayByVirtualPhysicalConnectionOwner: the owner of the hosted connection
PayByVirtualPhysicalConnectionOwner
VbrIdstringYes

The ID of the associated VBR.

vbr-bp136flp1mf8mlq6r****
TokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

CBCE910E-D396-4944-8****
DryRunbooleanNo

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

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and instance status. If the request fails the dry run, an error message is returned. If the request passes the dry run, the system returns the ID of the request.
  • false (default): 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
RegionIdstringYes

The region ID of the hosted connection.

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

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

5356F028-0F5C-56FC-8574-897D24379041
VirtualPhysicalConnectionstring

The ID of the hosted connection.

pc-bp1mrgfbtmc9brre7****

Examples

Sample success responses

JSONformat

{
  "RequestId": "5356F028-0F5C-56FC-8574-897D24379041",
  "VirtualPhysicalConnection": "pc-bp1mrgfbtmc9brre7****"
}

Error codes

HTTP status codeError codeError messageDescription
400OperationFailed.TargetUserPconnTrafficNotEnableThe operation failed because of TargetUserPconnTrafficNotEnable.The operation failed because the user does not have outbound traffic enabled.
400ResourceNotEnough.BandwidthThe specified resource of Bandwidth is not enough.The specified resource of Bandwidth is insufficient.
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.
400IncorrectStatus.VbrIdThe status of %s is incorrect.The status of the VBR is invalid.
400ResourceNotFound.PhysicalConnectionIdPhysicalConnection 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.
400OperationFailed.BandwidthOrVlanIdEmptyThe operation is failed because of BandwidthOrVlanIdEmpty.-

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

Change history

Change timeSummary of changesOperation
2021-09-27Add Operationsee changesets
2021-09-27The 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.
    delete Error Codes: 400