全部产品
Search
文档中心

大数据开发治理平台 DataWorks:ListDataSources - 查询数据源列表

更新时间:Aug 28, 2026

该接口用于查询DataWorks的数据源列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

ProjectId

integer

是

数据源所在的 DataWorks 工作空间 ID。您可以通过 ListProjects 接口获取工作空间 ID。

1

Name

string

否

查询的数据源名称。

test

DataSourceType

string

否

数据源的类型。常用的类型如下:

  • odps

  • mysql

  • rds

  • oss

  • sqlserver

  • polardb

  • oracle

  • mongodb

  • emr

  • postgresql

  • analyticdb_for_mysql

  • hybriddb_for_postgresql

  • holo

rds

SubType

string

否

数据源的子类型。仅当 DataSourceType 参数配置为 RDS 时,该参数生效。

当 DataSourceType 参数配置为 RDS 时,该参数可以配置为 mysql、sqlserver 或 postgresql。

mysql

Status

string

否

数据源的状态。取值如下:

  • ENABLED,正常。

  • DISABLED,禁用。

ENABLED

EnvType

integer

否

数据源所属的环境,包括 0(开发环境)和 1(生产环境)。

1

PageSize

integer

否

每页显示的条数,默认为 10 条,最大为 100 条。

10

PageNumber

integer

否

分页查询的页码。取值为大于等于 1 的正整数。

1

返回参数

名称

类型

描述

示例值

object

返回结果。

HttpStatusCode

integer

请求返回码。

200

RequestId

string

请求 ID。

0bc14115159376359****

Success

boolean

请求是否成功。

true

Data

object

数据源的查询结果。

PageNumber

integer

页码。

1

PageSize

integer

每页显示的条数。

20

TotalCount

integer

数据源的总数。

233

DataSources

array<object>

数据源列表。

object

数据源详情。

Status

integer

数据源的状态。取值如下:

  • 1:表示数据源正常使用。

  • 2:表示数据源已禁用。

1

ProjectId

integer

数据源关联的工作空间 ID。

123

SubType

string

数据源的子类型。仅当 DataSourceType 参数配置为 RDS 时,该参数生效。

mysql

GmtModified

string

修改数据源的时间。时间格式示例为 Mar 17, 2021 4:09:32 PM。

Mar 17, 2021 4:09:32 PM

EnvType

integer

数据源所在的环境。取值如下:

  • 0:开发环境。

  • 1:生产环境。

1

ConnectStatus

integer

数据源的状态。取值如下:

  • 1:表示数据源正常使用。

  • 2:表示数据源已禁用。

1

Sequence

integer

排序字段。数据源按此字段从大到小排序。

300

Description

string

数据源的描述信息。

a connection

DataSourceType

string

数据源的类型。常用类型如下:

  • odps

  • mysql

  • rds

  • oss

  • sqlserver

  • polardb

  • oracle

  • mongodb

  • emr

  • postgresql

  • analyticdb_for_mysql

  • hybriddb_for_postgresql

  • holo

rds

GmtCreate

string

创建数据源的时间。时间格式示例为 Mar 17, 2021 4:09:32 PM。

Mar 17, 2021 4:09:32 PM

DefaultEngine

boolean

数据源关联的引擎是否为同类型数据源选用的默认引擎。

false

Shared

boolean

是否为共享的数据源。

false

Operator

string

最近一次修改数据源的阿里云用户 ID。

193543050****

Name

string

数据源的名称。

abc

Content

string

数据连接串的相关信息。格式为 JSON 格式。常用的数据源对应的连接串样例如下:

  • MaxCompute

    {
      "pubEndpoint": "http://service.cn.maxcompute.aliyun.com/api",
      "accessId": "xxxxxxx",
      "securityToken": null,
      "endpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",
      "accessKey": "***",
      "name": "PRE_PROJECT_A_engine",
      "project": "PRE_PROJECT_A",
      "vpcEndpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",
      "region": "cn-shanghai",
      "authType": "2"
    }
    

  • mysql

    {
      "configType": "1",
      "database": "mysql_d111b",
      "instanceName": "rm-xxxxxx",
      "password": "***",
      "rdsOwnerId": "12133xxxxxx",
      "tag": "rds",
      "username": "mysql_db111"
    }
    

  • sqlserver

    {
      "configType": "1",
      "jdbcUrl": "jdbc:sqlserver://rm-xxxxx.sqlserver.rds.aliyuncs.com:1433;DatabaseName=sqlserver_db1",
      "password": "***",
      "tag": "public",
      "username": "sqlserver_db111"
    }
    

  • oss

    {
      "accessId": "***********",
      "accessKey": "***********",
      "bucket": "bigxxx1223",
      "configType": "1",
      "endpoint": "http://oss-cn-hangzhou.aliyuncs.com",
      "tag": "public"
    }
    

  • postgresql

    {
      "configType": "1",
      "database": "cdp_xxx",
      "instanceName": "rm-xxxx",
      "password": "***",
      "rdsOwnerId": "121xxxxx",
      "tag": "rds",
      "username": "cdp_xxx"
    }
    

  • ads

    {
      "configType": "1",
      "password": "***",
      "schema": "ads_demo",
      "tag": "public",
      "url": "ads-xxx-xxxx.cn-hangzhou-1.ads.aliyuncs.com:3029",
      "username": "lslslsls"
    }
    

{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}

Id

integer

数据源 ID。

1

BindingCalcEngineId

integer

数据源关联的计算引擎 ID。

123

TenantId

integer

租户 ID。

1234567

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "0bc14115159376359****",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 233,
    "DataSources": [
      {
        "Status": 1,
        "ProjectId": 123,
        "SubType": "mysql",
        "GmtModified": "Mar 17, 2021 4:09:32 PM",
        "EnvType": 1,
        "ConnectStatus": 1,
        "Sequence": 300,
        "Description": "a connection",
        "DataSourceType": "rds",
        "GmtCreate": "Mar 17, 2021 4:09:32 PM",
        "DefaultEngine": false,
        "Shared": false,
        "Operator": "193543050****",
        "Name": "abc",
        "Content": "{\"pubEndpoint\":\"http://service.cn.maxcompute.aliyun.com/api\",\"accessId\":\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\",\"securityToken\":null,\"endpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"accessKey\":\"***\",\"name\":\"PRE_PROJECT_A_engine\",\"project\":\"PRE_PROJECT_A\",\"vpcEndpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"region\":\"cn-shanghai\",\"authType\":\"2\"}",
        "Id": 1,
        "BindingCalcEngineId": 123,
        "TenantId": 1234567
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 Invalid.Tenant.ConnectionNotExists The connection does not exist. 数据源不存在。
400 Invalid.Tenant.ProjectNotExists The project does not exist. 项目不存在。
400 Invalid.Tenant.UserNotInProject The user is not in the project. 用户不在项目中。
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. 用户不是项目负责人或者项目管理员。
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. 用户不在租户中。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。