1. Interface Description
Interface request domain name: dc.api3.convergecloud.com.
API for Creating Dedicated Channel
Default interface request rate limit: 20 times per second.
Interface update time: 2025-08-22 01:15:19.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateDirectConnectTunnel |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-04-10 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| DirectConnectId | Yes | No | String | DC ID, for example, dc-kd7d06of. Example: dc-abcdefgh |
| DirectConnectTunnelName | Yes | No | String | Tunnel name Example: dc_name |
| DirectConnectOwnerAccount | No | No | String | Physical DC owner, which is the current customer (physical DC owner) by default. For a shared DC, the developer account ID of the shared DC needs to be entered here. Example: 110000000163 |
| VpcName | Yes | No | String | VPC Unified ID or CPM Network Unified ID Example: vpc-r8ztdfrd |
| DirectConnectGatewayId | Yes | No | String | DC gateway ID, for example, dcg-d545ddf. Example: dcg-abcdefgh |
| Bandwidth | Yes | No | Int64 | DC Bandwidth, unit: Mbps Default is the bandwidth value of the physical DC. Example: 100 |
| RouteType | Yes | No | String | BGP: BGP routing STATIC: Static routing Default is BGP routing. Example: BGP |
| BgpPeer | No | No | BgpPeer | BgpPeer, user-side BGP information, including ASN and AuthKey. Example:View |
| IdcRoutes | No | No | String | Static Routing, User IDC Subnet Address Example: 10.0.0.0/16 |
| Vlan | Yes | No | Int64 | VLAN, in a range of 11-4000, needing to match VLAN ID of the user side. Example: 100 |
| CloudAddress | Yes | No | String | Cloud-Side Interconnect IP Example: 10.10.10.10 |
| CustomerAddress | Yes | No | String | CustomerAddress, user-side interconnect IP. Example: 192.168.1.1/30 |
| RelatedDirectConnectTunnelId | No | No | String | Associated Redundancy Channel ID Example: dcx-2j1x1udk |
| LoadMode | Yes | No | String | Channel CLB modes: None: Non-redundancy mode LoadBalance: CLB MasterSlave: Primary and secondary Example: LoadBalance |
| VpcId | Yes | No | Int64 | VPC Digital ID Example: 65535 |
| EnableBfd | Yes | No | Bool | Whether to Enable BFD Example: True |
| BfdInterval | No | No | Int64 | BFD Protocol Interval Configuration Example: 100 |
| ConnectSubnetMask | Yes | No | Uint64 | Interconnection Address Mask Example: 16 |
| NetworkRegion | Yes | No | String | Region Where VPC Locates Example: ap-test |
| IpType | No | No | String | Channel IP Protocol Type Example: v4 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| DirectConnectTunnelIdSet | Array of String | Dedicated Channel ID Example: ["dcx-abcdefgh"] |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| MissingParameter | Parameter missing |
| InternalError | Internal error |
| InvalidParameter | Wrong parameter. |
| InvalidParameterValue | Incorrect parameter value |
| InvalidParameterValue.VlanConfLict | VLAN Conflict |
| LimitExceeded.DirectConnectTunnelLimitExceeded | Number of dedicated channels for the physical DC has reached a limit. |
| InvalidParameter.UinIsNotExist | This account ID does not exist. |
| LimitExceeded | Exceeded quota limit |
| ResourceUnavailable.InsufficientBalance | Sorry, your account is overdue. Products cannot be activated in an overdue status. Please recharge first. |
| UnsupportedOperation | Operation unsupported. |
| InvalidParameter.AddressError | Interconnect IP Error |
| ResourceInUse.DcVpcIsExist | The VPC for the physical DC already exists. |
| UnsupportedOperation.CrossBorderDirectConnectTunnel | Creating cross-border dedicated channels is not allowed. Please contact us. |
| InvalidParameter.DirectConnectIdIsNotUin | The physical DC does not belong to this account. |
| LimitExceeded.DirectConnectLimitExceeded | Number of physical DCs has reached a limit. |
| InvalidParameter.DcxBandwidthOutOfRange | Physical DC bandwidth is out of range. Private channel bandwidth is required to be greater than 1, and not greater than the physical DC bandwidth, and a sum of private channel bandwidths is not greater than the physical DC bandwidth in a non-overselling mode. |
| InvalidParameter.ArAvailBandwidthNotEnough | The available bandwidth is insufficient at the DC access point. |