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

Data Quality データ有効性検証タスクの詳細を照会します。

説明

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

操作説明

Available only with DataWorks Basic Edition or higher.

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	integer	任意	Data Quality モニタリング ID。	1006455182

レスポンスフィールド

フィールド	型	説明	例
	object	Schema of Response
RequestId	string	Id of the request	SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF
DataQualityEvaluationTask	object	Data quality monitoring details.
Target	object	Data quality monitoring object.
Type	string	The type of the monitoring object. Table: Table.	Table
DatabaseType	string	The type of the database to which the table belongs. Valid values: maxcompute hologres cdh analyticdb_for_mysql starrocks emr analyticdb_for_postgresql	maxcompute
TableGuid	string	The ID of the table in Data Map.	odps.meta_open_api_test_sz.test_partition_tbl
PartitionSpec	string	Data quality monitoring partition range settings.	pt=$[yyyymmdd-1]
Description	string	Description of the quality monitoring task.	The description of the quality monitoring task.
Trigger	object	Trigger configuration of the data quality validation task.
Type	string	The trigger type of the monitor. Valid values: ByManual: The monitor is manually triggered. ByScheduledTaskInstance: The monitor is triggered by associated scheduling tasks. ByQualityNode: The monitor is triggered by created data quality monitoring nodes.	ByScheduledTaskInstance
TaskIds	array	The IDs of scheduling tasks. This parameter is valid only if you set Type to ByScheduledTaskInstance.
	integer	The ID of the scheduling task.	30001
RuntimeConf	string	Extended configuration. A JSON-formatted string. Only takes effect for EMR-type data quality monitoring. queue: The YARN queue used when executing EMR data quality validation. Defaults to the queue configured for the current project. sqlEngine: The SQL engine used when executing EMR data validation. HIVE_SQL SPARK_SQL	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Id	integer	Data quality monitoring ID.	2178
Name	string	Name of the quality monitoring task.	OpenAPI create a data quality monitoring test
ProjectId	integer	Workspace ID.	2626
Hooks	array<object>	Callback settings.
	object	Hook
Type	string	The hook type. Only one hook type is supported. BlockTaskInstance: Blocks the running of scheduling tasks. A monitor is triggered by scheduling tasks. After a monitor finishes running, the monitor determines whether to block the running of scheduling tasks based on the hook condition.	BlockTaskInstance
Condition	string	The hook trigger condition. When this condition is met, the hook action is triggered. Only two conditional expressions are supported: Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical. Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
Notifications	object	Notification subscription configuration.
Condition	string	The notification trigger condition. When this condition is met, the alert notification is triggered. Only two conditional expressions are supported: Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical. Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.	(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
Notifications	array<object>	The configurations of alert notifications.
	array<object>
NotificationReceivers	array<object>	The configurations of alert recipients.
	object
ReceiverType	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. Valid values: WebhookUrl FeishuUrl DingdingUrl WeixinUrl AliUid 列挙値: WebhookUrl : FeishuUrl : DingdingUrl : WeixinUrl : AliUid :	DingdingUrl
Extension	string	The extended information.	{ "atAll": true }
ReceiverValues	array	The alert recipients.
	string	The value of the receiver. When the receiver type is Alibaba Cloud ID, the receiver value is the specific Alibaba cloud user ID. When the receiver type is DingdingUrl, the receiver value is the alert address of the specific DingTalk robot. When the receiver type is WeixinUrl, the receiver value is the alert address of the specific Enterprise WeChat. When the receiver type is FeishuUrl, the receiver value is the alert address of the specific flying book. When the receiver type is WebhookUrl, the receiver value is the alert address of the specific custom Webhook.	https://api.fc.aliyuncs.com/webhook
NotificationChannels	array<object>	The alert notification methods.
	object
Channels	array	The alert notification methods.
	string	The alert notification method. Valid values: Mail Sms Phone Feishu Weixin Dingding Webhook	Mail
DataSourceId	integer	Data source ID used by the quality monitoring task.	45238

例

成功レスポンス

JSONJSON

{
  "RequestId": "SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF",
  "DataQualityEvaluationTask": {
    "Target": {
      "Type": "Table",
      "DatabaseType": "maxcompute",
      "TableGuid": "odps.meta_open_api_test_sz.test_partition_tbl",
      "PartitionSpec": "pt=$[yyyymmdd-1]"
    },
    "Description": "The description of the quality monitoring task.",
    "Trigger": {
      "Type": "ByScheduledTaskInstance",
      "TaskIds": [
        30001
      ]
    },
    "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }\n",
    "Id": 2178,
    "Name": "OpenAPI create a data quality monitoring test",
    "ProjectId": 2626,
    "Hooks": [
      {
        "Type": "BlockTaskInstance",
        "Condition": "(${severity} == \"High\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Error\")"
      }
    ],
    "Notifications": {
      "Condition": "(${severity} == \"High\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Critical\") OR (${severity} == \"Normal\" AND ${status} == \"Error\")",
      "Notifications": [
        {
          "NotificationReceivers": [
            {
              "ReceiverType": "DingdingUrl",
              "Extension": "{  \"atAll\": true }\n",
              "ReceiverValues": [
                "https://api.fc.aliyuncs.com/webhook\n"
              ]
            }
          ],
          "NotificationChannels": [
            {
              "Channels": [
                "Mail"
              ]
            }
          ]
        }
      ]
    },
    "DataSourceId": 45238
  }
}

エラーコード

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

変更履歴

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