Create a Physical Connection Circuit via API - Express Connect - Alibaba Cloud - Express Connect

Calls the CreatePhysicalConnection operation to apply for an Express Connect circuit.

Operation description

You can apply for a dedicated Express Connect circuit or apply for a shared Express Connect circuit for a tenant. After the application is complete, the Express Connect circuit enters the Initial state. Contact the carrier to start construction.

When you call this operation, note the following items:

When you apply for an Express Connect circuit, the number of Express Connect circuits that are not in the Enabled state cannot exceed 5.
If your account has an Express Connect circuit with an overdue payment, you cannot apply for a new Express Connect circuit.

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:CreatePhysicalConnection

create

*PhysicalConnection

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Express Connect circuit. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
AccessPointId	string	Yes	The ID of the access point where the Express Connect circuit is located.	ap-cn-beijing-ft-A
Type	string	No	The type of the Express Connect circuit. Default value: VPC.	VPC
LineOperator	string	Yes	The carrier that provides the Express Connect circuit. Valid values: CT: China Telecom. CU: China Unicom. CM: China Mobile. CO: Other carriers in China. Equinix: Equinix. Other: Other carriers outside China.	CT
bandwidth	integer	No	The bandwidth of the shared Express Connect circuits. Unit: Mbit/s. Valid values: 50, 100, 200, 300, 400, 500, 1000, 2000, 4000, 5000, 8000, and 10000.	50
PeerLocation	string	No	The geographical location of the on-premises data center.	XX街道
PortType	string	No	The port type of the Express Connect circuit. Valid values: 100Base-T: 100M Ethernet port. 1000Base-T: 1 GE electrical port. 1000Base-LX: GE single-mode optical port (10 km). 10GBase-T: 10 GE electrical port. 10GBase-LR: 10 GE single-mode optical port (10 km). 40GBase-LR: 40 GE single-mode optical port. 100GBase-LR: 100 GE single-mode optical port. Note 40GBase-LR and 100GBase-LR are created based on the actual port availability in the backend. Contact your account manager for port availability details.	1000Base-T
RedundantPhysicalConnectionId	string	No	The instance ID of the redundant Express Connect circuit. The redundant circuit must be in the Allocated, Confirmed, or Enabled state.	pc-119mfjzm****
Description	string	No	The description of the Express Connect circuit. 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://`.	description
Name	string	No	The name of the Express Connect circuit. 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 (-). It cannot start with `http://` or `https://`.	test
CircuitCode	string	No	The circuit code provided by the carrier for the Express Connect circuit.	longtel001
ClientToken	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.	123e4567-e89b-12d3-a456-42665544****
ClientToken	string	No	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 Note 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-42665544****
ResourceGroupId	string	No	The ID of the resource group to which the Express Connect circuit belongs.	rg-acfmoiyermp****
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 128 characters in length. 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. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua
DeviceAdvancedCapacity	array	No	The list of device advanced capabilities.
	string	No	The list of device advanced capabilities. Valid values: SubifRateLimit: supports bandwidth throttling at the VBR granularity. DualStack: supports IPv6 protocol. BFD: supports fault detection network protocol between forwarding points. CEN: supports MP-BGP protocol. CENv6: supports MP-BGPv6 protocol. QOS: supports QoS. MS-HA: supports fast switchover groups. Multi-MS-HA: supports multiple switchover groups. Valid values: BFD : BFD SubifRateLimit : SubifRateLimit DualStack : DualStack CENv6 : CENv6 CEN : CEN	CENv6
OpticalModuleModel	string	No	The optical module model supported by the Express Connect circuit access point. Valid values: 1000Base-LX : `SFP-GE-LR-SM1310,10KM` `SFP-GE-ER-SM1310,40KM` `SFP-GE-ZR-SM1550,80KM` 10GBase-LR : `SFP-10G-LR-SM1310,10KM` `SFP-10G-ER-SM1550,40KM` `SFP-10G-ZR-SM1550,80KM` 40GBase-LR : `QSFP-40G-LR4-WDM1300,10KM` `QSFP-40G-ER4-WDM1300,40KM` `QSFP-40G-ZR4-WDM1300,80KM` 100GBase-LR : `QSFP28-100G-LR4-WDM1300,10KM` `QSFP28-100G-ER4-WDM1300,40KM` `QSFP28-100G-ZR4-WDM1300,80KM`.	SFP-GE-LR-SM1310,10KM

Response elements

Element	Type	Description	Example
	object	The response parameters.
PhysicalConnectionId	string	The instance ID of the Express Connect circuit.	pc-bp1ciz7ekd2grn1as****
RequestId	string	The request ID.	8A6A5EC5-6F6C-4906-9689-56ACE58A13E0

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Status	The device or interface status invalid, or has been used..	The Status parameter is set to an invalid value.
400	InvalidType.Malformd	The Type provided was invalid.
400	InvalidPeerLocation.Malformd	The PeerLocation provided was invalid.
400	InvalidLineOperator.Malformd	The LineOperator provided was invalid.
400	InvalidPortType.Malformd	The PortType provided was invalid.
400	InvalidDescription.Malformed	The 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://.
400	InvalidRedundantPhysicalConnectionId.NotFound	The RedundantPhysicalConnectionId does not found.
400	InvalidName.Malformed	The specified ?Name? is not valid.
400	QuotaExceeded.pConnPerAP	Physical connection count per ap quota exceed.
400	InvalidBandwidth	invalid physical connection banwidth.
400	InvalidRedundantPhysicalConnection	redundant physical connection doesn't belong to current user.
400	InvalidRedundantPhysicalConnectionStatus	invalid redundant physical connection status.
400	InvalidCircuitCode.Malformed	circuitCode is illegal.
400	QuotaExceeded.freePconnPerAP	free physical connections count excceeded.
400	InvalidPhysicalConnectionOperator.Malformed	Specified PhysicalConnection Operator is not valid.	The operation on the Express Connect circuit is invalid.
400	InvalidPhysicalConnectionPortType.Malformed	Specified PhysicalConnection PortType is not valid.	The port type of the Express Connect circuit is invalid.
400	InvalidPhysicalConnectionBandwidth.Malformed	Specified PhysicalConnection Bandwidth is not valid.	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 ClientToken parameter is set to an invalid value.
400	InvalidPortType.NotFound	Specified port type is not found.	The portType parameter is not set.
400	OperationFailed.PconnTrafficNotEnable	The operation is failed because of PconnTrafficNotEnable.	Billing for outbound data transfer is disabled.
400	InvalidAccessPointId.NotEnabled	Invalid access point status.
400	ResourceNotFound.AccessPointId	The specified resource of access point id is not found.	The current access point information does not exist. Please check and try again.
400	InvalidParameter.DeviceAdvancedCapacity	Invalid physical connection device advanced capacity.	The advanced port capability is temporarily not supported. Please confirm and try again.
404	InvalidPortType.NotFound	There are no resources with the portType.	The specified port type is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.