データ品質モニターを更新します。
操作説明
DataWorks のベーシック版以上をご購入済みの場合にご利用いただけます。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Description |
string |
任意 |
データ品質モニターの説明文です。 |
Daily data quality scanning of ods tables. |
| ProjectId |
integer |
任意 |
データ品質モニターが存在する DataWorks ワークスペースの ID です。ワークスペース ID は、ListProjects 操作を呼び出すことで取得できます。 |
101 |
| Id |
integer |
任意 |
データ品質モニターの ID です。 |
10001 |
| Owner |
string |
任意 |
データ品質モニターのオーナーのユーザー ID です。 |
231263586109857423 |
| Spec |
string |
任意 |
データ品質モニタリング内容の Spec コードです。詳細については、「データ品質 Spec の構成説明」をご参照ください。 |
{ "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 |
任意 |
パラメーター値です。 |
smtp.qiye.aliyun.com |
| Name |
string |
任意 |
パラメーター名です。 |
temp_237669.zip_byBwm_1734661241752 |
| RuntimeResource |
object |
任意 |
データ品質モニター実行時に使用されるリソースグループです。 |
|
| Id |
string |
任意 |
リソースグループの ID です。 |
20315 |
| Cu |
number |
任意 |
タスク実行時に設定される CU のデフォルト数です。 |
0.25 |
| Image |
string |
任意 |
タスクランタイム構成のイメージ ID です。 |
i-xxxxxx |
| ComputeResource |
object |
任意 |
実行時に使用されるコンピュートエンジンです。指定されていない場合は、Spec で定義されたデータソース接続が使用されます。 |
|
| Name |
string |
任意 |
コンピュートエンジンの名前で、一意の識別子です。 |
auto_createAlertRule_Finished_1kUTk6 |
| Runtime |
object |
任意 |
コンピュートエンジンの追加設定です。 |
|
| Engine |
string |
任意 |
エンジンの種類です。これらの設定は EMR コンピュートエンジンでのみサポートされます。有効な値は以下のとおりです。
|
Hive |
| SparkConf |
object |
任意 |
追加の Spark エンジンパラメーターです。現在は spark.yarn.queue パラメーターのみサポートされています。 |
spark.yarn.queue=dq_queue |
| HiveConf |
object |
任意 |
追加の Hive エンジンパラメーターです。現在は mapreduce.job.queuename パラメーターのみサポートされています。 |
mapreduce.job.queuename=dq_queue |
| EnvType |
string |
任意 |
コンピュートエンジンのワークスペース環境です。有効な値は以下のとおりです。
|
Prod |
| Trigger |
object |
任意 |
データ品質モニターのトリガー設定です。 |
|
| Type |
string |
任意 |
データ品質モニターのトリガーモードです。有効な値は以下のとおりです。
|
BySchedule |
| TaskIds |
array |
任意 |
トリガーモードが BySchedule の場合、モニターを起動するスケジューリングタスクの ID を設定する必要があります。 |
|
|
integer |
任意 |
スケジューリングタスクの ID です。 |
30001 |
|
| 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 |
| Name |
string |
任意 |
データ品質モニターの名前です。 |
data_quality_scan_001 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマです。 |
||
| RequestId |
string |
リクエスト ID です。 |
22C97E95-F023-56B5-8852-B1A77A1**** |
| Success |
boolean |
呼び出しが成功したかどうかを示します。 |
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77A1****",
"Success": true
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。