All Products
Search

This Product

    Virtual Private Cloud:CreatePhysicalConnection

    Document Center

    Virtual Private Cloud:CreatePhysicalConnection

    Last Updated:Mar 22, 2024

    Applies for an Express Connect circuit.

    Operation description

    You can apply for a dedicated Express Connect circuit for yourself or create a hosted connection for a tenant. After your application is approved, the Express Connect circuit changes to the Initial state. You can contact the connectivity provider to start construction.

    When you call this operation, take note of the following limits:

    • If your Alibaba Cloud account has more than five Express Connect circuits that are not in the Enabled state, you cannot apply for another Express Connect circuit.
    • If your Alibaba Cloud account has an Express Connect circuit with overdue payments, you cannot apply for another Express Connect circuit.

    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:CreatePhysicalConnectionWrite
    • PhysicalConnection
      acs:vpc:{#regionId}:{#accountId}:physicalconnection/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the Express Connect circuit.

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

    		cn-shanghai
    AccessPointIdstringYes

    The access point ID of the Express Connect circuit.

    		ap-cn-beijing-ft-A
    TypestringNo

    The type of Express Connect circuit. Default value: VPC.

    		VPC
    LineOperatorstringYes

    The connectivity provider of the Express Connect circuit. Valid values:

    • CT: China Telecom.
    • CU: China Unicom.
    • CM: China Mobile.
    • CO: other connectivity providers in the Chinese mainland.
    • Equinix: Equinix.
    • Other: other connectivity providers outside the Chinese mainland.
    		CT
    bandwidthintegerNo

    The maximum bandwidth of the hosted connection. Unit: Mbit/s.

    Valid values: 50, 100, 200, 300, 400, 500, 1000, 2000, 4000, 5000, 8000, and 10000.

    		50
    PeerLocationstringNo

    The geographical location of the data center.

    		cn-hangzhou
    PortTypestringNo

    The port type. Valid values:

    • 100Base-T: 100 Mbit/s copper Ethernet port
    • 1000Base-T: 1,000 Mbit/s copper Ethernet port
    • 1000Base-LX: 1,000 Mbit/s single-mode optical port (10 km)
    • 10GBase-T: 10,000 Mbit/s copper Ethernet port
    • 10GBase-LR: 10,000 Mbit/s single-mode optical port (10 km)
    • 40GBase-LR: 40,000 Mbit/s single-mode optical port
    • 100GBase-LR: 100,000 Mbit/s single-mode optical port
    Note To use ports 40GBase-LR and 100GBase-LR, you must first contact your account manager.
    		1000Base-T
    RedundantPhysicalConnectionIdstringNo

    The ID of the redundant Express Connect circuit. The redundant Express Connect circuit must be in the Allocated, Confirmed, or Enabled state.

    		pc-119mfjzm****
    DescriptionstringNo

    The description of the Express Connect circuit.

    The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with http:// or https://.

    		description
    NamestringNo

    The name of the Express Connect circuit.

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

    		test
    CircuitCodestringNo

    The circuit code of the Express Connect circuit. The circuit code is provided by the connectivity provider.

    		longtel001
    ClientTokenstringYes

    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 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.
    		123e4567-e89b-12d3-a456-42665544****
    ResourceGroupIdstringNo

    The ID of the resource group to which the Express Connect circuit belongs.

    		rg-acfmoiyermp****
    Tagobject []No

    The tag list.

    KeystringNo

    The key of tag to add to 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 128 characters in length and cannot contain http:// or https://. The tag key cannot start with aliyun or acs:.

    		FinanceDept
    ValuestringNo

    The tag value to add to the resource. You can specify up to 20 tag values The tag value can be an empty string.

    The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with aliyun or acs:.

    		FinanceJoshua
    DeviceAdvancedCapacityarrayNo

    The advanced features of the device.

    stringNo

    The advanced features. Valid values:

    • SubifRateLimit: bandwidth throttling based on virtual border routers (VBRs).
    • DualStack: IPv6
    • BFD: Bidirectional Forwarding Detection (BFD)
    • CEN: MP-BGP
    • CENv6: MP-BGPv6
    		CENv6

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned results.

    PhysicalConnectionIdstring

    The ID of the Express Connect circuit.

    		pc-bp1ciz7ekd2grn1as****
    RequestIdstring

    The request ID.

    		8A6A5EC5-6F6C-4906-9689-56ACE58A13E0

    Examples

    Sample success responses

    JSONformat

    {
  "PhysicalConnectionId": "pc-bp1ciz7ekd2grn1as****",
  "RequestId": "8A6A5EC5-6F6C-4906-9689-56ACE58A13E0"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400Invalid.StatusThe device or interface status invalid, or has been used..The Status parameter is set to an invalid value.
    400InvalidType.MalformdThe Type provided was invalid.Type is set to an invalid value.
    400InvalidPeerLocation.MalformdThe PeerLocation provided was invalid.PeerLocation is set to an invalid value.
    400InvalidLineOperator.MalformdThe LineOperator provided was invalid.The value of the LineOperator parameter is invalid.
    400InvalidPortType.MalformdThe PortType provided was invalid.The specified port type is invalid.
    400InvalidDescription.MalformedThe specifid ?Description? is not valid.The error message returned because the specified resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
    400InvalidRedundantPhysicalConnectionId.NotFoundThe RedundantPhysicalConnectionId does not found.The specified redundant Express Connect circuit does not exist.
    400InvalidName.MalformedThe specified ?Name? is not valid.The error message returned because the name format is invalid.
    400QuotaExceeded.pConnPerAPPhysical connection count per ap quota exceed.The number of Express Connect circuits that are connected to the specified access point has reached the upper limit.
    400InvalidBandwidthinvalid physical connection banwidth.The specified maximum bandwidth of the Express Connect circuit is invalid.
    400InvalidRedundantPhysicalConnectionredundant physical connection doesn't belong to current user.The specified redundant Express Connect circuit does not belong to your Alibaba Cloud account.
    400InvalidRedundantPhysicalConnectionStatusinvalid redundant physical connection status.The redundant Express Connect circuit is in an invalid state.
    400InvalidCircuitCode.MalformedcircuitCode is illegal.The error message returned because CircuitCode is set to an invalid value.
    400QuotaExceeded.freePconnPerAPfree physical connections count excceeded.The quota on Express Connect circuits is exhausted.
    400InvalidPhysicalConnectionOperator.MalformedSpecified PhysicalConnection Operator is not valid.The operation on the Express Connect circuit is invalid.
    400InvalidPhysicalConnectionPortType.MalformedSpecified PhysicalConnection PortType is not valid.The port type of the Express Connect circuit is invalid.
    400InvalidPhysicalConnectionBandwidth.MalformedSpecified PhysicalConnection Bandwidth is not valid.The bandwidth of the Express Connect circuit is set to an invalid value.
    400IllegalParam.ClientTokenToken verify failed because client token length too long.The ClientToken parameter is set to an invalid value.
    400InvalidPortType.NotFoundSpecified port type is not found.The portType parameter is not set.
    400OperationFailed.PconnTrafficNotEnableThe operation is failed because of PconnTrafficNotEnable.Billing for outbound data transfer is disabled.
    404InvalidPortType.NotFoundThere are no resources with the portType.The specified port type is invalid.

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

    Change history

    Change timeSummary of changesOperation
    2023-10-12API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: DeviceAdvancedCapacity
    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
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Tag
    2021-11-25The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404