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

DataWorks Data Quality モニターを作成します。

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに dataworks-public(2024-05-18) - CreateDataQualityScan への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

操作説明

この特徴を使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Target	object	必須	Data Quality モニターの監視対象オブジェクト。
DatabaseType	string	必須	テーブルが属するデータベースのタイプ。有効な値: maxcompute hologres cdh analyticdb_for_mysql starrocks emr analyticdb_for_postgresql	maxcompute
TableGuid	string	必須	DataWorks データマップにおけるテーブルの一意の ID。	odps.api_test.ods_openapi_log_d
PartitionSpec	string	任意	パーティションテーブルのパーティション設定。	pt=$[yyyymmdd-1]
Description	string	任意	Data Quality モニタータスクの説明。	OpenAPI で Data Quality モニターテストを作成します
Name	string	必須	Data Quality モニタータスクの名前。	OpenAPI で Data Quality モニターテストを作成します
RuntimeConf	string	任意	拡張構成。値は JSON フォーマットの文字列です。このパラメーターは、EMR タイプの Data Quality モニターに対してのみ効果が適用されます。	{ "queue": "デフォルト", "sqlEngine": "SPARK_SQL" }
Trigger	object	任意	Data Quality チェックタスクのトリガー構成。
Type	string	任意	品質モニタリングのトリガータイプ。有効な値: ByManual: 手動トリガー。デフォルト値です。 ByScheduledTaskInstance: 関連付けられた定期タスクインスタンスによってトリガーされます。	ByScheduledTaskInstance
TaskIds	array	任意	スケジューリングタスク ID のリスト。このパラメーターは、Type が ByScheduledTaskInstance に設定されている場合にのみ有効です。
	integer	任意	スケジューリングタスクの ID。	30001
ProjectId	integer	必須	DataWorks ワークスペースの ID。DataWorks コンソールにログインし、ワークスペース管理ページに移動して ID を取得できます。	10000
Hooks	array<object>	任意	コールバック設定のセット。
	object	任意	フック。
Type	string	任意	フックのタイプ。現在、サポートされているタイプは 1 つだけです:	BlockTaskInstance
Condition	string	任意	フックのトリガー条件。この条件が満たされると、フック操作がトリガーされます。サポートされる条件式は次の 2 種類のみです。ルールの重大度タイプとルールチェックステータスの単一の組み合わせを指定します（例: `${severity} == "High" AND ${status} == "Critical"`）。これは、重大度が High の実行済みルールのチェック結果が Critical であれば、条件が満たされることを意味します。ルールの重大度タイプとルールチェックステータスの複数の組み合わせを指定します（例: `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`）。これは、重大度が High の実行済みルールのチェック結果が Critical、または重大度が Normal のルールのチェック結果が Critical、または重大度が Normal のルールのチェック結果が Error のいずれかの場合に、条件が満たされることを意味します。条件式における重大度の列挙値は DataQualityRule の重大度の列挙値と一致し、ステータスの列挙値は DataQualityResult のステータスの列挙値と一致します。	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
Notifications	object	任意	通知サブスクリプション構成。
Condition	string	任意	通知のトリガー条件。この条件が満たされると、メッセージ通知がトリガーされます。現在、以下の 2 種類の条件式がサポートされています。ルールの重大度タイプとルールチェックステータスの単一の組み合わせを指定します（例: `${severity} == "High" AND ${status} == "Critical"`）。これは、実行されたルールの中で、重大度が High のルールのチェック結果が Critical であれば、条件が満たされることを意味します。ルールの重大度タイプとルールチェックステータスの複数の組み合わせを指定します（例: `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`）。これは、実行されたルールの中で、重大度が High のルールのチェック結果が Critical、または重大度が Normal のルールのチェック結果が Critical、または重大度が Normal のルールのチェック結果が Error であれば、条件が満たされることを意味します。条件式における severity の列挙値は DataQualityRule の重大度の列挙値と一致し、status の列挙値は DataQualityResult のステータスの列挙値と一致します。	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
Notifications	array<object>	任意	通知設定。
	array<object>	任意	通知設定。
