Use ListQualityRules to query monitoring rules - DataWorks

Call ListQualityRules to retrieve quality rules that match a partition expression.

Note

This API has been deprecated. We recommend migrating to dataworks-public(2024-05-18) - GetDataQualityScan for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the engine or data source. You can find this name on the Data Source Configuration page.	autotest
EntityId	integer	Yes	The ID of the partition expression. Call the GetQualityEntity operation to get this ID.	12345
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries to return per page. Default: 10. Maximum: 20.	20
ProjectId	integer	Yes	The ID of the DataWorks workspace.	12345

Response elements

Element	Type	Description	Example
	object	The response object.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	38cbdef0-f6cf-49****
ErrorMessage	string	The error message.	You have no permission.
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Data	object	The paginated list of quality rules.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. A valid value is 1 to 100. Default value: 10.	20
TotalCount	integer	The total number of entries returned.	400
Rules	array<object>	The details of the quality rule.
	object	The data returned.
BlockType	integer	The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values: `1`: The monitoring rule is a strong rule. `0`: The monitoring rule is a weak rule. You can specify a monitoring rule as a strong rule based on your business requirements. If a strong rule is triggered, a critical alert is reported and the scheduling of the task is blocked.	0
OnDutyAccountName	string	The name of the Alibaba Cloud account that is used to configure the monitoring rule.	test
Property	string	The name of the field.	id
WarningThreshold	string	The threshold for a warning alert. The threshold specifies the deviation of a monitoring result from the expected value. You can customize the threshold based on your business requirements.	10
TableName	string	The name of the table.	dual
OnDuty	string	The ID of the Alibaba Cloud account that is used to configure the monitoring rule.	1912****
Comment	string	The description of the monitoring rule.	Verify table rules
RuleCheckerRelationId	integer	The internal association ID for the rule details.	132323
FixCheck	boolean	Indicates whether a fixed value is used for the check.	true
MethodId	integer	The ID of the method used to collect sample data.	21
TemplateName	string	The name of the monitoring template.	Number of SQL task table rows, 1, 7, and 30 days wave detection
Trend	string	The trend of the monitoring result.	abs
HistoryWarningThreshold	string	The historical threshold for a warning alert.	history max:40%,history min:10%
RuleType	integer	The type of the monitoring rule. Valid values: `0`: The monitoring rule is created by the system. `1`: The monitoring rule is created by a user. `2`: The monitoring rule is a workspace-level rule.	0
MatchExpression	string	The partition filter expression.	dt=$[yyyymmdd]
ProjectName	string	The name of the compute engine or data source.	autotest
PropertyKey	string	This parameter is not used. You can ignore this parameter.	table_count
CriticalThreshold	string	The threshold for a critical alert. The threshold specifies the deviation of a monitoring result from the expected value. You can customize the threshold based on your business requirements. If a strong rule is used and a critical alert is triggered, the scheduling of the task is blocked.	40
HistoryCriticalThreshold	string	The historical threshold for a critical alert.	history max:80%,history min:50%
MethodName	string	The name of the method used to collect sample data, such as `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`, or `table_count-count_distinct`.	count/table_count
CheckerId	integer	The checker ID.	7
EntityId	integer	The ID of the partition filter expression.	1234
ExpectValue	string	The expected value.	1000
TemplateId	integer	The ID of the monitoring template.	7
Id	integer	The ID of the monitoring rule.	1234
RuleName	string	The name of the monitoring rule.	test

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "38cbdef0-f6cf-49****",
  "ErrorMessage": "You have no permission.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 400,
    "Rules": [
      {
        "BlockType": 0,
        "OnDutyAccountName": "test",
        "Property": "id",
        "WarningThreshold": "10",
        "TableName": "dual",
        "OnDuty": "1912****",
        "Comment": "Verify table rules",
        "RuleCheckerRelationId": 132323,
        "FixCheck": true,
        "MethodId": 21,
        "TemplateName": "Number of SQL task table rows, 1, 7, and 30 days wave detection",
        "Trend": "abs",
        "HistoryWarningThreshold": "history max:40%,history min:10%",
        "RuleType": 0,
        "MatchExpression": "dt=$[yyyymmdd]",
        "ProjectName": "autotest",
        "PropertyKey": "table_count",
        "CriticalThreshold": "40",
        "HistoryCriticalThreshold": "history max:80%,history min:50%",
        "MethodName": "count/table_count",
        "CheckerId": 7,
        "EntityId": 1234,
        "ExpectValue": "1000",
        "TemplateId": 7,
        "Id": 1234,
        "RuleName": "test"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.