Request URL
{{adminHost:8181}}/portMapping/add
Request Method
| Field Name |
Sample |
Required |
Type |
Note |
| adminKey |
603284317954637824 |
Yes |
string |
This parameter is for backend management access credentials, which can be viewed in LarkXR3.3 backend access management |
| timestamp |
8641706679604867 |
Yes |
string |
The timestamp when sending a request, in milliseconds |
| signature |
9A02B47AE67664D80A2ED13FC2B1691512613790 |
Yes |
string |
This parameter is a key signature. Sort the adminKey (viewed in LarkXR3.2 backend access management), adminSecret (viewed in LarkXR3.3 backend access management), and current timestamp (long value) in alphabetical order, and then perform SHA-1 summary signature. Please refer to the example of [Obtaining Voucher Signature] |
Request Body Parameters
| Field Name |
Sample |
Required |
Type |
Note |
| internalHost |
192.168.0.55 |
Yes |
string |
Internal network address |
| internalPort |
10020 |
Yes |
string |
Internal network port |
| externalHost |
222.124.5.6 |
Yes |
string |
External network address |
| externalPort |
10030 |
Yes |
string |
External network port |
Success Response Example
{
"code": 1000,
"message": "Success"
}
Parameter Note for Success Response Example
| Field Name |
Type |
Note |
| code |
string |
None |
| message |
string |
None |