NotificationReceivers	array<object>	任意	アラート受信者の設定。
	object	任意	アラート受信者の設定。
ReceiverType	string	任意	アラート受信者のタイプ。有効な値: WebhookUrl: カスタム Webhook URL。 FeishuUrl: Lark (Feishu) アラート URL。 DingdingUrl: DingTalk アラート URL。 WeixinUrl: WeCom (Enterprise WeChat) アラート URL。 AliUid: Alibaba Cloud ユーザー ID。	DingdingUrl
Extension	string	任意	アラート送信時に使用される追加パラメーター。JSON 形式。サポートされているキー: atAll: DingTalk アラート送信時にグループ内の全メンバー (@all) をメンションするかどうか。このキーは ReceiverType が DingdingUrl に設定されている場合に有効です。	{ "atAll": true }
ReceiverValues	array	任意	アラート受信者。
	string	任意	受信者の値。受信者タイプが AliUid の場合、値は特定の Alibaba Cloud ユーザー ID です。受信者タイプが DingdingUrl の場合、値は特定の DingTalk チャットボットのアラート URL です。受信者タイプが WeixinUrl の場合、値は特定の WeCom (Enterprise WeChat) チャットボットのアラート URL です。受信者タイプが FeishuUrl の場合、値は特定の Lark (Feishu) チャットボットのアラート URL です。受信者タイプが WebhookUrl の場合、値は特定のカスタム Webhook の URL です。	https://api.fc.aliyuncs.com/webhook
NotificationChannels	array<object>	任意	通知方法。
	object	任意	通知方法。
Channels	array	任意	通知方法。
	string	任意	アラート方法。有効な値: Mail: メール Sms: テキストメッセージ Phone: 電話 Feishu: Lark (Feishu) Weixin: WeChat Dingding: DingTalk Webhook: カスタム Webhook	Mail
DataSourceId	integer	必須	データソースの ID。 ListDataSources を呼び出してデータソース ID を取得できます。	1
DataQualityRules	array<object>	任意	Data Quality モニタリングタスクに関連付けられた Data Quality ルールのリスト。DataQualityRule.Id が指定されている場合、その ID に対応するルールが新しい品質モニタリングタスクに関連付けられます。DataQualityRule.Id が指定されていない場合、他のフィールドに基づいて新しいルールが作成され、新しい品質モニタリングタスクに関連付けられます。
	array<object>	任意
