調用GetDataSourceMeta API擷取目標資料來源的Meta資訊-巨量資料開發治理平台 DataWorks-阿里雲

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	是	DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間 ID。	10000
DatasourceName	string	是	目標資料來源的名稱。	mysql_name
PageNumber	integer	否	請求的資料頁數，用於翻頁。	1
PageSize	integer	否	每頁顯示的資料條數。	10
EnvType	string	否	目標資料來源所屬的環境。取值如下： 0：開發環境。 1：生產環境。	1

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
Success	boolean	請求是否成功。取值如下： true：成功。 false：失敗。	true
RequestId	string	本次調用的唯一 ID。用於出現錯誤後定位日誌，排查問題。	0000-ABCD-EFG
Data	object	擷取目標資料來源 Meta 資訊的返回的結果。
Status	string	擷取目標資料來源 Meta 資訊的結果狀態。取值如下： success：表示擷取目標資料來源的 Meta 資訊成功。 fail：表示擷取目標資料來源的 Meta 資訊失敗。您可以查看 Message 參數定位失敗原因。	success
Message	string	擷取目標資料來源 Meta 資訊失敗後的原因描述。如果擷取目標資料來源的 Meta 資訊成功，則該參數的傳回值為空白。	read datasource time out
Meta	string	返回的目標資料來源的 Meta 資訊。返回的資訊為 JSON 格式。 `{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}` 參數描述如下： dbName：資料來源所在的資料庫名稱。 schema：資料庫所屬的模式。 enable：資料庫是否可用，包含 true（表示資料庫可用），false（表示資料庫不可用）取值。 tableName：資料庫包含的表名稱。 tableInfos：資料庫中表的資訊。	{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "RequestId": "0000-ABCD-EFG\t",
  "Data": {
    "Status": "success",
    "Message": "read datasource time out",
    "Meta": "{\"dbTables\":[{\"dbName\":\"testdb\",\"schema\":[{\"tableInfos\":[{\"dbName\":\"testdb\",\"enable\":true,\"table\":\"table1\",\"tableName\":\"table1\"}]},{\"tableInfos\":[{\"dbName\":\"testdb\",\"enable\":true,\"table\":\"table2\",\"tableName\":\"table2\"}]}]}]}"
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Invalid.DI.Parameter	The parameter is invalid.	參數錯誤
500	InternalError.DI.Parameter	A DI internal error occurred.	Data Integration內部業務錯誤
403	Forbidden.DI.NoPrivilege	No access.	沒有許可權訪問

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

變更歷史

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