指定されたメタデータクローラーの構成、ステータス、および最新の実行情報を照会します。
操作説明
シナリオ
指定されたメタデータクローラーの構成、可用性ステータス、および最新の実行情報を照会します。
推奨ワークフロー
ListCrawlersを呼び出してクローラー ID を取得します。この操作を呼び出してクローラーの詳細を取得します。
完全な実行履歴をクエリするには、
ListCrawlerRunsを呼び出します。
エディション要件
DataWorks Basic Edition 以上が必須です。
注意事項
クローラーが実行されていない場合、最新の実行ステータスとタスクインスタンス ID が空になることがあります。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Id |
integer |
必須 |
メタデータクローラーの ID。この ID は ListCrawlers を呼び出して取得できます。 |
1234 |
Id は ListCrawlers を呼び出してクエリできます。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答。 |
||
| RequestId |
string |
リクエスト ID。ログの特定や問題のトラブルシューティングに使用されます。 |
9252F32F-D855-549E-8898-61CF5A733050 |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
|
| Crawler |
object |
メタデータクローラーの詳細。 |
|
| Id |
integer |
クローラーの ID。 |
1234 |
| Name |
string |
クローラーの名前。 |
example_crawler |
| DataSourceId |
integer |
データソースの ID。 |
12345 |
| Type |
string |
クローラーのタイプ。 |
starrocks |
| Status |
string |
クローラーのステータス。クローラーの構成が有効で、関連付けられたデータソースが存在する場合、値は VALID です。それ以外の場合、値は INVALID です。 |
VALID |
| MetaEntityId |
string |
クローラーに関連付けられたメタエンティティ ID。メタデータクエリ API への接続に使用できます。 |
starrocks:example-instance |
| ProjectId |
integer |
DataWorks ワークスペースの ID。 |
100 |
| EnvType |
string |
DataWorks の環境タイプ。有効な値: Dev、Prod。 |
Prod |
| ResourceGroupId |
string |
コレクションタスクの実行に使用される Serverless 2.0 リソースグループの ID。 |
Serverless_res_group_1234567890123456_1234567890 |
| ScheduleConfig |
object |
スケジュールの構成。 |
|
| Type |
string |
NORMAL |
|
| CronExpress |
string |
0 0 2 ? * * |
|
| LastRunStatus |
string |
最新の実行ステータス。有効な値: WAITING、RUNNING、SUCCESS、ERROR、SHUTDOWN。クローラーが実行されていない場合、この値は空になることがあります。 |
SUCCESS |
| Owner |
string |
クローラーオーナーの DataWorks ユーザー ID。 |
1000 |
| CreateTime |
integer |
作成時間（ミリ秒レベルの UNIX タイムスタンプ）。 |
1710239005403 |
| ModifyTime |
integer |
変更時間（ミリ秒レベルの UNIX タイムスタンプ）。 |
1710239005403 |
| Scope |
object |
コレクション範囲の構成。 |
|
| Unit |
string |
DATABASE |
|
| Items |
array |
||
|
string |
example_database |
||
| ExcludeRegex |
string |
^tmp_.* |
|
| EnableAiComment |
boolean |
AI メタデータ説明が有効かどうかを示します。 |
|
| Options |
object |
クローラータイプの拡張構成。 |
|
|
string |
クローラーの単一拡張構成項目の値。 |
true |
|
| LastRunTaskInstanceId |
integer |
最新の実行に関連付けられた DataWorks タスクインスタンス ID。クローラーが実行されていない場合、この値は空になることがあります。 |
1234 |
| TaskId |
integer |
クローラーに関連付けられた DataWorks スケジューリングタスク ID。GetTask を呼び出してタスク解像度をクエリするために使用できます。 |
1234 |
Crawler オブジェクトは、クローラーの構成、可用性ステータス、および最新の実行情報を返します。
例
成功レスポンス
JSONJSON
{
"RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
"Success": false,
"Crawler": {
"Id": 1234,
"Name": "example_crawler",
"DataSourceId": 12345,
"Type": "starrocks",
"Status": "VALID",
"MetaEntityId": "starrocks:example-instance",
"ProjectId": 100,
"EnvType": "Prod",
"ResourceGroupId": "Serverless_res_group_1234567890123456_1234567890",
"ScheduleConfig": {
"Type": "NORMAL",
"CronExpress": "0 0 2 ? * *"
},
"LastRunStatus": "SUCCESS",
"Owner": "1000",
"CreateTime": 1710239005403,
"ModifyTime": 1710239005403,
"Scope": {
"Unit": "DATABASE",
"Items": [
"example_database"
],
"ExcludeRegex": "^tmp_.*"
},
"EnableAiComment": false,
"Options": {
"key": "true"
},
"LastRunTaskInstanceId": 1234,
"TaskId": 1234
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。