3. Configure business traffic diversion policy to determine which traffic needs acceleration (socks mode integration not supported).
4. Configure flow-based multi-mode, with traffic segmentation routed to specific mode (selectable).
5. Start the acceleration process.
6. The SDK initiates a connection request to the MPGW.
7. MPGW returns a successful connection request.
8. The SDK and MPGW enter the normal communication stage.
9. Query SDK status (SDK synchronizes status with user).
10. Stop the acceleration process.
11. The SDK disconnects from the MPGW.
III. API Description
api Path
Description
/api/v2/client/mp-speeder
Configure acceleration parameters
/api/v2/client/mp-speeder/start
Start acceleration
/api/v2/client/mp-speeder/stop
Stop acceleration
/api/v2/client/mp-speeder/restart
Restart acceleration
/api/v2/client/mp-speeder
Query acceleration status
/api/v2/client/flowStatistics
Query acceleration traffic information
/api/v2/route/businessRoute
Configure traffic steering rules
/api/v2/client/multi-mode
Configure flow forwarding policy
/api/v2/diagnosis/log
Log Reporting
/api/v2/client/t2Statistics
Query drop-off point speed test information
Configure Acceleration Parameters
Before starting up the acceleration process, the manufacturer needs to collect the required parameters, which must be carried as parameters when launching the sdk acceleration.
required parameter
1. Activate one of the following parameters:
vendor and sn: vendor is the device vendor model, sn is the serial number provided by the device vendor.
dataKey: device license key.
appId and appSign: For app mode registration, obtain them from the console.
appId, appSign, and gwId: For eo mode registration, obtain them from the console.
scheduleMode: The default working mode is rtc.
Note:
There are four types of methods to activate the Cloud Connect feature, and vendors can select based on their own circumstances.
vendor+sn: Activate using the device serial number. The device to be activated must be created in the Tencent Cloud console in advance.
dataKey: Activate with a license key. Contact Tencent Cloud sales or business to obtain it.
appId+appSign: Activate with appId. Please retrieve from the cloud console.
appId+appSign+gwId: For eo mode usage, toggle on the enableEoSch switch simultaneously.
Call the following API to configure acceleration parameters (only configure parameters without starting acceleration):
datakey mode
curl -X POST "http://127.0.0.1:9801/api/v2/client/mp-speeder" ^
This API imports a Client entity, defined as follows:
Name
Type
Description
dataKey
string
Required: The device dataKey when one of the four activation modes mentioned above is selected.
vendor
string
Required: The device vendor model when one of the four activation modes mentioned above is selected.
sn
string
Required: The unique device serial number provided by the device vendor when one of the four activation modes mentioned above is selected.
appId
string
Optional: Used when the app mode + eo mode is selected from the four activation modes mentioned above. Fill in the corresponding zoneId in eo mode.
appSign
string
Optional: Used when the app mode + eo mode is selected from the four activation modes mentioned above.
enableEoSch
boolean
Optional: Must be true in eo mode.
gwId
string
Optional: Used in eo mode. Fill in the corresponding gatewayId.
lineType
[int]
Optional: Used when specified lines are enabled in eo mode.
0: Direct connection.
1:eo.
2: Third-party.
enableObfuscated
string
Optional: Whether to enable the IP address obfuscation feature.
encryptSign
string
Optional: Required when IP address obfuscation is enabled. Used for IP address encryption and decryption. Must match the sign used for IP address encryption on the client side. Using appSign is recommended. For the encryption algorithm, see the appendix.
scheduleMode
string
Optional: The default acceleration mode for Windows, "rtc".
accGateway
string
Optional: Specify the acceleration gateway IP address. Multiple IP addresses should be separated by commas. If this parameter is not specified, the sdk will automatically connect to the nearest gateway. Otherwise, it will forcibly connect to the specified acceleration gateway, for example: "120.30.39.129".
gwPort
string
Optional: The gateway port. Default: "443".
UUID
string
Optional: The hardware fingerprint. If this parameter is not specified, the sdk will automatically generate it based on the hardware.
disableCrypto
integer
Optional: Allows the customer to choose whether to enable encryption when acceleration is started. Traffic encryption is enabled by default. Disabling encryption can reduce traffic consumption.
0: Enable traffic encryption (default).
1: Disable traffic encryption.
flowStatisticsInterval
integer
Optional: The frequency for link acceleration traffic statistics. Default: 3 seconds.
maxRttDisableAggregation
integer
Optional: The maximum latency for link aggregation. Default: 460 ms.
maxRttThreshold
integer
Optional: The latency for initiating link failure detection. Default: 460 ms.
minSwitchRTT
integer
Optional: The sensitivity for fast link switching. Default: 20 ms.
maxDelayUntilFailed
integer
Optional: The maximum latency for link switching. Default: 460 ms.
registerEnv
integer
Optional: The cloud acceleration gateway cluster environment to which the SDK connects. (For testing only.)
0: Production environment (default).
1: Production environment (International site).
-2: Customer experience environment (POC test environment).
tunInterfaceName
string
Optional: The name of the tun interface. Default: mp_tun0.
t2Probe
boolean
Optional.
true: Enable t2 speed test.
false: Disable the t2 speed test.
authCode
string
Optional: Enabling traffic-free access.
accProcessName
string
Optional: The process name for the socks server. If you customize it, you must also rename the linkboost-core.exe file in the installation package accordingly, and the names must match.
Example: "multipath-core.exe".
Note:
RegisterEnv is optional, for use during testing. Not required for commercial equipment.
The above configuration requires restarting the acceleration process to make the configuration take effect.
Configuring a socks5 server
If you need to customize the speed-up socks5 server parameters, configure them via this API.
curl -X POST "http://127.0.0.1:9801/api/v2/client/socks5" ^
The binding address of the socks5 server is "127.0.0.1" and is non-configurable.
Name
Type
Description
enable
bool
Required: Whether to customize the socks5 server.
port
int
Required: socks5 server port.
userName
string
Required: socks5 server username.
passWord
string
Required: socks5 server password.
If you need to query the socks5 server configuration, use this API for the query.
curl -X GET "http://127.0.0.1:9801/api/v2/client/socks5" ^
-H "accept: application/json" ^
-H "Content-Type: application/json"
Starting Acceleration
Call the following APIs to start acceleration. Then the SDK will create a virtual interface named mp_tun0, and business traffic will be guided to this virtual interface for acceleration based on the traffic diversion policy. (Before calling this API, please ensure the acceleration parameters are configured.)
curl -X POST "http://127.0.0.1:9801/api/v2/client/mp-speeder/start" -H "accept: */*" -H "Content-Type: application/json"
Stop Acceleration
After stopping multiple networks, all traffic will not be accelerated, acceleration terminates, and the mp_tun0 interface is terminated.
curl -X POST "http://127.0.0.1:9801/api/v2/client/mp-speeder/stop" -H "accept: */*" -H "Content-Type: application/json"
Restarting Acceleration
Restart the acceleration process and reload the configuration.
This API is normally used to make the configuration take effect after modification.
curl -X POST "http://127.0.0.1:9801/api/v2/client/mp-speeder/restart" -H "accept: */*" -H "Content-Type: application/json"
Querying Acceleration Status
This interface will return a Status entity containing SDK status info.
curl -X GET "http://127.0.0.1:9801/api/v2/client/mp-speeder" -H "accept: */*" -H "Content-Type: application/json"
Status definition:
Name
Type
Description
ready
boolean
Whether the acceleration process is started normally.
UUID
string
The hardware fingerprint of the device.
dataKey
string
The device dataKey.
swVersion
string
The SDK software version.
accGateway
string
The IP address of the acceleration gateway.
gatewayPort
string
The port of the acceleration gateway.
interfaces
[string]
The list of interfaces participating in multi-link aggregation.
scheduleMode
string
The default acceleration mode. "bonding", "redundant", "rtc".
registerEnv
integer
The cloud acceleration gateway cluster environment to which the sdk connects.
0: Production environment (default).
1: Production environment (International site).
-2: Customer experience environment (POC test environment).
Querying Acceleration Traffic Information
This API will return a Statistics entity, containing cumulative accelerated traffic consumption based on the network interface card and real-time speed of the acceleration channel. The statistical information is periodically updated at 10-second intervals.
curl -X GET "http://127.0.0.1:9801/api/v2/client/flowStatistics" -H "accept: application/json" -H "all: true"
Statistics definition:
Name
Type
Description
interface
string
Name of the link NIC.
state
integer
Current link operational status:
-2: Link unavailable.
60: Link temporarily disabled.
100: Link normal.
totalReceivedBytes
integer
Cumulative accelerated traffic in the receive direction, in Bytes.
totalSendBytes
integer
Cumulative accelerated traffic in the send direction, in Bytes.
receivedRate
float
Receive rate of the current NIC acceleration channel, in bit/s.
sendRate
float
Send rate of the current NIC acceleration channel, in bit/s.
loss
float
Packet loss rate of the current NIC acceleration channel. The packet loss rate is expressed as a decimal, for example, 0.1 indicates a packet loss rate of 10%, and 1 indicates a packet loss rate of 100%.
rtt
integer
rtt of the current NIC acceleration channel, in ms.
Note: -1 indicates that the current link is unavailable.
Querying Drop-Off Point Speed Test Info
When specifying T2 acceleration and a drop-off point, you can use this api to query speed test info for the drop-off point.
Note:
Speed test for drop-off points is supported only when manually specifying a drop-off point. When using auto to automatically select a drop-off point, speed test for drop-off points is not supported.
Name
Type
Description
area
string
Name of the drop-off point.
rttAccelerated
int
Latency from the sdk to the drop-off point.
rttDirect
int
Latency for the sdk directly connecting to the drop-off point.
Traffic Diversion Policy Configuration
The traffic diversion policy mainly specifies which traffic needs to introduce SDK processing, based on the allowlist feature. socks mode integration requires no attention.
curl -X POST "http://127.0.0.1:9801/api/v2/route/businessRoute" ^
-H "accept: */*" ^
-H "all: false" ^
-H "whitelist: true" ^
-H "Content-Type: application/json" ^
-d "[{ \\"appId\\": \\"12345\\" }]"
Name
Type
Required
Description
ruleType
int
Yes
Traffic steering type, with the following values:
1: Five-tuple rule;
2: Route traffic based on domain.
3: Route traffic based on gameId.
protocol
string
No
Protocol type, with the following values:
TCP
UDP
srcIP
string
No
Source IP address.
srcPorts
string
No
Source Port.
dstIP
string
No
Destination IP address.
dstPorts
string
No
Destination Port.
gameId
string
No
Game ID.
domain
string
No
Domain name.
Configuring Forwarding Policy
The forwarding policy mainly specifies how traffic should be forwarded, based on the game ID.
curl -X POST "http://127.0.0.1:9801/api/v2/client/multi-mode" ^
35 - "T2 rtc": First performs rtc fast switching, then performs T2 full-path acceleration.
45 - (Reserved configuration).
Mobile Rights and Interests Authentication API
Mobile rights and interests authentication. If necessary, obtain through the API to avoid traffic consumption during acceleration.
curl -X POST "http://127.0.0.1:9801/api/v2/client/enableCMCCRightsVerify" ^
-H "accept: application/json" ^
-H "Content-Type: application/json" ^
-d "{\\"token\\": \\"xxxxx\\"}"
Request Parameters:
Name
Type
Description
token
string
Required: Used to verify the token.
guid
string
Required: Used to verify the guid, and must be used together with the token.
salt
string
Required: The salt value, used for encryption.
Response Parameters:
Name
Type
Description
status
bool
Required: Whether the token is authenticated successfully.
authCode
string
Optional: Returns the traffic-free authentication code if the verification succeeds.
error
string
Optional: Returns an error via the error field when the verification fails.
Log Reporting
Selectable log reporting for problem localization. Log reporting has two methods:
1. Manual reporting: Execute a command once to report the multi-network logs saved locally on the device to the backend.
2. Automatic reporting: After setting the reporting interval and turning on the switch, logs will be reported to the backend periodically. You can turn off the switch at any time to pause upload.
Note:
Local logs occupy up to 50MB storage space. Stored logs will be deleted after reporting.
Configure log reporting parameters.
curl -X POST "http://127.0.0.1:9801/api/v2/diagnosis/log" ^
