All Products
Search
Document Center

Quick BI:ListDataSource

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.

Query all data sources under the specified space

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:ListDataSourcelist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
WorkspaceIdstringYes

Workspace ID.

95296e95-******c7d-8af9-dedf0ad0****
DsTypestringNo

Data source type.

mysql

Data source type codes:

  • garuda -- garuda data source
  • adb -- ADB 3.0
  • oracle -- Oracle data source
  • mysql -- MySQL data source
  • mysql_hybrid -- HybridDB for MySQL data source
  • odps -- ODPS data source
  • sqlserver -- SQL Server data source
  • greenplum -- Greenplum data source
  • postgresql -- PostgreSQL data source
  • ppas -- RDS PPAS data source
  • oscar -- Shentong data source
  • hive -- Hive data source
  • vertica -- Vertica data source
  • db2 -- IBM DB2 data source (LUW)
  • sybase -- SAP SYBASE IQ data source
  • hana -- SAP HANA data source
  • dla -- DataLake Analytics data source
  • oss -- OSS data source
  • drds -- DRDS data source
  • clivia -- super-engine
  • presto -- Presto data source
  • polardb -- PolarDB data source
  • tsdb -- TSDB data source
  • lindorm_tsdb -- LindormTSDB data source
  • lindorm_wide_table_engine -- Lindorm wide table engine data source
  • lindorm_multi_mode -- Lindorm multi-mode SQL data source
  • hbase -- HBase data source
  • phoenix_thin -- PHOENIX THIN data source
  • dataphin -- DataPhin data source multi-engine
  • dataphin_odps -- DataPhin data source ODPS engine
  • dataphin_hive -- DataPhin data source Hive engine
  • dataphin_v2_odps -- New DataPhin data source ODPS engine
  • dataphin_v2_hive -- New DataPhin data source Hive engine
  • kbase -- KingBase data source
  • clickhouse -- ClickHouse data source
  • tdsql -- TDSQL-H data source
  • gbase -- Gbase data source
  • polardb_pg -- Polardb for PG data source
  • hologres -- Hologres data source
  • impala -- Impala data source
  • impala_v3 -- Impala 3.x data source
  • dingtalk -- DingTalk smart report data source
  • snowflake -- Snowflake data source
  • kylin -- Kylin data source
  • multiDatasource -- Cross-source
  • oceanbase_mysql -- OceanBase MySQL mode data source
  • oceanbase_oracle -- OceanBase Oracle mode data source
  • spark_sql -- Spark SQL data source
  • starrocks -- StarRocks data source
  • apache_doris -- Apache Doris data source
  • selectdb -- SelectDB data source
  • mongodb -- MongoDB data source
  • dm -- DM7 data source
  • Dameng - unicorn -- Unicorn data source
  • sls -- SLS data source
  • gaussdb_dws -- GaussDB DWS data source
  • gaussdb -- GaussDB data source
  • elasticsearch -- Elasticsearch
  • dms -- DMS logical data warehouse
  • yida -- Yida application data source
  • relyt -- Relyt
  • Lark_bitable -- Lark bitable
  • Lark_spreadsheet -- Lark spreadsheet
  • tidb -- TiDB data source
  • mariadb -- MariaDB data source
  • adb_spark -- ADB data source Spark engine

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

7FC9A6A6-****-5CED-B*****E891E4075
Resultarray<object>

Array of data source information.

Dataobject

Data source information.

CreatorIdstring

Quick BI user ID of the creator.

281*****-485******-8
CreatorNamestring

Owner's nickname.

system
DatasourceIdstring

Data source ID.

7FC9A6A6-****-5CED-B*****E891E4075
GmtCreatestring

Creation time of the data source, in yyyy-MM-dd HH:mm:ss format.

2024-04-16 13:17:39
GmtModifiedstring

Modification time.

2024-08-15 10:06:31
ShowNamestring

Display name of the data source.

0327
DsTypestring

Data source type.

odps
ParentDsTypestring

Primary data source type for multi-engine data sources.

dataphin
Successboolean

Whether the request was successful.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "7FC9A6A6-****-5CED-B*****E891E4075",
  "Result": [
    {
      "CreatorId": "281*****-485******-8",
      "CreatorName": "system",
      "DatasourceId": "7FC9A6A6-****-5CED-B*****E891E4075",
      "GmtCreate": "2024-04-16 13:17:39",
      "GmtModified": "2024-08-15 10:06:31",
      "ShowName": "0327",
      "DsType": "odps",
      "ParentDsType": "dataphin"
    }
  ],
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.WorkspaceThe workspace is not owned by the organization.-
400Workspace.Operation.LackRoleOnly the %s role can perform this operation. Contact the administrator to add this role.Only the %s role can perform this operation. Contact the administrator to add this role.
500Internal.System.ErrorAn internal system error occurred.An internal system error occurred.
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}.
500Parameter.Length.ExceedParameter length exceeds maximum limit: [%s].-
500Parameter.ErrorThe input parameter is invalid.input parameter error.
500User.Not.In.OrganizationThe specified user is not in the organizational unit.The specified user is not in the organizational unit.
500Invalid.User.AdminYou are not an administrator of this organization.Only organization administrators can perform this operation.
500Invalid.OrganizationThe specified organizational unit does not exist.The specified organizational unit does not exist.
500Invalid.User.OrganizationThe user is not in your organization.The user is not in your organization.
500System.Param.EmptyYou must specify the %s parameter.You must specify the %s parameter.
500Workspace.Not.ExistThe group workspace does not exist.The group workspace does not exist.

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