This document provides an overview of the overall process for OpenAPI invocation, interface call limitations, and common error codes, with a focus on the required token application and usage methods for OpenAPI invocation.

1. A clientId and clientSecret are generated for each OpenAPI caller; these serve as credentials for invoking the interface.
2. The user uses the clientId and clientSecret to call the interface and exchange for a JWT token containing user identity information.
3. When invoking business interfaces, the user must include the JWT token in the request header, for example: Authorization: Bearer jwt_token.
4. When an interface is called, DataWind uses a public key to verify the JWT token and performs rate limiting and auditing.
5. When invoking any DataWind interface, to facilitate troubleshooting, it is recommended to add both the 'x-request-id' and 'request-id' headers (ensure each is a unique string). Two headers are needed because DataWind consists of multiple components, and different components may use different identifiers. These two parameters will be recorded in DataWind's backend logs, providing strong support for analysis and troubleshooting when issues arise, thereby enabling more efficient resolution of potential faults.
6. Return business results.

The overall process is as follows:

Obtain clientId and clientSecret #

Go to "Open Platform" -> "Developer Console", click "Create Credential" to apply for clientId and clientSecret. There are two types of credentials: user and system (system is only supported for system administrators). As shown below:

Obtain jwtToken #

Request description #

Request URL: The interface URL used for invocation varies by environment.

• For private deployment environments, the interface URL prefix is the same as the private environment access address.
• For the Volcano Engine SaaS environment, if the access address is https://console.volcengine.com/bi/datawind, then the interface URL prefix is https://console.volcengine.com/bi/datawind/aeolus.

Request example #

curl --location --request POST 'https://console.volcengine.com/bi/datawind/aeolus/api/v3/openapi/jwtToken' \
--header 'Content-Type: application/json' \
--data-raw '{
  "metadata": {
    "clientId": "{clientId}",
    "clientSecret": "{clientSecret}",
    "proxyUser": "abc****@21**********",
    "expire": 3600
  }
}'

Request parameters #

Response parameters #

Response example #

{
    "code": "aeolus/ok",
    "data": {
        "jwtToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey*****************************************************************************************************************************************************************************.********************-*************************************************************************************-****************************************************************************************************************************-***-********************************************-******************************************************-*************************-****************************************************************************-************-*************************************-*********************************************************************************************************************************************************-****************-******************5sus",
        "proxyUser": "user_1"
    },
    "msg": "成功"
}

When invoking an interface, the user must include the content of the jwtToken in the request header, for example: Authorization: Bearer jwt_token
The following is an example of invoking the current user interface using curl:

curl -X GET 'https://{domain}/aeolus/api/v3/open/misc/current_user' \
-H 'Authorization: Bearer jwt_token'

To ensure service stability and prevent malicious attacks, the DataWind backend uses the following methods to limit requests:
(1) Rate limiting (the current external service capacity of the interface has reached a high level; if it still does not meet your needs, you can contact the Volcano Engine technical support team to request modifications);
(2) Blocking, used to reserve certain APIs that are not open or to temporarily block abnormal user requests;
(3) Auditing, every OpenAPI call will be recorded, including the caller, interface, parameters, and call time.

For details, see Common Error codes.