Guandata Open Platform
8.3.0
  • 8.3.0
  • 8.2.0
HomeWebsiteChinese version
Docs
  • Help Center
  • Guandata Academy
HomeWebsiteChinese version
Docs
  • Help Center
  • Guandata Academy
8.3.0
  • 8.3.0
  • 8.2.0
  1. Data Accounts
  • Users
    • Batch Create Users
      POST
    • Batch Delete Users
      POST
    • Batch Update User Attributes
      POST
    • Batch Check Users Exist
      POST
    • Get Users by Attribute Value
      POST
    • Get User List
      POST
    • Get User Information via loginId
      POST
    • Modify User Status
      POST
  • Developer Guide
    • Token Authentication
    • Common Concepts
  • Datasets
    • Clear Dataset Data
      GET
    • Update Dataset Using Parquet File
      GET
    • Get Dataset List
      POST
    • Modify Dataset Path
      POST
    • Delete Dataset
      POST
    • Search Dataset List
      POST
    • Query Dataset Schema
      POST
    • Batch Update Dataset Update Mode
      POST
    • Get Users with Access Permission for Dataset
      POST
    • Upload Dataset
      POST
    • Get Dataset Download Authorization Token
      GET
    • Download Dataset Data
      POST
    • Get Dataset Data
      POST
    • Create Dataset
      POST
    • Update Dataset Field Comments
      POST
    • Trigger Dataset to Read Data File and Update
      GET
    • Query Dataset Update Result by TaskID
      GET
    • Modify Dataset Schema
      POST
    • Update Dataset
      POST
    • Modify Dataset Field Alias
      POST
    • Modify Dataset Name
      POST
    • Dataset Preview
      POST
    • Modify SQL Model Structure
      POST
    • Get Dataset Folder List
      POST
    • Batch Query Dataset Basic Information
      POST
    • Batch Query Dataset Permissions
      POST
  • Dashboards
    • Get Dashboard/Page List
    • Search Pages by Name Keyword
    • Get Users with Read Permission for Page
    • Get Page List in Tree Structure
    • Export Dashboard as PDF or Image
    • Get Dashboard Export File
    • Get Page Basic Information
    • Get Page Information
    • Get Dashboard Smart Insights
  • Cards
    • Get Card Data
    • Create Card Based on Dataset (Random ID)
    • Get Card Insight Agent
  • Subscriptions and Alerts
    • Query Subscription List
    • Query Alert List
    • Query Notification Sending History
    • Download Custom Channel Push File
    • Enable/Disable Subscription
    • Enable/Disable Alert
  • Permissions
    • Get Pages Accessible by User
    • Get Datasets Accessible by User
    • Modify User Page Access and Ownership
    • Modify User Dataset Access and Ownership
    • Get Pages Accessible by User Group
    • Get Datasets Accessible by User Group
    • Modify User Group Page Access and Ownership
    • Modify User Group Dataset Access and Ownership
    • General Resource Permission Grant and Revoke
    • Grant Resource Permissions to User or User Group
    • Revoke Resource Permissions from User or User Group
  • Resource Operations
    • Migrate Resources with Owner Permission from Specified User
    • Migrate Resources with Owner Permission from User Group
    • Generic Resource List
  • Card Exports
    • Card Export API Guide
    • Public API Card Export
    • Public API Task Status Polling
    • Public API Card Export File Download
  • Sessions
    • Session Create or Update
    • Query Dataset Session Configuration
  • Folders
    • Create Folder
    • Modify Folder Directory
    • Delete Folder
    • Add Folder Permission
    • Delete Folder Permission
    • Batch Query Folder Permissions
  • Data Accounts
    • Create Data Account
      POST
  • Authentication
    • User Login
    • Login via loginId
    • User Logout
  • User Management
    • User Management Overview
    • User Groups
      • Batch Create User Groups
      • Batch Modify User Groups
      • Delete User Group
      • Get User Group List
      • Add Single User Group
      • Delete User Group V2
    • User Group Members
      • Add Users to User Group
      • Remove User from User Group
      • Get Direct Users Under User Group
      • Get Direct User Groups of User
    • Roles
      • Query Role Information for User
      • Add Custom Role for User
      • Unbind Custom Roles for User
    • User Linked Accounts
      • Linked Account Configuration Guide
      • Configure User External Associated Account
      • Delete User Associated Account
      • Query User External Linked Accounts
  • System Related
    • Get Monitoring Information
  • Metric Center
    • Get Metric Project
    • Get Folders Under Metric Project
    • Get Metrics Under Project and Folder
    • Get Metric Details
  • Lineage
    • Query Resource Lineage
    • Query Field Lineage
  • Insight Agent
    • Create Insight Agent Task
    • Query Conversation Details
  1. Data Accounts

