ワークスペース、データソース、タイプ、環境、オーナー、名前でフィルターして、メタデータクロールをページングクエリします。
操作説明
シナリオ
アクセス権限を持つメタデータクロールをページングクエリします。ワークスペース、データソース、クロールタイプ、環境、オーナー、名前でフィルターできます。
推奨フロー
必要に応じてフィルター条件を組み合わせて、クロールリストの条件付きクエリを実行します。
返されたクロール ID を使用して、詳細取得、更新、実行、停止、実行記録、または削除の各オペレーションを呼び出します。
バージョン要件
DataWorks Basic Edition 以上が必須です。
注意事項
複数のフィルター条件が同時に指定された場合、それらは組み合わせて効果があります。名前フィールドはあいまい一致をサポートしています。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dataworks:ListCrawlers |
list |
*すべてのリソース。
|
なし | なし |
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
integer |
任意 |
DataWorks ワークスペースの ID。 |
100 |
| DataSourceIds |
array |
任意 |
データソース ID のリスト。最大 10 個の ID を指定できます。 |
|
|
integer |
任意 |
単一のデータソースの ID。 |
12345 |
|
| Type |
string |
任意 |
クロールのタイプ。現在のリージョンでサポートされている有効な値をクエリするには、GetCrawlerTypeCapabilities を呼び出します。 |
starrocks |
| EnvType |
string |
任意 |
DataWorks の環境タイプ。Dev は開発環境を示します。Prod は本番環境を示します。 |
Prod |
| Owner |
string |
任意 |
クロールオーナーの DataWorks ユーザー ID。 |
1000 |
| Name |
string |
任意 |
メタデータクロールの名前。あいまい一致をサポートしています。 |
example_crawl |
| PageNumber |
integer |
任意 |
ページ番号。1 から始まります。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページサイズ。デフォルト値: 20。最大値: 100。 |
20 |
複数のフィルター条件が同時に指定された場合、それらは組み合わせて効果があります。DataSourceIds は最大 10 個の ID をサポートしています。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答の結果。 |
||
| RequestId |
string |
リクエスト ID。ログの特定や問題のトラブルシューティングに使用します。 |
9252F32F-D855-549E-8898-61CF5A733050 |
| Success |
boolean |
リクエストが成功したかどうかを示します。 |
|
| PagingInfo |
object |
ページネーション情報。 |
|
| TotalCount |
integer |
クエリ条件に一致するレコードの総数。 |
1 |
| PageNumber |
integer |
現在のページ番号。 |
1 |
| PageSize |
integer |
ページサイズ。 |
20 |
| Crawlers |
array<object> |
メタデータクロールのリスト。 |
|
|
array<object> |
メタデータクロールのまとめ情報。 |
||
| Id |
integer |
クロールの ID。 |
1234 |
| Name |
string |
クロールの名前。 |
example_crawl |
| DataSourceId |
integer |
データソースの ID。 |
12345 |
| Type |
string |
クロールのタイプ。 |
starrocks |
| Status |
string |
クロールのステータス。クロール構成が有効で関連付けられたデータソースが存在する場合、値は VALID です。それ以外の場合、値は INVALID です。 |
VALID |
| MetaEntityId |
string |
クロールに関連付けられたメタエンティティ ID。この 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 |
スケジュールのタイプ。有効な値: MANUAL、NORMAL。 |
NORMAL |
| CronExpress |
string |
cron 式。 |
0 0 2 ? * * |
| LastRunStatus |
string |
最新の実行ステータス。有効な値: WAITING、RUNNING、SUCCESS、ERROR、SHUTDOWN。クロールがまだ実行されていない場合、このフィールドは空になることがあります。 |
SUCCESS |
| Owner |
string |
クロールオーナーの DataWorks ユーザー ID。 |
1000 |
| CreateTime |
integer |
作成時間。ミリ秒精度の UNIX タイムスタンプで表されます。 |
1710239005403 |
| ModifyTime |
integer |
変更時間。ミリ秒精度の UNIX タイムスタンプで表されます。 |
1710239005403 |
| TaskId |
integer |
クロールに関連付けられた DataWorks スケジューリングノード ID。この ID を使用して GetTask を呼び出し、ノード解像度をクエリできます。 |
1234 |
Crawlers は、現在のページのメタデータクロールのまとめ情報を返します。
例
成功レスポンス
JSONJSON
{
"RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
"Success": false,
"PagingInfo": {
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 20,
"Crawlers": [
{
"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,
"TaskId": 1234
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。