現在のリージョンでサポートされているクローラータイプ、およびそのコレクション範囲、スケジューリング、拡張構成機能に関する情報を照会します。
操作説明
シナリオ
現在のリージョンで作成可能なクローラータイプ、および各タイプがサポートするデータソース、コレクション範囲、リソースグループ、スケジューリング、AI メタデータ説明、拡張構成機能を照会します。
推奨ワークフロー
クローラーを作成または更新する前に、この操作を呼び出します。
返された機能情報に基づいて、
CreateCrawlerまたはUpdateCrawlerリクエストを構築します。
エディション要件
DataWorks Basic Edition 以上のエディションが必須です。
注意事項
機能はリージョンやクローラータイプによって異なる場合があります。実際のこの操作の応答をリファレンスとして使用してください。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
リクエストパラメーターは必要ありません。
この操作にはビジネスリクエストパラメーターは必要ありません。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
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 |
スキーマまたはテーブルの除外正規表現がサポートされているかどうかを示します。 |
|
| SupportSchedule |
boolean |
定期スケジューリングがサポートされているかどうかを示します。 |
|
| SupportAiComment |
boolean |
AI メタデータ説明がサポートされているかどうかを示します。 |
|
| RequireResourceGroup |
boolean |
このタイプのクローラーを作成する際にリソースグループを指定する必要があるかどうかを示します。 |
|
| SupportedDatasourceTypes |
array |
サポートされているデータソースタイプのリスト。 |
|
|
string |
単一のデータソースタイプ。 |
holo |
CrawlerTypes には、現在のリージョンで作成可能なクローラータイプのみが含まれます。
例
成功レスポンス
JSONJSON
{
"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"
]
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。