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

操作説明

シナリオ

指定されたメタデータクローラーの実行リクエストを送信します。

推奨プロセス

ListCrawlers を呼び出して、利用可能なクローラーの ID を取得します。
この操作を呼び出して、実行リクエストを送信します。
ListCrawlerRuns を呼び出して、最終的な実行ステータスを取得します。

エディション要件

DataWorks Basic Edition 以上が必須です。

課金に関する説明

コレクションタスクを実行すると、コンピューティングリソースが消費され、料金が発生する場合があります。実際の料金は、使用されるリソースグループと DataWorks の課金ルールによって異なります。

クローラーで AI メタデータ説明特徴が有効になっている場合 (EnableAiComment=true)、メタデータの収集と AI 説明の生成にトークンが消費されます。無料トークンクォータおよびクォータ超過後の課金ルールについては、「Data エージェントの課金」をご参照ください。

注意事項

応答が成功したことは、実行リクエストが受け入れられたことのみを示します。コレクションタスクが完了したことを示すものではありません。

今すぐお試しください

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

テスト

RAM 認証

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

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	integer	必須	メタデータクローラーの ID。ListCrawlers を呼び出して ID を取得できます。	1234

ListCrawlers を呼び出して Id パラメーターをクエリできます。

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエスト ID。ログの特定や問題のトラブルシューティングに使用します。	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	リクエストが成功したかどうかを示します。
Id	integer	メタデータクローラーの ID。	1234
RunAccepted	boolean	実行リクエストが受け入れられたかどうかを示します。値が true の場合はリクエストが受け入れられたことを示しますが、コレクションタスクが完了したことを示すものではありません。
RunStatus	string	送信後の初期実行ステータス。有効な値: WAITING、RUNNING、SUCCESS、ERROR、SHUTDOWN。実行リクエストが正常に受け入れられると、値は WAITING になります。最終的なステータスを取得するには、ListCrawlerRuns を呼び出します。	WAITING
TaskInstanceId	integer	関連する DataWorks タスクインスタンスの ID。このフィールドは空の場合があります。最終的な実行 Record を取得するには、ListCrawlerRuns を呼び出します。	1234

RunAccepted は、実行リクエストが受け入れられたかどうかを示します。最終的なステータスをクエリするには、ListCrawlerRuns を呼び出します。TaskInstanceId は空の場合があります。

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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