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

指定されたプロジェクトにおけるデータ品質スキャン実行の履歴を照会します。

操作説明

この機能には、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:ListDataQualityScanRuns

list

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DataQualityScanId	integer	任意	データ品質スキャンの ID。	10001
CreateTimeFrom	integer	任意	結果に含めるデータ品質スキャン実行の最も早い開始時刻。時刻は UNIX タイムスタンプ (ミリ秒単位) で指定します。	1710239005403
CreateTimeTo	integer	任意	結果に含めるデータ品質スキャン実行の最も遅い開始時刻。時刻は UNIX タイムスタンプ (ミリ秒単位) で指定します。	1710239005403
Status	string	任意	データ品質スキャン実行のステータス。有効な値: Pass Running Error Fail Warn	Fail
SortBy	string	任意	結果のソートフィールドと順序。形式は `FieldName Order` です。デフォルトの順序は昇順 (Asc) です。サポートされているフィールド: CreateTime (Desc/Asc) Id (Desc/Asc)	CreateTime Desc
PageSize	integer	任意	各ページで返されるエントリ数。デフォルト値: 10。	20
PageNumber	integer	任意	返されるページ番号。デフォルト値: 1。	1
ProjectId	integer	必須	プロジェクト ID。	12345
Filter	object	任意	高度なフィルター条件を持つオブジェクト。以下のパラメーターがサポートされています。 `TaskInstanceId`: タスクインスタンスの ID。 `RunNumber`: インスタンスの実行番号。	{ "TaskInstanceId": "111", "RunNumber": "1" }

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
RequestId	string	リクエスト ID。	0bc14115***159376359
PageInfo	object	ページネーション情報。
TotalCount	integer	エントリーの総数。	324
PageSize	integer	1 ページあたりのエントリー数。デフォルト値は 10 です。	10
PageNumber	integer	ページ番号。デフォルト値は 1 です。	1
DataQualityScanRuns	array<object>	データ品質スキャン実行のリスト。
	array<object>	データ品質スキャン実行の詳細。
Id	integer	データ品質スキャン実行の ID。	3155
CreateTime	integer	データ品質スキャン実行の開始時刻。	1710239005403
FinishTime	integer	データ品質スキャン実行の終了時刻。	1710239005403
Status	string	データ品質スキャン実行のステータス。有効な値： Pass Running Error Warn Fail	Fail
Parameters	array<object>	実行に使用されるパラメーター。
	object	パラメーターの詳細。
Name	string	パラメーター名。	dt
Value	string	パラメーター値。スケジューリング時間式を使用できます。	$[yyyy-mm-dd-1]

例

成功レスポンス

JSONJSON

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 324,
    "PageSize": 10,
    "PageNumber": 1,
    "DataQualityScanRuns": [
      {
        "Id": 3155,
        "CreateTime": 1710239005403,
        "FinishTime": 1710239005403,
        "Status": "Fail",
        "Parameters": [
          {
            "Name": "dt",
            "Value": "$[yyyy-mm-dd-1]"
          }
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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