All Products
Search
Document Center

DataWorks:GetQualityEntity

Last Updated:Sep 18, 2024

Queries the information about a partition filter expression.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectNamestringYes

The name of the compute engine instance or data source. You can obtain the name from data source configurations.

autotest
TableNamestringYes

The name of the partitioned table. You can call the GetMetaTablePartition operation to obtain the name.

dual
EnvTypestringYes

The type of the compute engine or data source. Valid values:

  • cdh
  • analyticdb_for_mysql
  • odps
  • emr
  • hadoop
  • holodb
  • hybriddb_for_postgresql
odps
MatchExpressionstringNo

The partition filter expression.

dt=$[yyyymmdd]

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code returned.

200
RequestIdstring

The ID of the request.

6d739ef6-098a-47****
ErrorMessagestring

The error message returned.

You have no permission.
ErrorCodestring

The error code returned.

401
Successboolean

Indicates whether the request is successful.

true
Dataarray<object>

The information about the partition filter expression.

object
RelativeNodestring

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****}]
OnDutyAccountNamestring

The name of the Alibaba Cloud account that is used to configure the partition filter expression.

test
Taskinteger

The node.

0
TableNamestring

The name of the partitioned table.

test_dqc_de****
Followersstring

The ID of the Alibaba Cloud account that is used to receive alert notifications.

1822931****
OnDutystring

The ID of the Alibaba Cloud account that is used to configure the partition filter expression.

1822931****
MatchExpressionstring

The partition filter expression.

dt=$[yyyymmdd-1]
CreateTimelong

The time when the partition filter expression was created.

1593964800000
ProjectNamestring

The name of the compute engine instance or data source.

autotest
HasRelativeNodeboolean

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
EnvTypestring

The type of the compute engine instance or data source.

odps
EntityLevelinteger

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
ModifyUserstring

The ID of the Alibaba Cloud account that is used to modify the partition filter expression.

1822931****
Sqlinteger

Indicates that the partition filter expression is at the SQL level.

0
Idlong

The ID of the partition filter expression.

4003918
ModifyTimelong

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 timeSummary of changesOperation
2023-07-11The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-03-08The request parameters of the API has changedView Change Details