Retrieve Workspace Data Sources via ListDataSource API - Quick BI - Alibaba Cloud - Quick BI

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:ListDataSource

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	Workspace ID.	95296e95-****c7d-8af9-dedf0ad0**
DsType	string	No	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 elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	7FC9A6A6-**-5CED-B***E891E4075
Result	array<object>	The list of data sources.
	object	Data source information.
CreatorId	string	Quick BI user ID of the creator.	281***-485****-8
CreatorName	string	The nickname of the data source creator.	system
DatasourceId	string	Data source ID.	7FC9A6A6-**-5CED-B***E891E4075
GmtCreate	string	The time when the data source was created, in yyyy-MM-dd HH:mm:ss format.	2024-04-16 13:17:39
GmtModified	string	The time when the data source was last modified.	2024-08-15 10:06:31
ShowName	string	Display name of the data source.	0327
DsType	string	Data source type.	odps
ParentDsType	string	The primary data source type. This parameter applies to multi-engine data sources.	dataphin
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "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 code	Error code	Error message
400	Invalid.Workspace	The workspace is not owned by the organization.
400	Workspace.Operation.LackRole	Only the %s role can perform this operation. Contact the administrator to add this role.
400	Internal.System.Error	An internal system error occurred.
400	Invalid.Param.Error	The parameter is invalid.
400	Invalid.Parameter	An error occurred while verifying parameters.
400	Invalid.Parameter.Error	The parameter is invalid:%s.
400	Parameter.Length.Exceed	Parameter length exceeds maximum limit: [%s].
400	Parameter.Error	The input parameter is invalid.
400	User.Not.In.Organization	The specified user is not in the organizational unit.
400	Invalid.User.Admin	You are not an administrator of this organization.
400	Invalid.Organization	The specified organizational unit does not exist.
400	Invalid.User.Organization	The user is not in your organization.
400	System.Param.Empty	You must specify the %s parameter.
400	Workspace.Not.Exist	The group workspace does not exist.
400	User.NotIn.Workspace	The user is not in this workspace.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.