ListQualityResultsByRule API リファレンス - DataWorks

データソースの品質を検証ルールに照らして検証し、検証結果を返します。

説明

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

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RuleId	integer	必須	モニタリングルールの ID。ルール ID とパーティションフィルターを使用して、ルールのモニタリング結果をクエリできます。	152322134
StartDate	string	必須	クエリ対象の時間範囲の開始時刻。yyyy-MM-dd HH:mm:ss 形式で時刻を指定します。このパラメーターは EndDate パラメーターと一緒に設定する必要があります。クエリ対象の時間範囲は 7 日を超えることはできません。	2020-09-20 00:00:00
EndDate	string	必須	クエリ対象の時間範囲の終了時刻。yyyy-MM-dd HH:mm:ss 形式で時刻を指定します。このパラメーターは StartDate パラメーターと一緒に設定する必要があります。クエリ対象の時間範囲は 7 日を超えることはできません。	2020-09-22 00:00:00
PageSize	integer	必須	1ページあたりのエントリ数。デフォルト値：10。最大値：20。	10
PageNumber	integer	必須	ページ番号。	1
ProjectName	string	必須	データ品質モニタリングを実行するコンピュートエンジンまたはデータソースの名前。	autotest
ProjectId	integer	必須	DataWorks ワークスペースの ID。	123456

レスポンスフィールド

フィールド	型	説明	例
	object	チェック結果。
HttpStatusCode	integer	HTTP ステータスコード。	200
ErrorMessage	string	エラーメッセージ。	You have no permission.
RequestId	string	リクエスト ID。	CBA58543-00D4-41****
ErrorCode	string	エラーコード。	401
Success	boolean	リクエストが成功したかどうかを示します。	true
Data	object	チェック結果のトップレベルオブジェクト。
PageNumber	integer	ページ番号。	1
PageSize	integer	1ページあたりのエントリ数。デフォルト値：10。最大値：100。	10
TotalCount	integer	レコードの総数。	200
RuleChecks	array<object>	チェック結果のリスト。
	array<object>	チェック結果。
BlockType	integer	モニタリングルールの強度。強制ルールは、重大アラートがトリガーされた場合に下流のスケジューリングタスクをブロックできます。有効な値： `1`：強制ルール。 `0`：弱ルール。	1
WarningThreshold	number	警告アラートのカスタムしきい値。期待値からの乖離がこのしきい値を超えると、アラートがトリガーされます。	0.1
Property	string	ルールがチェックするソースデータテーブルの列。	type
TableName	string	チェック対象のテーブルの名前。	dual
Comment	string	モニタリングルールの説明。	The description of the rule.
CheckResultStatus	integer	チェック結果のステータス。	2
TemplateName	string	ルールテンプレートの名前。	Expected value verification
CheckerName	string	チェッカーの名前。	fulx
RuleId	integer	ルール ID。	123421
FixedCheck	boolean	固定値チェックが使用されるかどうかを示します。有効な値： `true`：固定値チェックが使用されます。 `false`：固定値チェックは使用されません。	false
Op	string	比較演算子。	>
UpperValue	number	予測上限値。設定されたしきい値に基づいて自動的に生成されます。	22200
ActualExpression	string	チェックされた実際のデータパーティション。	ds=20200925
ExternalId	string	スケジューリングタスクのノード ID。	123112232
TimeCost	string	チェックの持続時間。	10
Trend	string	チェック結果の傾向。	up
ExternalType	string	スケジューリングシステムの種類。現在、CWF のみがサポートされています。	CWF2
BizDate	integer	ビジネス日。オフラインテーブルの場合、通常はチェックが実行される前日です。	1600704000000
CheckResult	integer	チェック結果。	2
ResultString	string	チェック結果の文字列形式。	ResultString
MatchExpression	string	パーティションフィルター式。	ds=$[yyyymmdd]
CheckerType	integer	チェッカーの種類。	0
ProjectName	string	品質チェックに使用されるエンジンまたはデータソースの名前。	autotest
BeginTime	integer	チェックの開始時刻。	1600704000000
DateType	string	スケジューリング周期。たとえば、`YMD` は年次、月次、日次のタスクを表すことができます。	YMD
CriticalThreshold	number	重大アラートのしきい値。強制ルールの場合、このしきい値を超えると下流のスケジューリングタスクがブロックされます。	0.6
IsPrediction	boolean	結果が予測であるかどうかを示します。有効な値： `true`：結果は予測です。 `false`：結果は予測ではありません。	false
RuleName	string	ルールの名前。	The name of the rule.
CheckerId	integer	チェッカーの ID。	7
DiscreteCheck	boolean	離散値チェックが使用されるかどうかを示します。有効な値： `true`：離散値チェックが使用されます。 `false`：離散値チェックは使用されません。	true
EndTime	integer	チェックの終了時刻。	1600704000000
MethodName	string	サンプルデータを収集するために使用されるメソッド。例：`avg`、`count`、`sum`、`min`、`max`、`count_distinct`、`user_defined`、`table_count`、`table_size`、`table_dt_load_count`、`table_dt_refuseload_count`、`null_value`、`null_value/table_count`、`(table_count-count_distinct)/table_count`、`table_count-count_distinct`。	max
LowerValue	number	予測下限値。設定されたしきい値に基づいて自動的に生成されます。	2344
EntityId	integer	パーティションフィルター式の ID。	14534343
WhereCondition	string	チェックのフィルター条件。	type!='type2'
ExpectValue	number	期待値。	90
TemplateId	integer	ルールテンプレートの ID。	5
TaskId	string	チェックタスクの ID。	16008552981681a0d6****
Id	integer	プライマリキー ID。	2231123
ReferenceValue	array<object>	履歴サンプル値。
	object	履歴サンプル。
