GetCrawlerTypeCapabilities - DataWorks

查詢目前地域支援建立的採集器類型及其採集範圍、排程和擴充設定能力。

介面說明

使用場景

查詢目前地域支援建立的採集器類型，以及各類型支援的資料來源、採集範圍、資源群組、排程、AI 中繼資料描述和擴充設定能力。

版本要求

需要購買 DataWorks 基礎版及以上版本才能使用。

注意事項

不同地域和採集器類型的能力可能不同，請以本介面的實際傳回結果為準。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求文法

GET  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

本介面無需業務請求參數。

返回參數

名稱	類型	描述	樣本值
	object	傳回結果。
RequestId	string	請求 ID。用於定位日誌，排查問題。	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	請求是否成功。
CrawlerTypes	array<object>	目前地域支援建立的採集器類型及能力清單。
	array<object>	單一採集器類型的能力資訊。
Type	string	採集器類型。	holo
DisplayName	string	顯示名稱。	Hologres
SupportedEntityTypes	array<object>	該採集器類型支援採集的中繼資料實體層級。
	object	單一中繼資料實體層級。
Type	string		holo
SubType	string		database
Optional	boolean
ParentSubType	string		instance
SupportedScopeUnits	array	支援的採集範圍粒度清單。
	string	單一採集範圍粒度。	DATABASE
DefaultScopeUnit	string	預設採集範圍粒度。	DATABASE
SupportedOptionKeys	array<object>	支援的採集器擴充設定項目。
	object	單一採集器擴充設定項目。
Key	string		CollectRecyclebin
ValueType	string		BOOLEAN
Required	boolean
DefaultValue	string		false
AllowedValues	array
	string		true
SupportExcludeRegex	boolean	是否支援 schema 或 table 排除正規表示式。
SupportSchedule	boolean	是否支援週期排程。
SupportAiComment	boolean	是否支援 AI 中繼資料描述。
RequireResourceGroup	boolean	建立該類型採集器時是否必須指定資源群組。
SupportedDatasourceTypes	array	支援的資料來源類型清單。
	string	單一資料來源類型。	holo

CrawlerTypes 只包含目前地域支援建立的採集器類型。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "CrawlerTypes": [
    {
      "Type": "holo",
      "DisplayName": "Hologres",
      "SupportedEntityTypes": [
        {
          "Type": "holo",
          "SubType": "database",
          "Optional": false,
          "ParentSubType": "instance"
        }
      ],
      "SupportedScopeUnits": [
        "DATABASE"
      ],
      "DefaultScopeUnit": "DATABASE",
      "SupportedOptionKeys": [
        {
          "Key": "CollectRecyclebin",
          "ValueType": "BOOLEAN",
          "Required": false,
          "DefaultValue": "false",
          "AllowedValues": [
            "true"
          ]
        }
      ],
      "SupportExcludeRegex": false,
      "SupportSchedule": false,
      "SupportAiComment": false,
      "RequireResourceGroup": false,
      "SupportedDatasourceTypes": [
        "holo"
      ]
    }
  ]
}

錯誤碼

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

變更歷史

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

DataWorks：GetCrawlerTypeCapabilities