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

Data Quality データ検証タスクを更新します。

説明

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

操作説明

DataWorks Basic Edition or above must be purchased to use this operation.

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Target	object	任意	Data Quality モニタリングオブジェクト。
DatabaseType	string	任意	Database type to which the table belongs maxcompute hologres cdh analyticdb_for_mysql starrocks emr analyticdb_for_postgresql	maxcompute
TableGuid	string	任意	Unique ID of the table in Data Map	odsp.openapi.ods_d_openapi_log
PartitionSpec	string	任意	Partition settings of the partitioned table	dt=$[yyyymmdd-1]
Description	string	任意	品質モニタリングタスクの説明。	OpenAPI data quality monitoring test.
Name	string	任意	品質モニタリングタスクの名前。	OpenAPI data quality monitoring test.
RuntimeConf	string	任意	拡張構成。JSON フォーマットの文字列です。EMR タイプの Data Quality モニタリングにのみ有効です。 queue: EMR データ検証の実行時に使用される YARN キュー。デフォルトでは現在のプロジェクトに構成されたキューが使用されます。 sqlEngine: EMR データ検証の実行時に使用される SQL エンジン。 HIVE_SQL SPARK_SQL。	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Trigger	object	任意	データ検証タスクのトリガー構成。有効なトリガータイプについては DataQualityRuleTrigger を参照してください。
Type	string	任意	Trigger type of the quality monitoring task. ByScheduledTaskInstance: Triggered by an associated scheduling task. ByManual: Triggered manually.	ByScheduledTaskInstance
TaskIds	array	任意	List of scheduling task IDs. Valid when Type is ByScheduledTaskInstance.
	integer	任意	Scheduling task node ID	1004979033
ProjectId	integer	必須	ワークスペース ID。	10000
Hooks	array<object>	任意	コールバック設定。呼び出し時のコールバック設定です。
	object	任意	Hook
Type	string	任意	Hook actions executed after data quality validation completes. BlockTaskInstance: Block the scheduling task.	ByScheduledTaskInstance
Condition	string	任意	Hook trigger condition. When this condition is met, the hook action is triggered. Currently, only two types of condition expressions are supported: Specify a single group of rule severity type and rule validation status, such as `${severity} == "High" AND ${status} == "Critical"`. This means the condition is met when any executed rule with severity High has a validation result of Critical. Specify multiple groups of rule severity type and rule validation status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. This means the condition is met when any executed rule satisfies one of the following: severity High with validation result Critical, severity Normal with validation result Critical, or severity Normal with validation result Error. The severity enum in the condition expression is consistent with the severity enum in DataQualityRule, and the status enum is consistent with the status in DataQualityResult.	${severity} == "High" AND ${status} == "Critical"
Notifications	object	任意	通知サブスクリプション構成。
Condition	string	任意	Notification trigger condition. When this condition is met, a message notification is triggered. Currently, only two types of condition expressions are supported: Specify a single group of rule severity type and rule validation status, such as `${severity} == "High" AND ${status} == "Critical"`. This means the condition is met when any executed rule with severity High has a validation result of Critical. Specify multiple groups of rule severity type and rule validation status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. This means the condition is met when any executed rule satisfies one of the following: severity High with validation result Critical, severity Normal with validation result Critical, or severity Normal with validation result Error. The severity enum in the condition expression is consistent with the severity enum in DataQualityRule, and the status enum is consistent with the status in DataQualityResult.	${severity} == "High" AND ${status} == "Critical"
Notifications	array<object>	任意	Notification settings
	array<object>	任意	Notification settings
NotificationReceivers	array<object>	任意	Alert recipient settings
	object	任意	Alert recipient settings
ReceiverType	string	任意	The type of the alert recipient. Valid values: WebhookUrl FeishuUrl DingdingUrl WeixinUrl AliUid 列挙値: WebhookUrl : FeishuUrl : DingdingUrl : WeixinUrl : AliUid :	DingdingUrl
Extension	string	任意	The additional parameters that are required when alerts are sent. The parameters are JSON-formatted strings. The following keys are supported: atAll: specifies that all members in a group are mentioned when alerts are sent by using DingTalk. This parameter is valid only if you set ReceiverType to DingdingUrl.	{ "atAll": true }
ReceiverValues	array	任意	The alert recipient.
	string	任意	The recipient. If you set ReceiverType to AliUid, set this parameter to the Alibaba Cloud account ID of a user. If you set ReceiverType to DingdingUrl, set this parameter to the URL of a DingTalk chatbot. If you set ReceiverType to WeixinUrl, set this parameter to the URL of WeCom. If you set ReceiverType to FeishuUrl, set this parameter to the URL of Lark. If you set ReceiverType to WebhookUrl, set this parameter to the webhook URL.	https://api.fc.aliyuncs.com/webhook