Name	string	任意	Data Quality ルールの名前。	OpenAPI テストルール
Enabled	boolean	任意	品質ルールが有効かどうかを指定します。	true
Severity	string	任意	ビジネスに対するルールの重大度レベル (ページ上の強ルールまたは弱ルールに対応)。有効な値:	High
Description	string	任意	Data Quality ルールの説明。	OpenAPI テストルール
TemplateCode	string	任意	ルールによってリファレンスされるルールテンプレートの一意の識別子。	SYSTEM:field:null_value:fixed:0
SamplingConfig	object	任意	サンプルコレクションに必須のパラメーター。
Metric	string	任意	サンプリングメトリックの名前。有効な値: Count: テーブルの行数。 Min: フィールドの最小値。 Max: フィールドの最大値。 Avg: フィールドの平均値。 DistinctCount: フィールド内の一意な値の数。 DistinctPercent: フィールド内の一意な値の総行数に対する比率。 DuplicatedCount: フィールド内の重複する値の数。 DuplicatedPercent: フィールド内の重複する値の総行数に対する比率。 TableSize: テーブルサイズ。 NullValueCount: フィールドが null である行数。 NullValuePercent: フィールドが null である行の比率。 GroupCount: フィールド値で集約した後の各値ごとの行数。 CountNotIn: 列挙された値に一致しない行数。 CountDistinctNotIn: 列挙された値に一致しない一意な値の数。 UserDefinedSql: カスタム SQL ステートメントによるサンプル収集。	NullValueCount
MetricParameters	string	任意	サンプルコレクションに必須のパラメーター。	{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}
SettingConfig	string	任意	サンプリング文の前に実行される実行時パラメーター設定文。最大値は 1,000 文字です。現在、MaxCompute のみがサポートされています。	odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True
SamplingFilter	string	任意	サンプリング中に関心のないデータに対して二次フィルターを実行するために使用されるフィルター条件。最大値は 16,777,215 文字です。	status != 'Succeeded'
CheckingConfig	object	任意	サンプル検証設定。
Type	string	任意	しきい値の計算メソッド。	Fixed
ReferencedSamplesFilter	string	任意	リファレンスサンプルのクエリ方法を指定する式。一部のしきい値タイプでは、リファレンスサンプルをクエリし、その値を集約して比較用のしきい値を導出する必要があります。	{"bizdate": ["-1"]}
Thresholds	object	任意	検証しきい値の設定。
Expected	object	任意	期待されるしきい値設定。
Operator	string	任意	比較演算子。有効な値: > >= < <= != =	=
Value	string	任意	しきい値。	0
Expression	string	任意	しきい値の式。変動タイプのルールでは、変動しきい値を指定するために式を使用する必要があります。例: 0.01 を超える変動の増加: $checkValue > 0.01 0.01 を超える変動の減少: $checkValue < -0.01 絶対変動率: abs($checkValue) > 0.01 固定値ルールでもしきい値を式で設定できます。両方が設定されている場合、式が Operator と Value よりも優先されます。	$checkValue > 0.01
Warned	object	任意	通常の警告レベルのしきい値設定。
Operator	string	任意	比較演算子。有効な値: > >= < <= != =	>
Value	string	任意	しきい値。	0.001
Expression	string	任意	しきい値の式。変動タイプのルールでは、変動しきい値を指定するために式を使用する必要があります。例: 0.01 を超える変動の増加: $checkValue > 0.01 0.01 を超える変動の減少: $checkValue < -0.01 絶対変動率: abs($checkValue) > 0.01 固定値ルールでもしきい値を式で設定できます。両方が設定されている場合、式が Operator と Value よりも優先されます。	$checkValue > 0.01
Critical	object	任意	重大な警告レベルのしきい値設定。
Operator	string	任意	比較演算子。有効な値: > >= < <= != =	>
Value	string	任意	しきい値。	0.01
Expression	string	任意	しきい値の式。変動タイプのルールでは、変動しきい値を指定するために式を使用する必要があります。例: 0.01 を超える変動の増加: $checkValue > 0.01 0.01 を超える変動の減少: $checkValue < -0.01 絶対変動率: abs($checkValue) > 0.01 固定値ルールでもしきい値を式で設定できます。両方が設定されている場合、式が Operator と Value よりも優先されます。	$checkValue > 0.01
ErrorHandlers	array<object>	任意	品質ルール検証の問題に対するエラーハンドラのリスト。
	object	任意	品質ルール検証の問題に対するエラーハンドラ。
Type	string	任意	ハンドラのタイプ:	SaveErrorData
ErrorDataFilter	string	任意	問題のあるデータをフィルターするためにユーザーが指定した SQL ステートメント。カスタム SQL ルールには必須です。	SELECT * FROM ods_api_log WHERE status = 'Error';
Id	integer	任意	ルールの ID。	2176

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンススキーマ。
RequestId	string	リクエストの ID。	2d9ce-38ef-4923-baf6-391a7e656
Id	integer	新しく作成された Data Quality モニタリングタスクの ID。	10001

例

成功レスポンス

JSONJSON

{
  "RequestId": "2d9ce-38ef-4923-baf6-391a7e656",
  "Id": 10001
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

変更履歴

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