DiscreteProperty	string	`GROUP BY` 句でグループ化された後のサンプル列の値。たとえば、性別列でグループ化した場合、このパラメーターの値は 'male'、'female'、または 'null' になります。	type1
Value	number	サンプル値。	20
BizDate	string	ビジネス日。オフラインテーブルの場合、通常はチェックが実行される前日です。	1600704000000
SingleCheckResult	integer	単一チェックの結果。	2
Threshold	number	しきい値。	0.2
SampleValue	array<object>	現在のサンプル値。
	object	現在のサンプル。
DiscreteProperty	string	`GROUP BY` 句でグループ化された後のサンプル列の値。たとえば、性別列でグループ化した場合、このパラメーターの値は 'male'、'female'、または 'null' になります。	type2
BizDate	string	ビジネス日。オフラインテーブルの場合、通常はチェックが実行される前日です。	1600704000000
Value	number	サンプル値。	23
Open	boolean	ルールが有効かどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "ErrorMessage": "You have no permission.",
  "RequestId": "CBA58543-00D4-41****",
  "ErrorCode": "401",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 200,
    "RuleChecks": [
      {
        "BlockType": 1,
        "WarningThreshold": 0.1,
        "Property": "type",
        "TableName": "dual",
        "Comment": "The description of the rule.",
        "CheckResultStatus": 2,
        "TemplateName": "Expected value verification",
        "CheckerName": "fulx",
        "RuleId": 123421,
        "FixedCheck": false,
        "Op": ">",
        "UpperValue": 22200,
        "ActualExpression": "ds=20200925",
        "ExternalId": "123112232",
        "TimeCost": "10",
        "Trend": "up",
        "ExternalType": "CWF2",
        "BizDate": 1600704000000,
        "CheckResult": 2,
        "ResultString": "ResultString",
        "MatchExpression": "ds=$[yyyymmdd]",
        "CheckerType": 0,
        "ProjectName": "autotest",
        "BeginTime": 1600704000000,
        "DateType": "YMD",
        "CriticalThreshold": 0.6,
        "IsPrediction": false,
        "RuleName": "The name of the rule.",
        "CheckerId": 7,
        "DiscreteCheck": true,
        "EndTime": 1600704000000,
        "MethodName": "max",
        "LowerValue": 2344,
        "EntityId": 14534343,
        "WhereCondition": "type!='type2'",
        "ExpectValue": 90,
        "TemplateId": 5,
        "TaskId": "16008552981681a0d6****",
        "Id": 2231123,
        "ReferenceValue": [
          {
            "DiscreteProperty": "type1",
            "Value": 20,
            "BizDate": "1600704000000",
            "SingleCheckResult": 2,
            "Threshold": 0.2
          }
        ],
        "SampleValue": [
          {
            "DiscreteProperty": "type2",
            "BizDate": "1600704000000",
            "Value": 23
          }
        ],
        "Open": true
      }
    ]
  }
}

エラーコード

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

変更履歴

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