查询指定空间下的所有数据源。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
quickbi-public:ListDataSource |
list |
*全部资源
|
无 | 无 |
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WorkspaceId |
string |
是 |
工作空间 ID。 |
95296e95-******c7d-8af9-dedf0ad0**** |
| DsType |
string |
否 |
数据源类型。 |
mysql |
数据源类型码值：
garuda -- garuda 数据源
adb -- ADB 3.0
oracle -- oracle 数据源
mysql -- mysql 数据源
mysql_hybrid -- HybridDB for MySQL 数据源
odps -- odps 数据源
sqlserver -- sqlserver 数据源
greenplum -- greenplum 数据源
postgresql -- postgresql 数据源
ppas -- RDS PPAS 数据源
oscar -- 神通数据源
hive -- Hive 数据源
vertica -- Vertica 数据源
db2 -- IBM DB2 数据源(LUW)
sybase -- SAP SYBASE IQ 数据源
hana -- SAP HANA 数据源
dla -- DataLake Analytics 数据源
oss -- OSS 数据源
drds -- DRDS 数据源
clivia -- super-engine
presto -- presto 数据源
polardb -- polardb 数据源
tsdb -- TSDB 数据源
lindorm_tsdb -- LindormTSDB 数据源
lindorm_wide_table_engine -- Lindorm 宽表引擎数据源
lindorm_multi_mode -- Lindorm 多模 SQL 数据源
hbase -- HBASE 数据源
phoenix_thin -- PHOENIX THIN 数据源
dataphin -- DataPhin 数据源-多引擎
dataphin_odps -- DataPhin 数据源 odps 引擎
dataphin_hive -- DataPhin 数据源 hive 引擎
dataphin_v2_odps -- 新 DataPhin 数据源 odps 引擎
dataphin_v2_hive -- 新 DataPhin 数据源 hive 引擎
kbase -- KingBase 数据源
clickhouse -- ClickHouse 数据源
tdsql -- TDSQL-H 数据源
gbase -- Gbase 数据源
polardb_pg -- Polardb for pg 数据源
hologres -- Hologres 数据源
impala -- impala 数据源
impala_v3 -- impala3.x 数据源
dingtalk -- 钉钉智能报表数据源
snowflake -- snowflake 数据源
kylin -- kylin 数据源
multiDatasource -- 跨源
oceanbase_mysql -- OceanBase_mysql 模式数据源
oceanbase_oracle -- OceanBase_Oracle 模式数据源
spark_sql -- Spark_SQL 数据源
starrocks -- StarRocks 数据源
apache_doris -- Apache_Doris 数据源
selectdb -- SelectDB 数据源
mongodb -- MongoDB 数据源
dm -- DM7 数据源-达梦
unicorn -- Unicorn 数据源
sls -- sls 数据源
gaussdb_dws -- GaussDB_DWS 数据源
gaussdb -- GaussDB 数据源
elasticsearch -- Elasticsearch
dms -- DMS 逻辑数仓
yida -- 宜搭应用数据源
relyt -- Relyt
feishu_bitable -- 飞书多维表格
feishu_spreadsheet -- 飞书电子表格
tidb -- TiDB 数据源
mariadb -- MariaDB 数据源
adb_spark -- adb 数据源 Spark 引擎
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
7FC9A6A6-****-5CED-B*****E891E4075 |
| Result |
array<object> |
数据源信息数组。 |
|
|
object |
数据源信息。 |
||
| CreatorId |
string |
创建人的 Quick BI 用户 ID。 |
281*****-485******-8 |
| CreatorName |
string |
所有者昵称。 |
system |
| DatasourceId |
string |
数据源 ID。 |
7FC9A6A6-****-5CED-B*****E891E4075 |
| GmtCreate |
string |
数据源创建时间，yyyy-MM-dd HH:mm:ss。 |
2024-04-16 13:17:39 |
| GmtModified |
string |
修改时间。 |
2024-08-15 10:06:31 |
| ShowName |
string |
数据源展示名称。 |
0327 |
| DsType |
string |
数据源类型。 |
odps |
| ParentDsType |
string |
多引擎数据源的主数据源类型。 |
dataphin |
| Success |
boolean |
请求是否成功。 |
true |
示例
正常返回示例
JSON格式
{
"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
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。