ListQualityRules - - Centro de documentación de Alibaba Cloud

Consulta reglas de monitoreo con base en una expresión de filtro de partición.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListQualityRules	La operación que desea ejecutar. Establezca el valor en ListQualityRules.
ProjectName	String	Sí	autotest	El nombre de la instancia del motor de cómputo o del origen de datos. Puede obtener el nombre from las configuraciones del origen de datos.
EntityId	Long	Sí	1234	El ID de la expresión de filtro de partición. Puede llamar a la operación GetQualityEntity para consultar el ID de la expresión de filtro de partición.
PageNumber	Integer	Sí	1	El número de página.
PageSize	Integer	Sí	20	El número de entradas por página. Valores válidos: de 1 a 20. Valor predeterminado: 10.
ProjectId	Long	No	12345	El ID del espacio de trabajo de DataWorks.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
HttpStatusCode	Integer	200	El código de estado HTTP.
RequestId	String	38cbdef0-f6cf-49****	El ID de la solicitud. Puede solucionar errores con base en este ID.
ErrorMessage	String	You have no permission.	El mensaje de error.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true false
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	El código de error.
Data	Object		La lista de reglas de monitoreo.
PageNumber	Integer	1	El número de página.
PageSize	Integer	20	El número de entradas por página. Valores válidos: de 1 a 100. Valor predeterminado: 10.
TotalCount	Long	400	El número total de entradas devueltas.
Rules	Array of Rules		Los detalles de la regla de monitoreo.
BlockType	Integer	0	La fuerza de la regla de monitoreo. Este atributo indica la importancia de la regla. Valores válidos: 1: indica que la regla de monitoreo es fuerte. 0: indica que la regla de monitoreo es débil. Puede especificar si una regla de monitoreo es fuerte según sus requisitos empresariales. Si la regla es fuerte y se supera el umbral crítico, se genera una alerta crítica y se bloquea la ejecución de las tareas asociadas.
OnDutyAccountName	String	test	El nombre de la cuenta de Alibaba Cloud utilizada para configure la regla de monitoreo.
Property	String	id	El nombre del campo.
WarningThreshold	String	10	El umbral para una alerta de advertencia. Este valor indica la desviación del resultado de monitoreo respecto al valor esperado. Puede personalizarlo según sus requisitos empresariales.
TableName	String	dual	El nombre de la tabla.
OnDuty	String	1912****	El ID de la cuenta de Alibaba Cloud utilizada para configure la regla de monitoreo.
Comment	String	Monitoring rule for a table	La descripción de la regla de monitoreo.
RuleCheckerRelationId	Integer	132323	El ID de la tarea asociada a la expresión de filtro de partición.
FixCheck	Boolean	true	Indica si el monitoreo se realiza con base en un valor fijo.
MethodId	Integer	21	El ID del método de muestreo de la regla de monitoreo.
TemplateName	String	Check for the fluctuations of table rows on an SQL task on the first, seventh, and thirtieth days	El nombre de la plantilla de monitoreo.
Trend	String	abs	La tendencia del resultado de monitoreo.
HistoryWarningThreshold	String	history max:40%,history min:10%	El umbral histórico para una alerta de advertencia.
RuleType	Integer	0	El tipo de regla de monitoreo. Valores válidos: 0: regla de monitoreo creada por el sistema. 1: regla de monitoreo creada por un usuario. 2: regla de monitoreo del espacio de trabajo.
MatchExpression	String	dt=$[yyyymmdd]	La expresión de filtro de partición.
ProjectName	String	autotest	El nombre de la instancia del motor de cómputo o del origen de datos.
PropertyKey	String	table_count	El campo utilizado para asociar reglas de monitoreo en el frontend. Este parámetro se puede ignorar.
CriticalThreshold	String	40	El umbral para una alerta crítica. Este valor indica la desviación del resultado de monitoreo respecto al valor esperado. Puede personalizarlo según sus requisitos empresariales. Si la regla de monitoreo es fuerte y se supera el umbral crítico, se genera una alerta crítica y se bloquea la ejecución de las tareas asociadas.
HistoryCriticalThreshold	String	history max:80%,history min:50%	El umbral histórico para una alerta crítica.
MethodName	String	count/table_count	El nombre del método utilizado para recopilar datos de muestra, como 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 o table_count-count_distinct.
CheckerId	Integer	7	El ID del verificador.
EntityId	Integer	1234	El ID de la expresión de filtro de partición.
ExpectValue	String	1000	El valor esperado.
TemplateId	Integer	7	El ID de la plantilla de monitoreo.
Id	Integer	1234	El ID de la regla de monitoreo.
RuleName	String	test	El nombre de la regla de monitoreo.

