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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetQualityEntity

The operation that you want to perform.

ProjectName String Yes autotest

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

TableName String Yes dual

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

EnvType String Yes odps

The type of the compute engine instance or data source.

MatchExpression String No dt=$[yyyymmdd]

The partition filter expression.

RegionId String Yes cn-shanghai

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system determines the value of this parameter based on the endpoint that is used to call the operation.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String 6d739ef6-098a-47****

The ID of the request.

ErrorMessage String You have no permission.

The error message returned.

ErrorCode String 401

The error code returned.

Success Boolean true

Indicates whether the request is successful.

Data Array of EntityDto

The information about the partition filter expression.

RelativeNode String [{"projectName":"xc_DP****","nodeId":7000026****}]

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.
OnDutyAccountName String test

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

Task Integer 0

The node.

TableName String test_dqc_de****

The name of the partitioned table.

Followers String 1822931****

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

OnDuty String 1822931****

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

MatchExpression String dt=$[yyyymmdd-1]

The partition filter expression.

CreateTime Long 1593964800000

The time when the partition filter expression was created.

ProjectName String autotest

The name of the compute engine instance or data source.

HasRelativeNode Boolean true

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.
EnvType String odps

The type of the compute engine instance or data source.

EntityLevel Integer 0

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.
ModifyUser String 1822931****

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

Sql Integer 0

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

Id Long 4003918

The ID of the partition filter expression.

ModifyTime Long 1593964800000

The time when the partition filter expression was modified.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetQualityEntity
&ProjectName=autotest
&TableName=dual
&EnvType=odps
&MatchExpression=dt=$[yyyymmdd]
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 API Error Center.