ListDataQualityScanRuns-阿里云帮助中心

Queries the run history of data quality scans in a specified project.

Operation description

This feature requires DataWorks basic edition or higher.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListDataQualityScanRuns

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DataQualityScanId	integer	No	The ID of the data quality scan.	10001
CreateTimeFrom	integer	No	The earliest start time of a data quality scan run to include in the results. Specify the time as a UNIX timestamp in milliseconds.	1710239005403
CreateTimeTo	integer	No	The latest start time of a data quality scan run to include in the results. Specify the time as a UNIX timestamp in milliseconds.	1710239005403
Status	string	No	The status of the data quality scan run. Valid values: Pass Running Error Fail Warn	Fail
SortBy	string	No	The sort field and order for the results. The format is `FieldName Order`. The default order is ascending (Asc). Supported fields: CreateTime (Desc/Asc) Id (Desc/Asc)	CreateTime Desc
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	20
PageNumber	integer	No	The page number to return. Default value: 1.	1
ProjectId	integer	Yes	The project ID.	12345
Filter	object	No	An object with advanced filter conditions. The following parameters are supported: `TaskInstanceId`: The ID of the task instance. `RunNumber`: The run number of the instance.	{ "TaskInstanceId": "111", "RunNumber": "1" }

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	0bc14115***159376359
PageInfo	object	The pagination information.
TotalCount	integer	The total number of entries.	324
PageSize	integer	The number of entries per page. The default value is 10.	10
PageNumber	integer	The page number. The default value is 1.	1
DataQualityScanRuns	array<object>	The list of data quality scan runs.
	array<object>	The details of a data quality scan run.
Id	integer	The ID of the data quality scan run.	3155
CreateTime	integer	The start time of the data quality scan run.	1710239005403
FinishTime	integer	The end time of the data quality scan run.	1710239005403
Status	string	The status of the data quality scan run. Valid values: Pass Running Error Warn Fail	Fail
Parameters	array<object>	The parameters used for the run.
	object	The parameter details.
Name	string	The parameter name.	dt
Value	string	The parameter value. You can use a scheduling time expression.	$[yyyy-mm-dd-1]

Examples

Success response

JSON format

{
  "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]"
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.