Ejemplos

Solicitudes de ejemplo

http(s)://[Endpoint]/?Action=ListQualityRules
&ProjectName=autotest
&EntityId=1234
&PageNumber=1
&PageSize=20
&ProjectId=12345
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

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

<ListQualityRulesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>38cbdef0-f6cf-49****</RequestId>
    <ErrorMessage>You have no permission.</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>20</PageSize>
        <TotalCount>400</TotalCount>
        <Rules>
            <BlockType>0</BlockType>
            <OnDutyAccountName>test</OnDutyAccountName>
            <Property>id</Property>
            <WarningThreshold>10</WarningThreshold>
            <TableName>dual</TableName>
            <OnDuty>1912****</OnDuty>
            <Comment>Monitoring rule for a table</Comment>
            <RuleCheckerRelationId>132323</RuleCheckerRelationId>
            <FixCheck>true</FixCheck>
            <MethodId>21</MethodId>
            <TemplateName>Check for the fluctuations of table rows on an SQL task on the first, seventh, and thirtieth days</TemplateName>
            <Trend>abs</Trend>
            <HistoryWarningThreshold>history max:40%,history min:10%</HistoryWarningThreshold>
            <RuleType>0</RuleType>
            <MatchExpression>dt=$[yyyymmdd]</MatchExpression>
            <ProjectName>autotest</ProjectName>
            <PropertyKey>table_count</PropertyKey>
            <CriticalThreshold>40</CriticalThreshold>
            <HistoryCriticalThreshold>history max:80%,history min:50%</HistoryCriticalThreshold>
            <MethodName>count/table_count</MethodName>
            <CheckerId>7</CheckerId>
            <EntityId>1234</EntityId>
            <ExpectValue>1000</ExpectValue>
            <TemplateId>7</TemplateId>
            <Id>1234</Id>
            <RuleName>test</RuleName>
        </Rules>
    </Data>
</ListQualityRulesResponse>

Formato JSON

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "38cbdef0-f6cf-49****",
  "ErrorMessage" : "You have no permission.",
  "Success" : true,
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 20,
    "TotalCount" : 400,
    "Rules" : {
      "BlockType" : 0,
      "OnDutyAccountName" : "test",
      "Property" : "id",
      "WarningThreshold" : 10,
      "TableName" : "dual",
      "OnDuty" : "1912****",
      "Comment": "Monitoring rule for a table",
      "RuleCheckerRelationId" : 132323,
      "FixCheck" : true,
      "MethodId" : 21,
      "TemplateName": "Check for the fluctuations of table rows on an SQL task on the first, seventh, and thirtieth days",
      "Trend" : "abs",
      "HistoryWarningThreshold" : "history max:40%,history min:10%",
      "RuleType" : 0,
      "MatchExpression" : "dt=$[yyyymmdd]",
      "ProjectName" : "autotest",
      "PropertyKey" : "table_count",
      "CriticalThreshold" : 40,
      "HistoryCriticalThreshold" : "history max:80%,history min:50%",
      "MethodName" : "count/table_count",
      "CheckerId" : 7,
      "EntityId" : 1234,
      "ExpectValue" : 1000,
      "TemplateId" : 7,
      "Id" : 1234,
      "RuleName" : "test"
    }
  }
}

Códigos de error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.