調用TestDataSourceConnectivity API測試資料來源連通性-巨量資料開發治理平台 DataWorks-阿里雲

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用。
需要在 DataWorks 專案空間中具有如下至少一種角色：租戶所有者、空間管理員、部署、開發、專案所有者、營運

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:TestDataSourceConnectivity

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ResourceGroupId	string	是	資源群組 ID，即資源群組的唯一識別碼。	Serverless_res_group_524257424564736_6831777003XXXXX
DataSourceId	integer	是	待測試連通性的資料來源 ID，資料來源 ID 是資料來源的唯一識別碼。	144544
ProjectId	integer	是	DataWorks 專案空間 ID。	10001

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID，一次請求的唯一標識。	4CDF7B72-020B-542A-8465-21CFFA81****
Connectivity	object	連通性詳情
ConnectState	string	測試後的連通性狀態。枚舉值： ● Connectable：可連通 ● ConfigError：網路可通，但是配置有誤 ● Unreachable：不可連通 ● Unsupport：其他不支援的情境，例如資源群組處於初始化中	Connectable
ConnectMessage	string	連通性測試失敗時，具體的描述資訊。連通性測試成功時，無該資訊。	串連資料庫失敗
DetailLogs	array<object>	測試連通性各個階段的詳細日誌
	object
StartTime	integer	表示該步驟的起始時間	1730217600001
EndTime	integer	表示該步驟的終止時間	1730217604002
Code	string	測試項代碼	validate_input_parameters
Message	string	測試步驟名稱	校正輸入參數

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4CDF7B72-020B-542A-8465-21CFFA81****",
  "Connectivity": {
    "ConnectState": "Connectable",
    "ConnectMessage": "串連資料庫失敗",
    "DetailLogs": [
      {
        "StartTime": 1730217600001,
        "EndTime": 1730217604002,
        "Code": "validate_input_parameters",
        "Message": "校正輸入參數"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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