All Products
Search

This Product

    Quick BI:GetDataSourceConnectionInfo

    Document Center

    Quick BI:GetDataSourceConnectionInfo

    Last Updated:Aug 27, 2026

    Retrieves the connection information of a specified data source, including the address, port, type, and instance details.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    quickbi-public:GetDataSourceConnectionInfo

    get

    *All Resource

    *

    		 None None

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DsId

    string

    Yes

    Data source ID.

    7AAB95D-*****-****-*4FC0C976

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    Request ID.

    7AAB95D-*****-****-*4FC0C976
    Result

    object

    Data source information.

    Address

    string

    Database connection string address (domain or IP).

    172.**.**.48
    AuthLevel

    string

    Permission level:

    • 0 -- Private

    • 1 -- Collaborative Editing (old)

    • 11 -- Collaborative Editing - Space Members

    • 12 -- Collaborative Editing - Specified to Individuals

    0
    CreatorId

    string

    Quick BI user ID of the creator.

    U240****0880C6095
    DsId

    string

    Data source ID.

    a201c85c-******
    DsType

    string

    Data source type.

    Valid values:

    • hive :

      Hive Data Source

    • vertica :

      Vertica Data Source

    • ppas :

      RDS PPAS Data Source

    • dm :

      DM7 Data Source-Dameng

    • tsdb :

      TSDB Data Source

    • tdsql :

      TDSQL-H Data Source

    • mysql_hybrid :

      HybridDB for MySQL Data Source

    • sqlserver :

      sqlserver Data Source

    • postgresql :

      postgresql Data Source

    • garuda :

      garuda Data Source

    • adb_spark :

      adb Data Source Spark Engine

    • greenplum :

      greenplum Data Source

    • phoenix_thin :

      PHOENIX THIN Data Source

    • dla :

      DataLake Analytics Data Source

    • starrocks :

      StarRocks Data Source

    • mysql :

      mysql Data Source

    • hana :

      SAP HANA Data Source

    • mongodb :

      MongoDB Data Source

    • adb :

      ADB

    • hbase :

      HBASE Data Source

    • oscar :

      Sheng Tong Data Source

    • gbase :

      Gbase Data Source

    • oracle :

      oracle Data Source

    • sybase :

      SAP SYBASE IQ Data Source

    • dataphin :

      DataPhin Data Source-Multi-engine

    • odps :

      odps Data Source

    • db2 :

      IBM DB2 Data Source(LUW)

    • yida :

      yida Application Data Source

    • clickhouse :

      ClickHouse Data Source

    • oceanbase_oracle :

      OceanBase_Oracle Data Source

    • presto :

      presto Data Source

    • polardb :

      polardb Data Source

    • dataphin_odps :

      DataPhin Data Source odps Engine

    • selectdb :

      SelectDB Data Source

    mysql
    DsVersion

    string

    Version of the data source.

    5.7
    Instance

    string

    Database instance name. For ODPS data sources, this corresponds to the project name.

    rm*********t44ju1
    InstanceId

    string

    Instance ID.

    rm*********t44ju1
    ModifyUser

    string

    Quick BI user ID of the modifier.

    U240****0880C6095
    NoSasl

    boolean

    Whether the Impala data source requires authentication:

    • true - Requires account and password login

    • false - No authentication required (default)

    true
    ParentDsType

    string

    Primary data source type for multi-engine data sources.

    dataphin
    Port

    string

    Port.

    3306
    Project

    string

    Project name displayed in the console for ODPS data sources.

    prod-ossdoc
    Schema

    string

    Database schema. Required only for databases that support schemas.

    Analysis
    ShowName

    string

    Display name of the data source in the console.

    0327
    WorkspaceId

    string

    Workspace ID of the data source.

    0de6**2-d**-4720-8836-0cc****1394c
    Success

    boolean

    Whether the request was successful.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "7AAB95D-*****-****-*4FC0C976",
  "Result": {
    "Address": "172.**.**.48",
    "AuthLevel": "0",
    "CreatorId": "U240****0880C6095",
    "DsId": "a201c85c-******",
    "DsType": "mysql",
    "DsVersion": "5.7",
    "Instance": "rm*********t44ju1",
    "InstanceId": "rm*********t44ju1",
    "ModifyUser": "U240****0880C6095",
    "NoSasl": true,
    "ParentDsType": "dataphin",
    "Port": "3306",
    "Project": "prod-ossdoc",
    "Schema": "Analysis",
    "ShowName": "0327",
    "WorkspaceId": "0de6**2-d**-4720-8836-0cc****1394c"
  },
  "Success": true
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Invalid.Parameter The length of the parameter must not exceed 1000.
    400 Access.Forbidden Your instance version or access key is not allowed to call the API operation, only professional version supports calling.
    400 Internal.System.Error An internal system error occurred.
    400 Instance.Expired Your instance has expired.
    400 Instance.Not.Exist The specified instance does not exist.
    400 Invalid.Organization The specified organizational unit does not exist.
    400 User.Not.In.Organization The specified user is not in the organizational unit.
    400 Invalid.Param.Error The parameter is invalid.
    400 Invalid.Parameter.Error The parameter is invalid:%s.
    400 Datasource.NotFound.Error The specified data source does not exist: %s.
    400 Application.Object.NotExist The object you are operating does not exist or has been deleted.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.