All Products
Search

This Product

    Quick BI:GetDataSourceConnectionInfo

    Document Center

    Quick BI:GetDataSourceConnectionInfo

    Last Updated:Nov 04, 2025
    This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

    Get Data Source Information

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    quickbi-public:GetDataSourceConnectionInfoget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DsIdstringYes

    Data source ID.

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

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    Request ID.

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

    Data source information.

    Addressstring

    Database connection string address (domain or IP).

    		172.**.**.48
    AuthLevelstring

    Permission level:

    • 0 -- Private
    • 1 -- Collaborative Editing (old)
    • 11 -- Collaborative Editing - Space Members
    • 12 -- Collaborative Editing - Specified to Individuals
    		0
    CreatorIdstring

    Quick BI user ID of the creator.

    		U240****0880C6095
    DsIdstring

    Data source ID.

    		a201c85c-******
    DsTypestring

    Data source type.

    Enumeration Value:
    • 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
    DsVersionstring

    Version of the data source.

    		5.7
    Instancestring

    Database instance, corresponding to the database name, and for ODPS, it is the project.

    		rm*********t44ju1
    InstanceIdstring

    Instance ID.

    		rm*********t44ju1
    ModifyUserstring

    Quick BI user ID of the modifier.

    		U240****0880C6095
    NoSaslboolean

    Whether the impala data source requires authentication to log in:

    • true - Requires account and password login
    • false - No authentication required (default)
    		true
    ParentDsTypestring

    Primary data source type for multi-engine data sources.

    		dataphin
    Portstring

    Port.

    		3306
    Projectstring

    Used for front-end display when obtaining connection details for ODPS.

    		prod-ossdoc
    Schemastring

    Database schema, only needs to be set for databases that support schemas.

    		Analysis
    ShowNamestring

    Display name of the data source on the front end.

    		0327
    WorkspaceIdstring

    Workspace ID to which the data source belongs.

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

    Indicates whether the operation was successful.

    		true

    Examples

    Sample success responses

    JSONformat

    {
  "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 codeError codeError messageDescription
    297Invalid.ParameterThe length of the parameter must not exceed 1000.Parameter length exceeds maximum limit
    297Invalid.ParameterYou must specify the parameter.Invalid parameter
    400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.Your instance version or access key is not allowed to call the API operation, only professional version supports calling.
    500Internal.System.ErrorAn internal system error occurred.An internal system error occurred.
    500Instance.ExpiredYour instance has expired.Your instance has expired.
    500Instance.Not.ExistThe specified instance does not exist.The specified instance does not exist.
    500Invalid.OrganizationThe specified organizational unit does not exist.The specified organizational unit does not exist.
    500User.Not.In.OrganizationThe specified user is not in the organizational unit.The specified user is not in the organizational unit.
    500Invalid.Param.ErrorThe parameter is invalid.The parameter is invalid.
    500Invalid.ParameterAn error occurred while verifying parameters.An error occurred while verifying parameters.
    500Invalid.Parameter.ErrorThe parameter is invalid:%s.invalid parameter: ${0}.
    500Datasource.NotFound.ErrorThe specified data source does not exist: %s.The specified data source does not exist: %s.
    500Application.Object.NotExistThe object you are operating does not exist or has been deleted.-

    For a list of error codes, visit the Service error codes.