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

品質モニタリングノードのページングリストを照会します。

説明

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

操作説明

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

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:*

list

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペースの ID。	100
TableGuid	string	任意	DataWorks データマップにおけるテーブルの一意の ID。	odps.unit_test.tb_unit_test
Name	string	任意	Data Quality 評価タスク名のあいまい一致に使用される名前。	Test
PageSize	integer	必須	ページングのページサイズ。デフォルト値: 10。	10
PageNumber	integer	必須	ページングのページ番号。デフォルト値: 1。	1

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	API リクエストの ID。	691CA452-D37A-4ED0-****
PagingInfo	object	品質評価ノードのページングクエリ結果。
TotalCount	string	レコードの総数。	131
PageSize	string	ページサイズ。	10
PageNumber	string	ページ番号。	1
DataQualityEvaluationTasks	array<object>	品質評価タスク。
	array<object>
Id	integer	Data Quality 評価タスクの ID。	10001
Name	string	Data Quality 評価タスクの名前。名前には数字、英字、漢字、半角または全角の句読点を含めることができます。名前の長さは最大 255 文字です。	Data quality verification タスク
Description	string	Data Quality 評価タスクの説明。説明の長さは最大 65,535 文字です。	これは日次実行の Data Quality 評価プランです
ProjectId	integer	DataWorks ワークスペースの ID。	100
Target	object	Data Quality 評価タスクの監視対象オブジェクト。
Type	string	監視対象のオブジェクトタイプ。有効な値: Table	Table
DatabaseType	string	テーブルデータセットのデータベースタイプ。有効な値: maxcompute emr cdh hologres analyticdb_for_postgresql analyticdb_for_mysql starrocks	maxcompute
TableGuid	string	DataWorks データマップにおけるテーブルの一意の ID。	odps.unit_test.tb_unit_test
PartitionSpec	string	パーティションテーブルのパーティション設定。	ds=$[yyyymmdd-1]
Trigger	object	Data Quality 評価タスクのトリガー構成。
Type	string	品質評価タスクをトリガーするイベントのタイプ。有効な値: ByScheduledTaskInstance: スケジューリングノードインスタンスが正常に実行されたときにトリガーされます。	ByScheduledTaskInstance
TaskIds	array	このパラメーターは、type が ByScheduledTaskInstance にセットされている場合に効果が適用されます。インスタンスの正常な実行によってタスクがトリガーされるスケジューリングノードの ID を指定します。
	integer	スケジューリングノードの ID。	10001
RuntimeConf	string	データソースのランタイム設定。現在、EMR YARN キューおよび EMR テーブル収集用の SQL エンジンの指定のみがサポートされています。有効な SQL エンジンの値: SPARK_SQL、KYUUBI、PRESTO_SQL、HIVE_SQL。	{ "queue": "default", "sqlEngine": "SPARK_SQL" }
Hooks	array<object>	Data Quality 評価タスクインスタンスのエポック中のコールバック設定。現在、スケジューリングノードインスタンスをブロックするフックは 1 つのみセットできます。
	object	コールバック設定。
Type	string	フォローアップ操作のタイプ。有効な値: BlockTaskInstance: DataWorks ノードインスタンスの実行をブロックします。	BlockTaskInstance
Condition	string	フックをトリガーする原因。	${severity} == "High" AND ${status} == "Critical"
Notifications	object	アラート設定。
Condition	string	通知をトリガーする原因。	${severity} == "High"
Notifications	array<object>	アラート設定。
	array<object>	アラート設定。
NotificationChannels	array<object>	アラートチャンネル構成。
	object	アラートチャンネル。
Channels	array	アラートチャンネル。
	string	アラートチャンネル。有効な値: Mail: メール。 Sms: テキストメッセージ。 Phone: 電話呼び出し。 Feishu: Lark。 Weixin: WeChat。 Dingding: DingTalk。 Webhook: カスタム Webhook フック。	Mail
NotificationReceivers	array<object>	アラート受信者構成。
	object	アラート受信者。
ReceiverType	string	アラート受信者のタイプ。有効な値: AliUid: Alibaba Cloud アカウント UID。 WebhookUrl: カスタム Webhook URL。 DingdingUrl: DingTalk チャットボット Webhook URL。 FeishuUrl: Lark Webhook URL。 WeixinUrl: WeCom Webhook URL。	AliUid
ReceiverValues	array	アラート受信者の具体的な値。
	string	アラート受信者の具体的な値。	user1
Extension	string	JSON フォーマットの拡張情報。たとえば、DingTalk チャットボットはすべてのメンバーへのメンションをサポートしています。	{"atAll":"true"}
DataSourceId	integer

例

成功レスポンス

JSONJSON

{
  "RequestId": "691CA452-D37A-4ED0-****",
  "PagingInfo": {
    "TotalCount": "131",
    "PageSize": "10",
    "PageNumber": "1",
    "DataQualityEvaluationTasks": [
      {
        "Id": 10001,
        "Name": "Data quality verification task",
        "Description": "This is a daily run data quality evaluation plan",
        "ProjectId": 100,
        "Target": {
          "Type": "Table",
          "DatabaseType": "maxcompute",
          "TableGuid": "odps.unit_test.tb_unit_test",
          "PartitionSpec": "ds=$[yyyymmdd-1]"
        },
        "Trigger": {
          "Type": "ByScheduledTaskInstance",
          "TaskIds": [
            10001
          ]
        },
        "RuntimeConf": "{ \"queue\": \"default\", \"sqlEngine\": \"SPARK_SQL\" }",
        "Hooks": [
          {
            "Type": "BlockTaskInstance",
            "Condition": "${severity} == \"High\" AND ${status} == \"Critical\""
          }
        ],
        "Notifications": {
          "Condition": "${severity} == \"High\"",
          "Notifications": [
            {
              "NotificationChannels": [
                {
                  "Channels": [
                    "Mail"
                  ]
                }
              ],
              "NotificationReceivers": [
                {
                  "ReceiverType": "AliUid",
                  "ReceiverValues": [
                    "user1"
                  ],
                  "Extension": "{\"atAll\":\"true\"}"
                }
              ]
            }
          ]
        },
        "DataSourceId": 0
      }
    ]
  }
}

エラーコード

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

変更履歴

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