Applies for an Express Connect circuit.

Usage notes

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-shanghai

The region ID of the Express Connect circuit.

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

AccessPointId String Yes ap-cn-beijing-ft-A

The access point ID of the Express Connect circuit.

Type String No VPC

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

LineOperator String Yes CT

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
bandwidth Integer No 50

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.

PeerLocation String No XX street

The geographical location of the data center.

PortType String No 1000Base-T

The port type of the Express Connect circuit. 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 kilometers)
  • 40GBase-LR: 40,000 Mbit/s single-mode optical port
  • 100GBase-LR: 100,000 Mbit/s single-mode optical port
Note If you want to use the 40GBase-LR or 100GBase-LR port for an Express Connect circuit, you must first contact your account manager to obtain information about resource supplies.
RedundantPhysicalConnectionId String No pc-119mfjzm****

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

Description String No description

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

Name String No test

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

CircuitCode String No longtel001

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

ClientToken String Yes 123e4567-e89b-12d3-a456-42665544****

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.
Action String Yes CreatePhysicalConnection

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

ResourceGroupId String No rg-acfmoiyermp****

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

Tag.N.Key String No FinanceDept

The key of the tag. 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 value of the tag. 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
PhysicalConnectionId String pc-bp1ciz7ekd2grn1as****

The ID of the Express Connect circuit.

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-shanghai
&AccessPointId=ap-cn-beijing-ft-A
&Type=VPC
&LineOperator=CT
&bandwidth=50
&PeerLocation=XX street
&PortType=1000Base-T
&RedundantPhysicalConnectionId=pc-119mfjzm****
&Description=description
&Name=test
&CircuitCode=longtel001
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&Action=CreatePhysicalConnection
&ResourceGroupId=rg-acfmoiyermp****
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Sample success responses

XML format

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

<CreatePhysicalConnectionResponse>
    <PhysicalConnectionId>pc-bp1ciz7ekd2grn1as****</PhysicalConnectionId>
    <RequestId>8A6A5EC5-6F6C-4906-9689-56ACE58A13E0</RequestId>
</CreatePhysicalConnectionResponse>

JSON format

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

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

Error codes

HttpCode Error code Error message Description
400 Invalid.Status The device or interface status invalid, or has been used.. The error message returned because the Status parameter is set to an invalid value.
400 InvalidType.Malformd The Type provided was invalid. The error message returned because Type is set to an invalid value.
400 InvalidPeerLocation.Malformd The PeerLocation provided was invalid. The error message returned because PeerLocation is set to an invalid value.
400 InvalidLineOperator.Malformd The LineOperator provided was invalid. The error message returned because LineOperator is set to an invalid value.
400 InvalidPortType.Malformd The PortType provided was invalid. The error message returned because the specified port type is invalid.
400 InvalidDescription.Malformed The specifid ?Description? is not valid. The error message returned because the specified description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400 InvalidRedundantPhysicalConnectionId.NotFound The RedundantPhysicalConnectionId does not found. The error message returned because the specified redundant Express Connect circuit does not exist.
400 InvalidName.Malformed The specified ?Name? is not valid. The error message returned because the format of the name is invalid.
400 QuotaExceeded.pConnPerAP Physical connection count per ap quota exceed. The error message returned because the number of Express Connect circuits that are connected to the specified access point has reached the upper limit.
400 InvalidBandwidth invalid physical connection banwidth. The error message returned because the specified maximum bandwidth of the Express Connect circuit is invalid.
400 InvalidRedundantPhysicalConnection redundant physical connection doesn't belong to current user. The error message returned because the specified redundant Express Connect circuit does not belong to your Alibaba Cloud account.
400 InvalidRedundantPhysicalConnectionStatus invalid redundant physical connection status. The error message returned because the redundant Express Connect circuit is in an invalid state.
400 InvalidCircuitCode.Malformed circuitCode is illegal. The error message returned because CircuitCode is set to an invalid value.
400 QuotaExceeded.freePconnPerAP free physical connections count excceeded. The error message returned because the quota on Express Connect circuits is exhausted.
400 InvalidPhysicalConnectionOperator.Malformed Specified PhysicalConnection Operator is not valid. The error message returned because the operation is invalid.
400 InvalidPhysicalConnectionPortType.Malformed Specified PhysicalConnection PortType is not valid. The error message returned because the port type of the Express Connect circuit is invalid.
400 InvalidPhysicalConnectionBandwidth.Malformed Specified PhysicalConnection Bandwidth is not valid. The error message returned because the bandwidth of the Express Connect circuit is set to an invalid value.
400 IllegalParam.ClientToken Token verify failed because client token length too long. The error message returned because the ClientToken parameter is set to an invalid value.
400 InvalidPortType.NotFound Specified port type is not found. The error message returned because the specified port is out of stock.
400 OperationFailed.PconnTrafficNotEnable The operation is failed because of PconnTrafficNotEnable. The error message returned because outbound traffic is disabled.
404 InvalidPortType.NotFound There are no resources with the portType. The error message returned because the specified port type is invalid.

For a list of error codes, visit the API Error Center.