調用ListDataSources介面查詢資料來源列表-巨量資料開發治理平台 DataWorks-阿里雲

根據資料來源商務資訊，查詢符合的資料來源列表。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。
需要在 DataWorks 專案空間中具有如下至少一種角色：

租戶所有者、空間管理員、部署、開發、訪客、專案所有者、營運、模型設計師、安全性系統管理員、資料分析師、開發平台管理員、資料治理管理員

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:ListDataSources

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	是	DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間 ID。該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。	17820
Name	string	否	資料來源名稱，基於此名稱做模糊查詢。	test
Types	array	否	資料來源類型查詢過濾，可以配置多個類型查詢過濾。
	string	否	資料來源的類型。	mysql
EnvType	string	否	資料來源環境類型，枚舉值： Dev：開發環境 Prod：生產環境	Prod
PageNumber	integer	否	查詢第幾頁，預設值為 1 表示第一頁。	1
PageSize	integer	否	分頁大小，預設值為 10，最大值 100。	10
SortBy	string	否	資料來源列表排序欄位，支援名稱、建立時間、資料來源 ID 排序 CreateTime：建立時間 Id：資料來源 ID Name：資料來源名稱預設值：CreateTime	CreateTime
Order	string	否	資料來源列表排序方向，枚舉值： Desc：倒序 Asc：正序預設值：Desc	Desc
Tags	string	否	資料來源可以打標籤，基於標籤做資料來源查詢過濾：多個值之間是“且”的關係，比如`["tag1", "tag2", "tag3"]`底層查詢同時有這 3 個標籤打標的資料來源列表。不傳遞，或者傳遞為空白表示不作 tag 過濾，查詢最多支援 10 個標籤。	["tag1", "tag2", "tag3"]

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。用於定位日誌，排查問題。	7BE1433F-6D55-5D86-9344-CA6F7DD19B13
PagingInfo	object	分頁資訊。
TotalCount	integer	總條數。	131
PageSize	integer	頁大小。	10
PageNumber	integer	頁碼。	1
DataSources	array<object>	資料來源列表，每一個元素是一個資料來源組，包含開發環境（如有）和生產環境的資訊。
	array<object>	資料來源組資訊，包含開發環境（如有）和生產環境的資料來源。開發環境和生產環境的資料來源具有相同的資料來源名稱和資料來源類型，不相同的資料來源 ID。
Name	string	資料來源的名稱。	test
Type	string	資料來源類型。	mysql
DataSource	array<object>	資料來源列表，每個元素是單個資料來源資訊，具有唯一的資料來源 ID。
	object	單條資料來源資訊。
Id	integer	資料來源 ID，資料來源的唯一識別碼。	16035
ConnectionProperties	any	資料來源的具體串連配置資訊，包括串連地址、訪問身份、環境資訊等。資料來源環境 envType 資訊是此對象的成員屬性，包括 Dev（開發環境） Prod（生產環境）不同類型的資料來源在不同的配置模式（ConnectionPropertiesMode）下具有不同的屬性資訊規範，請參考資料來源串連資訊 ConnectionProperties	{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
ConnectionPropertiesMode	string	資料來源添加的類別，不同 type 下會有不同的子類型，對應有不同的參數約束，情境舉例： InstanceMode 執行個體模式。 UrlMode 串連串模式。	UrlMode
Description	string	資料來源的描述資訊。	test
CreateTime	integer	資料來源的建立時間（時間戳記）。	1648711113000
CreateUser	string	資料來源的建立者 ID。	1624387842781448
ModifyTime	integer	資料來源的最近修改時間（時間戳記）。	1648711113000
ModifyUser	string	資料來源的修改者 ID。	1624387842781448
QualifiedName	string	資料來源的業務唯一鍵，以 holo 舉例格式是`${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`。	1648711121000:cn-beijing:odps:yongxunQA_beijing_standard

樣本

正常返回樣本

JSON格式

{
  "RequestId": "7BE1433F-6D55-5D86-9344-CA6F7DD19B13",
  "PagingInfo": {
    "TotalCount": 131,
    "PageSize": 10,
    "PageNumber": 1,
    "DataSources": [
      {
        "Name": "test",
        "Type": "mysql",
        "DataSource": [
          {
            "Id": 16035,
            "ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n    \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n    \"database\": \"testdb\",\n    \"securityProtocol\": \"authTypeNone\",\n    \"authType\": \"Executor\",\n    \"authIdentity\": \"1107550004253538\"\n}",
            "ConnectionPropertiesMode": "UrlMode",
            "Description": "test ",
            "CreateTime": 1648711113000,
            "CreateUser": "1624387842781448",
            "ModifyTime": 1648711113000,
            "ModifyUser": "1624387842781448",
            "QualifiedName": "1648711121000:cn-beijing:odps:yongxunQA_beijing_standard"
          }
        ]
      }
    ]
  }
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。