Public request and return value
Request description
The tenantId, workspaceId and appId parameters are required in public requests.
If the request method is POST, these three parameters are required in the queryString, while not required in the request body of the POST request.
When passing parameters using the POST method, if there is no description in the parameter passing method of the corresponding interface, the default content-type is multipart/form-data.
Name | Type | Description |
tenantId | String | Tenant ID |
workspaceId | String | workspaceId |
appId | String | Application ID |
Return value description
The return value is in JSON format.
{
"data":{
"data":"data",
"errorCode":null,
"requestId":"",
"resultMsg":"",
"success":true
},
"requestId":""
}
The success
parameter indicates whether the request processing result is success or failure.
If it is
true
, the request is successful, and you can obtain the return data from thedata
parameter.If it is
false
, it means the request processing failed, and you can get the returned error information fromresultMsg
.
In other documents, the return values listed are the data in the data parameter. The complete return value structure will not be displayed again.
Interface signature
The open API interface requires that all requested URLs carry four URLPARAMETERs.
appId
workspaceId
timestamp (represents the time when this signature was generated in seconds)
sign (signature generated using RSA 2048 private key)
The content of
sign
is the result string of signing the following string, and the signature value is converted to a hexadecimal string (hex)appId=<user's APPID>&workspaceId=<user's workspaceId>×tamp=<request timestamp>&url=<request URL without parameters>
Complete URL example
http://11.167.24.43:8281/openapi/nebula/getNebulaResourceList?appId=4B7AAC1231527&sign=53df44dc861099d276710c1233261ea42d5553b5f38714c8688134c72f8d0b34a9e3de7ef4b13cc5ed1e241bb9416934737faf0ae915301660a968f476722eaa945437178dd8abc39912e6d6573d809be389d212350b6b18b87277ae05abe5e41aa270cf2966c86048025c317070449afb022aeb963d5209d8cbbd3df0b3522d509a28651e1b16490eb87b565e6abb974535c0d6f894e372283b910b1e372b458e82f9b53ce5443a9f0eba6830cf271904ecc5b44cff8f8cad2d3a0e869019dc668b70baebc6d7bda8f1f739b8dc9aacf9bb84caf0f12aa5c5adacfa35814872582c681e5f9b9e0445cd82860f3489d1474130c6882662ea295b1196c228ab48×tamp=1558937883&workspaceId=sit
Rsa key generation method
Key pair generation method:
1. Generate a 2048-bit RSA private key
openssl genrsa -out private_key.pem 2048
2. Convert the private key to PKCS#8 format
openssl pkcs8 -topk8 -inform PEM -outform DER -in private_key.pem -out private_key.der -nocrypt
3. Change the public key format to DER
openssl rsa -in private_key.pem -pubout -outform DER -out public_key.der
4. Convert both public and private keys to base64 format
openssl base64 -in private_key.der -out private_key_base64.der
openssl base64 -in public_key.der -out public_key_base64.der
5. View public key content
cat public_key_base64.der
6. View private key content
cat private_key_base64.der
After the key is generated, upload the public key to mappcenter through this page for signature verification.