GetQualityEntity - DataWorks - Alibaba Cloud Documentation Center

Queries the information about 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

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:*	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The name of the compute engine instance or data source. You can obtain the name from data source configurations.	autotest
TableName	string	Yes	The name of the partitioned table. You can call the GetMetaTablePartition operation to obtain the name.	dual
EnvType	string	Yes	The type of the compute engine or data source. Valid values: cdh analyticdb_for_mysql odps emr hadoop holodb hybriddb_for_postgresql	odps
MatchExpression	string	No	The partition filter expression.	dt=$[yyyymmdd]

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code returned.	200
RequestId	string	The ID of the request.	6d739ef6-098a-47****
ErrorMessage	string	The error message returned.	You have no permission.
ErrorCode	string	The error code returned.	401
Success	boolean	Indicates whether the request is successful.	true
Data	array<object>	The information about the partition filter expression.
EntityDto	object
RelativeNode	string	The information about the node with which the partition filter expression is associated. The information includes the following items: ProjectName: the name of the workspace to which the node belongs. NodeID: the ID of the node.	[{"projectName":"xc_DP**","nodeId":7000026**}]
OnDutyAccountName	string	The name of the Alibaba Cloud account that is used to configure the partition filter expression.	test
Task	integer	The node.	0
TableName	string	The name of the partitioned table.	test_dqc_de****
Followers	string	The ID of the Alibaba Cloud account that is used to receive alert notifications.	1822931****
OnDuty	string	The ID of the Alibaba Cloud account that is used to configure the partition filter expression.	1822931****
MatchExpression	string	The partition filter expression.	dt=$[yyyymmdd-1]
CreateTime	long	The time when the partition filter expression was created.	1593964800000
ProjectName	string	The name of the compute engine instance or data source.	autotest
HasRelativeNode	boolean	Indicates whether the partition filter expression is associated with a node. Valid values: true: The partition filter expression is associated with a node. false: The partition filter expression is not associated with a node.	true
EnvType	string	The type of the compute engine instance or data source.	odps
EntityLevel	integer	The level of the partition filter expression. Valid values: 0: The partition filter expression is at the SQL level. This indicates that the system checks data quality after each SQL statement is executed. 1: The partition filter expression is at the node level. This indicates that the system checks data quality after all the SQL statements for a node are executed.	0
ModifyUser	string	The ID of the Alibaba Cloud account that is used to modify the partition filter expression.	1822931****
Sql	integer	Indicates that the partition filter expression is at the SQL level.	0
Id	long	The ID of the partition filter expression.	4003918
ModifyTime	long	The time when the partition filter expression was modified.	1593964800000

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation
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