UpdateCrawler - DataWorks - Alibaba Cloud ドキュメントセンター

指定されたメタデータクローラーのリソースグループ、コレクション範囲、スケジューリング、および拡張構成を更新します。

操作説明

シナリオ

指定されたメタデータクローラーのリソースグループ、コレクション範囲、スケジューリング、AI メタデータ説明、または拡張構成を部分的に更新します。

推奨ワークフロー

GetCrawler を呼び出して現在の構成を取得します。
GetCrawlerTypeCapabilities を呼び出して、クローラータイプでサポートされている構成機能を確認します。
更新したいフィールドのみを指定してこの操作を呼び出します。

エディション要件

DataWorks Basic Edition またはそれ以上のエディションが必須です。

注意事項

更新可能なフィールドを少なくとも 1 つ指定する必要があります。指定されていないフィールドは変更されません。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	integer	必須	メタデータクローラーの ID。ListCrawlers を呼び出してクローラー ID を取得できます。	1234
ResourceGroupId	string	任意	コレクションタスクの実行に使用される Serverless 2.0 リソースグループの ID。このパラメーターがサポートされているか、および必須かどうかは、GetCrawlerTypeCapabilities が返す機能によって異なります。このパラメーターが指定されていない場合、既存の値は変更されません。	Serverless_res_group_1234567890123456_1234567890
Scope	object	任意	コレクション範囲の構成。このパラメーターが指定されている場合、コレクション範囲が更新されます。このパラメーターが指定されていない場合、既存の値は変更されません。
Unit	string	必須	コレクション範囲の粒度。有効な値は、GetCrawlerTypeCapabilities が返す SupportedScopeUnits によって決まります。	DATABASE
Items	array	任意	データベース名のリスト。このパラメーターは、Unit が DATABASE にセットされている場合にのみサポートされます。最大値は 1,000 エントリです。名前を空にしたり重複させたりすることはできません。
	string	任意	単一のデータベース名。名前の長さは最大 256 文字です。	example_データベース
ExcludeRegex	string	任意	コレクション範囲からオブジェクトを除外するために使用される正規表現式。このパラメーターは、GetCrawlerTypeCapabilities が返す SupportExcludeRegex が true にセットされている場合にのみサポートされます。	^tmp_.*
ScheduleConfig	object	任意	スケジューリングの構成。このパラメーターが指定されている場合、スケジューリングメソッドが更新されます。このパラメーターが指定されていない場合、既存の値は変更されません。
Type	string	必須	スケジューリングタイプ。MANUAL は手動実行を示します。NORMAL は定期スケジューリングを示します。開発環境のデータソースでは MANUAL のみがサポートされています。NORMAL が利用可能かどうかは、GetCrawlerTypeCapabilities が返す SupportSchedule の値によって異なります。	NORMAL
CronExpress	string	任意	定期スケジューリング用の 6 フィールドの cron 式。このパラメーターは、Type が NORMAL にセットされている場合に必須です。秒フィールドは 0 である必要があり、スケジューリング周波数は 1 時間に 1 回を超えることはできません。	0 0 2 ? * *
EnableAiComment	boolean	任意	AI メタデータ説明を有効にするかどうかを指定します。このパラメーターは、GetCrawlerTypeCapabilities が返す SupportAiComment が true に設定されている場合にのみサポートされます。このパラメーターが指定されていない場合、既存の値は変更されません。
Options	object	任意	クローラータイプの拡張構成。指定された設定項目のみが更新されます。指定されていない設定項目は変更されません。サポートされるキーと値は、GetCrawlerTypeCapabilities が返す SupportedOptionKeys によって決まります。
	string	任意	単一のクローラー拡張設定項目の値。サポートされる設定項目、値のタイプ、および値の範囲は、GetCrawlerTypeCapabilities が返す SupportedOptionKeys によって決まります。	v1

次のパラメーターのうち少なくとも 1 つを指定する必要があります: ResourceGroupId、Scope、ScheduleConfig、EnableAiComment、または Options。指定されていないフィールドは変更されません。

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエスト ID。この ID を使用してログを特定し、問題のトラブルシューティングを行うことができます。	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	リクエストが成功したかどうかを示します。
Id	integer	更新されたメタデータクローラーの ID。	1234

Id は更新されたメタデータクローラーの ID です。

例

成功レスポンス

JSONJSON

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "Id": 1234
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。