Create Data Account

POST
/public-api/account/create

cnId Description#

Supports all connector types already supported by BI, including custom connectors
The following is only a partial list; if not included, contact product R&D
mysql, sqlserver, postgresql, gaussdb, greenplum, oracle, cirrodata, presto, redshift, maxcompute, hana, teradata, transwarp, doris, select_db, starrocks, ads, clickhouse, bilibili_clickhouse, vertica, netsuite, hive, hive_kerberos, db2, gbase, hawq, realtime, tidb, informix, kylin, bilibili_kylin, spark, impala, sybase, bilibili_druid, mongodb, druid, ftp, universe, sapbw, dli, trino, dameng, snowflake, olap_clickhouse, access

authConfig#

Most Data Account connection methods have 2 types with different parameters; JDBCURL is not yet supported by some databases, refer to BI page design for details
1.
Specify database, i.e., connectionType=DATABASE
2.
JDBC URL, i.e., connectionType=JDBCURL
Some databases have different parameters, such as Hive Kerberos Authentication, MaxCompute, etc. Contact product R&D to confirm parameters before using this parameter
Below are authConfig examples for some databases
Note: All password fields must be base64 encrypted
// connectionType=DATABASE
{
  "authConfig": {
    "connectionType": "DATABASE",
    host": "localhost",
    "user": "test",
    "password": "dGVzdA==",
    "database": "test",
    "port": "3306",
    "maxConnections": 10,
    "customDriverId": ""
  }
}

// connectionType=JDBCURL
{
  "authConfig": {
    "connectionType": "JDBCURL",
    "user": "user",
    "password": "cGFzc3dvcmQ=",
    "jdbcUrl": "jdbc:mysql://{host}:{port}/{database}",
    "maxConnections": 10,
    "customDriverId": ""
  }
}

// connectionType=DATABASE
{
  "authConfig": {
    "connectionType": "DATABASE",
    "host": "localhost",
    "database": "catlog",
    "schema": "schema",
    "user": "user",
    "port": "8080",
    "maxConnections": 10,
    "customDriverId": ""
  }
}
// connectionType=JDBCUR
{
  "authConfig": {
    "connectionType": "JDBCURL",
    "database": "catlog",
    "schema": "schema",
    "user": "user",
    "password": "",
    "jdbcUrl": "jdbc:trino://{host}:{port}/{catalog}/{schema}?param1=value1&param2=value2",
    "maxConnections": 10,
    "customDriverId": ""
  }
}
Special parameters:
● invisible, field type: Boolean
○ If true, the Data Account will not be displayed in the BI interface, and its Datasets cannot be edited or updated; Dataset creation can only be done via API
○ If false, equivalent to not passing, no effect

Request

Header Params

Body Params application/json

Example
{
    "cnId": "string",
    "name": "string",
    "uId": "string",
    "authConfig": {},
    "project": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/public-api/account/create' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cnId": "string",
    "name": "string",
    "uId": "string",
    "authConfig": {},
    "project": "string"
}'

Responses

🟢200Success
application/json
Body

Example
{
    "result": "ok",
    "response": {
        "acId": "b8f4d64cc650a4275937a291",
        "domId": "demo",
        "cnId": "mysql",
        "name": "sss",
        "uId": "b1766b1ac99bf4679a1bd762",
        "authConfig": {
            "connectionType": "DATABASE",
            "host": "localhost",
            "user": "test",
            "password": "dGVzdA==",
            "database": "test",
            "port": "3306",
            "useSSL": "false",
            "maxConnections": 10,
            "customDriverId": ""
        }
    }
}
Modified at 2026-07-14 14:06:48
Previous
Batch Query Folder Permissions
Next
User Login