NotificationChannels	array<object>	任意	Notification method
	object	任意	Notification method
Channels	array	任意	The alert notification methods.
	string	任意	The alert notification method. Valid values: Dingding Mail Weixin Feishu Phone Sms Webhook	Mail
DataSourceId	integer	任意	データソース ID。 ListDataSources を呼び出してデータソース ID を取得できます。	358750
DataQualityRules	array<object>	任意	Data Quality モニタリングに関連付けられたデータ品質ルールのリスト。
	array<object>	任意
Name	string	任意	Name of the data quality rule.	OpenAPI test rules
Enabled	boolean	任意	Whether the data quality rule is enabled.	true
Severity	string	任意	Severity level of the rule for the business (corresponds to strong/weak rules on the page). Optional enum values: Normal High	Normal
Description	string	任意	Description of the data quality rule.	OpenAPI test rules
TemplateCode	string	任意	Unique identifier of the rule template referenced by the rule.	SYSTEM:field:null_value:fixed:0
SamplingConfig	object	任意	Parameters required for sample collection
Metric	string	任意	Name of the sampling metric Count: Number of rows in the table Min: Minimum value of the field Max: Maximum value of the field Avg: Average value of the field DistinctCount: Number of distinct values of the field DistinctPercent: Ratio of the number of distinct field values to the total number of rows DuplicatedCount: Number of duplicate values of the field DuplicatedPercent: Ratio of the number of duplicate field values to the total number of rows TableSize: Size of the table NullValueCount: Number of rows where the field is null NullValuePercent: Proportion of rows where the field is null GroupCount: After aggregating by field value, each value and its corresponding number of rows CountNotIn: Number of rows whose enum values do not match CountDistinctNotIn: Number of distinct values whose enum values do not match UserDefinedSql: Sample collection via custom SQL	CountNotIn
MetricParameters	string	任意	Parameters required for sample collection	{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}
SettingConfig	string	任意	Runtime parameter setting statements to be inserted and executed before the actual sampling statement. Maximum 1000 characters. Currently only MaxCompute is supported.	odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True
SamplingFilter	string	任意	Conditions for further filtering of data not of concern during sampling. Maximum 16777215 characters.	status != 'Succeeded'
CheckingConfig	object	任意	Sample validation settings
Type	string	任意	Threshold calculation method Fluctation: Fluctuation range validation Auto: Intelligent threshold validation FluctationDiscreate: Discrete value fluctuation range validation Average: Mean fluctuation range validation Fixed: Fixed value validation	Fixed
ReferencedSamplesFilter	string	任意	Some threshold types require querying reference samples and then aggregating their values to derive the comparison threshold. An expression is used here to indicate how the reference samples are queried.	{"bizdate": ["-1"]}
Thresholds	object	任意	Validation threshold settings.
Expected	object	任意	The expected threshold setting.
Operator	string	任意	The comparison operator. Valid values: > >= < <= != =	=
Value	string	任意	The threshold value.	0
Expression	string	任意	The threshold expression. If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples: $checkValue > 0.01 $checkValue < -0.01 abs($checkValue) > 0.01 If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.	$checkValue > 0.01
Warned	object	任意	The threshold settings for normal alerts.
Operator	string	任意	The comparison operator. Valid values: > >= < <= != =	>
Value	string	任意	The threshold value.	0.001
Expression	string	任意	The threshold expression. If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples: $checkValue > 0.01 $checkValue < -0.01 abs($checkValue) > 0.01 If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.	$checkValue > 0.01
Critical	object	任意	The threshold settings for critical alerts.
Operator	string	任意	The comparison operator. Valid values: > >= < <= != =	>
Value	string	任意	The threshold value.	0.01
Expression	string	任意	The threshold expression. If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples: $checkValue > 0.01 $checkValue < -0.01 abs($checkValue) > 0.01 If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.	$checkValue > 0.01
ErrorHandlers	array<object>	任意	Quality rule validation issue handler
	object	任意
Type	string	任意	Handler type: SaveErrorData: Retain problematic data	SaveErrorData
ErrorDataFilter	string	任意	For custom SQL rules, the user must specify the SQL to filter problematic data.	SELECT * FROM ods_d_openapi_log WHERE status = 'Error'
Id	integer	任意	ID of the validation rule. You can call the ListQualityRules operation to obtain the rule ID.	1022171560
Id	integer	必須	Data Quality モニタリング ID。	7227061794

レスポンスフィールド

フィールド	型	説明	例
	object	Schema of Response
Success	boolean	Indicates whether the request was successful.	true
RequestId	string	Request ID. Used to locate logs and troubleshoot issues.	8abcb91f-d266-4073-b907-2ed670378ed1

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "8abcb91f-d266-4073-b907-2ed670378ed1"
}

エラーコード

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

変更履歴

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