全部產品
Search
文件中心

DataWorks:ListDataSources - 查詢資料來源列表

更新時間:Mar 21, 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

最近一次修改資料來源的阿里雲使用者識別碼。

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. 使用者不在租戶中。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情