ListQualityRules - DataWorks - Alibaba Cloud Documentation Center

Queries monitoring rules based on a partition filter expression.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the compute engine or data source. You can obtain the name from data source configurations.	autotest
EntityId	long	Yes	The ID of the partition filter expression. You can call the GetQualityEntity operation to query the ID.	1234
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page. Default value: 10. Maximum value: 20.	20
ProjectId	long	Yes	The DataWorks workspace ID.	12345

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID. You can troubleshoot errors based on the ID.	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 list of retrieved rules.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	20
TotalCount	long	The total number of entries returned.	400
Rules	array<object>	The details of the validation rule.
Rules	object	The returned result.
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 the strength of a monitoring rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.	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 the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements.	10
TableName	string	The name of the table.	dual
OnDuty	string	The name 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 ID of the task that is associated with the partition filter expression.	132323
FixCheck	boolean	Indicates whether the monitoring is performed based on a fixed value.	true
MethodId	integer	The ID of the task that is associated with the partition filter expression.	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	Rule type: 0: System template rule 1: Custom SQL rule 1: Custom template rule	0
MatchExpression	string	The partition filter expression.	dt=$[yyyymmdd]
ProjectName	string	The name of the compute engine or data source.	autotest
PropertyKey	string	The field that is used to associate with monitoring rules at the frontend. This parameter can be ignored.	table_count
CriticalThreshold	string	The threshold for a critical alert. The threshold indicates the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.	40
HistoryCriticalThreshold	string	The historical threshold for a critical alert.	history max:80%,history min:50%
MethodName	string	The method that is 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 monitoring rule ID.	1234
RuleName	string	The name of the monitoring rule.	test

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation
2024-01-22	The response structure of the API has changed	View Change Details
2023-07-11	The internal configuration of the API is changed, but the call is not affected	View Change Details
2023-03-08	The request parameters of the API has changed	View Change Details
2021-10-26	The response structure of the API has changed	View Change Details