データ品質モニタリングの詳細を取得します。
操作説明
DataWorks のベーシック版以上をご購入いただく必要があります。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dataworks:GetDataQualityScan |
get |
*All Resource
|
なし | なし |
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Id |
integer |
任意 |
モニターの ID です。 |
10001 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマです。 |
||
| RequestId |
string |
リクエストの ID です。 |
204EAF68-CCE3-5112-8DA0-E7A60F02XXXX |
| DataQualityScan |
object |
データ品質モニタリングの詳細です。 |
|
| Id |
integer |
データ品質モニタリングの ID です。 |
10001 |
| Name |
string |
データ品質モニターの名前です。 |
data_quality_scan_001 |
| Description |
string |
データ品質モニターの説明です。 |
aily data quality scanning of ods tables. |
| ProjectId |
integer |
データ品質モニターが存在するワークスペースの ID です。ワークスペース ID は、ListProjects 操作を呼び出すことで取得できます。 |
101 |
| CreateTime |
integer |
データ品質モニターの作成時刻です。 |
1731550150000 |
| ModifyTime |
integer |
データ品質モニターの最終更新時刻です。 |
1731550150000 |
| CreateUser |
string |
データ品質モニターを作成したユーザーの ID です。 |
2374924198591250 |
| ModifyUser |
string |
データ品質モニターを最後に更新したユーザーの ID です。 |
23482597582479 |
| Owner |
string |
データ品質モニターの所有者であるユーザーの ID です。 |
231263586109857423 |
| Spec |
string |
データ品質モニタリングの内容に対応する仕様コードです。 |
{ "datasets": [ { "type": "Table", "dataSource": { "name": "odps_first", "envType": "Prod" }, "tables": [ "ods_d_user_info" ], "filter": "pt = $[yyyymmdd-1]" } ], "rules": [ { "assertion": "row_count > 0" }, { "templateId": "SYSTEM:field:null_value:fixed", "pass": "when = 0", "name": "The id cannot be empty.", "severity": "High", "identity": "a-customized-data-quality-rule-uuid" } ] } |
| Parameters |
array<object> |
データ品質モニターの実行パラメーターの定義です。 |
|
|
object |
パラメーター情報です。 |
||
| Value |
string |
パラメーター名です。 |
10 |
| Name |
string |
パラメーター値です。 |
e2e_autolabel |
| ComputeResource |
object |
実行時に使用されるコンピュートエンジンです。省略可能です。指定しない場合、Spec で定義されたデータソースが使用されます。 |
|
| Name |
string |
コンピュートエンジンの名前で、一意の識別子です。 |
polardb_to_holo |
| Runtime |
object |
データ品質モニターの実行時の追加設定です。 |
|
| Engine |
string |
コンピュートエンジンの種類です。これらの設定は EMR コンピュートエンジンでのみサポートされます。 有効な値：
|
Hive |
| HiveConf |
object |
追加の Hive エンジンパラメーターです。現在は mapreduce.job.queuename パラメーターのみサポートされています。 |
mapreduce.job.queuename=dq_queue |
| SparkConf |
object |
追加の Spark エンジンパラメーターです。現在は spark.yarn.queue パラメーターのみサポートされています。 |
spark.yarn.queue=dq_queue |
| EnvType |
string |
コンピュートエンジンが属するワークスペース環境です。 有効な値：
|
Prod |
| RuntimeResource |
object |
データ品質モニターの実行時に使用されるリソースグループです。 |
|
| Id |
string |
リソースグループの ID です。 |
122878 |
| Cu |
number |
リソースグループに予約された計算ユニット (CU) です。 |
10 |
| Image |
string |
ランタイム構成で使用されるイメージ ID です。 |
hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008 |
| Trigger |
object |
データ品質モニタリングタスクのトリガー設定です。 |
|
| Type |
string |
モニタリングタスクのトリガーモードです。 有効な値：
|
BySchedule |
| TaskIds |
array |
トリガーモードが BySchedule に設定されている場合、スケジューリングタスクの ID を指定する必要があります。 |
|
|
integer |
スケジューリングタスクの ID です。 |
1023777390 |
|
| Hooks |
array<object> |
データ品質モニタリング実行後のフック設定です。 |
|
|
object |
データ品質モニタリング実行後のフック設定です。 |
||
| Condition |
string |
フックのトリガー条件です。条件が満たされた場合にフックが実行されます。現在、以下の式構文のみがサポートされています：
|
results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' || r.status == 'Error' && r.rule.severity == 'High' || r.status == 'Warn' && r.rule.severity == 'High' } |
| Type |
string |
フックの種類です。 有効な値：
|
BlockTaskInstance |
例
成功レスポンス
JSONJSON
{
"RequestId": "204EAF68-CCE3-5112-8DA0-E7A60F02XXXX",
"DataQualityScan": {
"Id": 10001,
"Name": "data_quality_scan_001",
"Description": "aily data quality scanning of ods tables.",
"ProjectId": 101,
"CreateTime": 1731550150000,
"ModifyTime": 1731550150000,
"CreateUser": "2374924198591250",
"ModifyUser": "23482597582479",
"Owner": "231263586109857423",
"Spec": "{\n \"datasets\": [\n {\n \"type\": \"Table\",\n \"dataSource\": {\n \"name\": \"odps_first\",\n \"envType\": \"Prod\"\n },\n \"tables\": [\n \"ods_d_user_info\"\n ],\n \"filter\": \"pt = $[yyyymmdd-1]\"\n }\n ],\n \"rules\": [\n {\n \"assertion\": \"row_count > 0\"\n }, {\n \"templateId\": \"SYSTEM:field:null_value:fixed\",\n \"pass\": \"when = 0\",\n \"name\": \"The id cannot be empty.\",\n \"severity\": \"High\",\n \"identity\": \"a-customized-data-quality-rule-uuid\"\n }\n ]\n}",
"Parameters": [
{
"Value": "10",
"Name": "e2e_autolabel"
}
],
"ComputeResource": {
"Name": "polardb_to_holo",
"Runtime": {
"Engine": "Hive",
"HiveConf": {
"test": "test",
"test2": 1
},
"SparkConf": {
"test": "test",
"test2": 1
}
},
"EnvType": "Prod"
},
"RuntimeResource": {
"Id": "122878",
"Cu": 10,
"Image": "hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008"
},
"Trigger": {
"Type": "BySchedule",
"TaskIds": [
1023777390
]
},
"Hooks": [
{
"Condition": "results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' || r.status == 'Error' && r.rule.severity == 'High' || r.status == 'Warn' && r.rule.severity == 'High' }",
"Type": "BlockTaskInstance"
}
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。