GetQualityEntity

Retrieves the partition expression for a specified table.

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
ProjectName	string	Yes	The engine or data source name, as shown on the Data Source Configuration page.	autotest
TableName	string	Yes	The partitioned table name. Call GetMetaTablePartition to obtain it.	dual
EnvType	string	Yes	The type of the engine or data source. Valid values: `cdh` `analyticdb_for_mysql` `odps` `emr` `hadoop` `holodb` `hybriddb_for_postgresql`	odps
MatchExpression	string	No	The partition expression.	dt=$[yyyymmdd]
ProjectId	integer	Yes	The DataWorks workspace ID. Find it on the Workspace Configurations page in the DataWorks console.	123456

Response elements

Element	Type	Description	Example
	object	The response object.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	6d739ef6-098a-47****
ErrorMessage	string	The error message.	You have no permission.
ErrorCode	string	The error code.	401
Success	boolean	Whether the request succeeded.	true
Data	array<object>	The data returned.
	object	The details of the data.
RelativeNode	string	The scheduling node associated with the partition filter expression. Sub-parameters: ProjectName: The name of the workspace to which the scheduling node belongs. NodeID: The ID of the scheduling node.	[{"projectName":"xc_DP**","nodeId":7000026**}]
OnDutyAccountName	string	The Alibaba Cloud account name of the owner.	test
Task	integer	The task node.	0
TableName	string	The name of the partitioned table.	test_dqc_de****
Followers	string	The Alibaba Cloud account IDs of subscribers who receive alert notifications.	1822931****
OnDuty	string	The Alibaba Cloud account ID of the partition filter expression owner.	1822931****
MatchExpression	string	The partition filter expression.	dt=$[yyyymmdd-1]
CreateTime	integer	The creation time of the partition filter expression.	1593964800000
ProjectName	string	The name of the engine or data source.	autotest
HasRelativeNode	boolean	Whether the partition filter expression is associated with a scheduling node. Valid values: true: Associated with a scheduling node. false: Not associated with a scheduling node.	true
EnvType	string	The type of the engine or data source.	odps
EntityLevel	integer	The level of the partition filter expression. Valid values: 0 (SQL-level): A data quality check is triggered after each SQL statement is run. 1 (Task-level): A data quality check is triggered after all SQL statements are run.	0
ModifyUser	string	The Alibaba Cloud account ID of the user who last updated the partition filter expression.	1822931****
Sql	integer	The SQL-level partition filter expression.	0
Id	integer	The ID of the partition filter expression.	4003918
ModifyTime	integer	The last update time of the partition filter expression.	1593964800000

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "6d739ef6-098a-47****",
  "ErrorMessage": "You have no permission.",
  "ErrorCode": "401",
  "Success": true,
  "Data": [
    {
      "RelativeNode": "[{\"projectName\":\"xc_DP****\",\"nodeId\":7000026****}]",
      "OnDutyAccountName": "test",
      "Task": 0,
      "TableName": "test_dqc_de****",
      "Followers": "1822931****",
      "OnDuty": "1822931****",
      "MatchExpression": "dt=$[yyyymmdd-1]",
      "CreateTime": 1593964800000,
      "ProjectName": "autotest",
      "HasRelativeNode": true,
      "EnvType": "odps",
      "EntityLevel": 0,
      "ModifyUser": "1822931****",
      "Sql": 0,
      "Id": 4003918,
      "ModifyTime": 1593964800000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.