Use GetQualityRule to query monitoring rule information - DataWorks

Gets information about a quality rule.

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

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:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RuleId	integer	Yes	The ID of the quality rule. You can call the ListQualityRules operation to obtain the ID.	1234
ProjectName	string	Yes	The name of the engine or data source.	autotest
ProjectId	integer	No	The ID of the DataWorks workspace.	12345

Response elements

Element	Type	Description	Example
	object	The response data structure.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	576b9457-2cf5-4****
ErrorMessage	string	The error message.	You have no permission.
ErrorCode	string	The error code.	401
Success	boolean	Indicates whether the request was successful.	true
Data	object	The quality rule details.
BlockType	integer	The severity of the quality rule. Valid values: `1`: Strong Rule. If a Strong Rule triggers a critical Alert, the associated Scheduling Task is blocked. `0`: Weak Rule.	1
OnDutyAccountName	string	The name of the Alibaba Cloud account that configured the rule.	test
WarningThreshold	string	The threshold for a warning Alert. This value specifies the acceptable deviation from the Expected Value and can be customized.	10
Property	string	The column in the data source table to which the rule applies.	id
RuleType	integer	The type of the quality rule. Valid values: `0`: A rule based on a system template. `1`: A rule based on a custom SQL statement. `4`: A rule based on a custom template.	0
Comment	string	The comment for the rule.	Verify that the primary key is unique
OnDuty	string	The ID of the Alibaba Cloud account that configured the rule.	1822931****
Checker	integer	The checker ID, which is derived from a primary key and used for front-end identification.	9
FixCheck	boolean	Indicates whether to validate against a fixed value.	true
MethodId	integer	The ID of the method used to collect sample data.	8
CriticalThreshold	string	The threshold for a critical Alert, which defines the maximum acceptable deviation from the Expected Value. If this threshold is met for a Strong Rule, the associated Scheduling Task is blocked.	20
PredictType	integer	Indicates whether the threshold is dynamic. Valid values: `0`: The threshold is static. `1`: The threshold is dynamic.	0
TemplateName	string	The name of the template used.	SQL task table rows, 1,7, 30 days fluctuation test
CheckerName	string	The name of the checker.	compared with a fixed value
RuleName	string	The name of the rule.	View table fluctuations
MethodName	string	The name of the method used to collect sample data. Valid values include `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`, and `table_count-count_distinct`.	table_count
EntityId	integer	The ID of the partition expression.	165523
WhereCondition	string	The filter condition or custom SQL statement used for validation.	id>10
Operator	string	The comparison operator.	>=
ExpectValue	string	The expected value.	30
Trend	string	The trend of the validation result.	abs
TemplateId	integer	The ID of the template used.	7
Id	integer	The ID of the rule.	123232
OpenSwitch	boolean	Indicates whether the rule is enabled.	true
TaskSetting	string	The variable settings inserted before a custom rule. The format is x=a,y=b.	x=a,y=b

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "576b9457-2cf5-4****",
  "ErrorMessage": "You have no permission.",
  "ErrorCode": "401",
  "Success": true,
  "Data": {
    "BlockType": 1,
    "OnDutyAccountName": "test",
    "WarningThreshold": "10",
    "Property": "id",
    "RuleType": 0,
    "Comment": "Verify that the primary key is unique",
    "OnDuty": "1822931****",
    "Checker": 9,
    "FixCheck": true,
    "MethodId": 8,
    "CriticalThreshold": "20",
    "PredictType": 0,
    "TemplateName": "SQL task table rows, 1,7, 30 days fluctuation test",
    "CheckerName": "compared with a fixed value",
    "RuleName": "View table fluctuations",
    "MethodName": "table_count",
    "EntityId": 165523,
    "WhereCondition": "id>10",
    "Operator": ">=",
    "ExpectValue": "30",
    "Trend": "abs",
    "TemplateId": 7,
    "Id": 123232,
    "OpenSwitch": true,
    "TaskSetting": "x=a,y=b\n"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.