All Products
Search
Document Center

DataWorks:ListDataQualityScanRuns

Last Updated:Jan 12, 2026

Queries the execution records of data quality scans in a project.

Operation description

This API operation is available for all DataWorks editions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:ListDataQualityScanRunslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DataQualityScanIdlongNo

The ID of the data quality monitor.

10001
CreateTimeFromlongNo

The earliest time when the data quality monitor starts to run.

1710239005403
CreateTimeTolongNo

The latest time when the data quality monitor starts to run.

1710239005403
StatusstringNo

The status of the data quality check result.

  • Pass
  • Running
  • Error
  • Fail
  • Warn
Fail
SortBystringNo

The list of sorting fields. Supports fields such as last modified time and creation time. Format: "SortField+SortOrder (Desc/Asc)", where Asc is the default. Valid values:

  • CreateTime (Desc/Asc)
  • Id (Desc/Asc)
CreateTime Desc
PageSizeintegerNo

The number of records per page. Default value: 10.

20
PageNumberintegerNo

The page number of the results. Default value: 1.

1
ProjectIdlongYes

The project ID.

12345
FilterobjectNo

The extended query filter. Supported parameters:

  • TaskInstanceId
{ "TaskInstanceId": 111L }

Response parameters

ParameterTypeDescriptionExample
object

The response.

RequestIdstring

The request ID.

0bc14115***159376359
PageInfoobject

The page information.

TotalCountinteger

The total number of records returned.

324
PageSizeinteger

The number of records per page. Default value: 10.

10
PageNumberinteger

The page number of the results. Default value: 1.

1
DataQualityScanRunsarray<object>

The list of data quality monitor run records.

DataQualityScanRunobject

The list of data quality monitor run records.

Idlong

The ID of the data quality monitor running record.

3155
CreateTimelong

The time when the data quality monitor starts running.

1710239005403
FinishTimelong

The time when the data quality monitor stops.

1710239005403
Statusstring

The status of the instance.

  • Pass
  • Running
  • Error
  • Warn
  • Fail
Fail
Parametersarray<object>

The parameters configured for the instance.

Parameterobject

The parameter information.

Namestring

The parameter name.

dt
Valuestring

The parameter value. You can use a scheduling time expression.

$[yyyy-mm-dd-1]

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-12-02The request parameters of the API has changedView Change Details