Build Redundant Circuits for High-Availability WAN via API - Express Connect - Alibaba Cloud - Express Connect

Creates Express Connect circuits in zone-redundancy mode to ensure the stability of multi-line access to your workloads on Alibaba Cloud and to avoid service disruptions caused by single-line failures through multi-line disaster recovery.

Operation description

When you purchase ports, you can select one of the following three combination types to provide disaster recovery capabilities for your workloads.

Maximum disaster recovery: You apply for resources in two access points and establish four independent Express Connect circuit connections. The SLA availability for maximum disaster recovery is no less than 99.99%.
Enhanced disaster recovery: You apply for resources in two access points and establish two independent Express Connect circuit connections. The SLA availability for enhanced disaster recovery is no less than 99.95%.
Development and testing: You apply for resources in one access point and establish two independent Express Connect circuit connections.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the Express Connect circuit. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
ClientToken	string	No	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 RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-426655440000
ClientToken	string	No	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 Note 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-426655440000
ResourceGroupId	string	No	The ID of the resource group to which the Express Connect circuit belongs.	rg-acfmxazb4p****
Tag	array<object>	No	The tags.
	object	No	The 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 64 characters in length and must start with a letter or Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-). 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 and must start with a letter or Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua
HighReliableType	string	Yes	The zone-redundancy mode. Valid values: MultiApMultiDevice: maximum disaster recovery. This mode supports two different access points and two different devices, providing maximum disaster recovery. MultiApSingleDevice: enhanced disaster recovery. This mode supports two different access points and one device, providing enhanced disaster recovery. SingleApMultiDevice: development and testing. This mode supports one access point and two devices. This mode is recommended only for development and testing of non-critical workloads. SingleApMultiConnection: high-bandwidth load balancing. This mode is available only to users in the whitelist. It supports one access point, one device, and multiple physical ports. To use this mode, contact your account manager.	MultiApMultiDevice
PortType	string	Yes	The port type of the Express Connect circuit. Valid values: 1000Base-LX: GE single-mode optical port (10 km). 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 subject to the actual port availability. For information about port availability, contact your account manager.	1000Base-LX
DeviceAdvancedCapacity	array	No	The list of advanced device capabilities.
	string	No	The advanced device capability. Valid values: SubifRateLimit: VBR rate limiting. DualStack: IPv6 support. BFD: Bidirectional Forwarding Detection. CEN: multi-protocol BGP support. CENv6: multi-protocol BGPv6 support. QOS: QoS support. MS-HA: fast failover group support. Multi-MS-HA: multiple failover group support.	SubifRateLimit
ApList	array<object>	Yes	The list of access points.
	object	No	The list of access points.
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 Chinese character. It can contain digits, underscores (_), and hyphens (-), but cannot start with `http://` or `https://`.	test
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 Chinese character, but cannot start with `http://` or `https://`.	description
RegionId	string	Yes	The region ID of the Express Connect circuit. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
LineOperator	string	Yes	The connectivity provider of the Express Connect circuit. Valid values: CT: China Telecom. CU: China Unicom. CM: China Mobile. CO: other Chinese carriers. Equinix: Equinix. Other: other carriers outside the Chinese mainland.	CT
AccessPointId	string	Yes	The ID of the access point for the Express Connect circuit. Note When HighReliableType is set to MultiApMultiDevice or MultiApSingleDevice, you must specify two different access points. When HighReliableType is set to SingleApMultiDevice or SingleApMultiConnection, you must specify one access point.	ap-cn-beijing-ft-A
PortNum	integer	No	The number of ports. This parameter is required only when HighReliableType is set to SingleApMultiConnection. Valid values: 2 to 16.	2
Type	string	No	The type of the Express Connect circuit. Default value: VPC.	VPC
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 geographic location of the on-premises data center.	XX街道
CircuitCode	string	No	The circuit code provided by the connectivity provider for the Express Connect circuit.	longtel001
OpticalModuleModel	string	No	The optical module model supported by the access point of the Express Connect circuit. 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
DryRun	string	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without creating the instance. The system checks the required parameters, request format, and instance status. If the check fails, the error code `DRYRUN.FAIL` is returned along with the corresponding error list. If the check succeeds, the code `DRYRUN.SUCCESS` is returned. false (default): sends the request. After the request passes the check, the instance is created.	false
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN (default): Chinese. en-US: English.	zh-CN

Response elements

Element	Type	Description	Example
	object	The response parameters.
PhysicalConnectionList	object
physicalConnectionList	array<object>	The list of Express Connect circuit instances.
	object	The list of Express Connect circuit instances.
InstanceId	string	The ID of the Express Connect circuit.	pc-j5e5qqo616p81ncsp****
RegionNo	string	The region ID of the Express Connect circuit.	cn-shanghai
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
ErrorInfoList	object
errorInfoList	array<object>	The error codes and error messages returned when the dry run fails. All error information is returned, including: `pconn.high.reliable.dryrun.error.disable.outbound.data.transfer.billing`: Outbound data transfer billing is not enabled for the user. `pconn.high.reliable.dryrun.error.incompatable.device.capacity`: No device in the selected access point meets the advanced device capability requirements. `pconn.high.reliable.dryrun.error.quota.exceeded`: The user quota is insufficient. `pconn.high.reliable.dryrun.error.not.enough.resource`: The access point resources are insufficient.
	object	The error code.
ErrorCode	string	Error codes.	pconn.high.reliable.dryrun.error.disable.outbound.data.transfer.billing
ErrorMessage	string	The returned error message.	pconn.high.reliable.dryrun.error.disable.outbound.data.transfer.billing
InstanceId	string	The ID of the Express Connect circuit.	pc-j5e5qqo616p81ncsp****

Examples

Success response

JSON format

{
  "PhysicalConnectionList": {
    "physicalConnectionList": [
      {
        "InstanceId": "pc-j5e5qqo616p81ncsp****",
        "RegionNo": "cn-shanghai"
      }
    ]
  },
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "ErrorInfoList": {
    "errorInfoList": [
      {
        "ErrorCode": "pconn.high.reliable.dryrun.error.disable.outbound.data.transfer.billing",
        "ErrorMessage": "pconn.high.reliable.dryrun.error.disable.outbound.data.transfer.billing",
        "InstanceId": "pc-j5e5qqo616p81ncsp****"
      }
    ]
  }
}

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	EcNotSupportRegion	High reliable physical connection is not support in this region.	Highly reliable physical lines are temporarily not supported for sale in the local region.
400	EcFailToGetAp	Fail to get access point details.	Unable to query the corresponding access point information.
400	EcNotEnoughResource	Insufficient access point resources.	Insufficient Access Point Resources
400	IllegalParam.UnsupportedAccessPoint	The access point type does not support the creation of a highly reliable physical connection.	You cannot create a high-availability Express Connect circuit for an access point of this type.
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	IllegalParam.%s	The param of %s is illegal.	The parameter is invalid.
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.