ListQualityRules - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListQualityRules	A operação a ser executada. Defina o valor como ListQualityRules.
ProjectName	String	Sim	autotest	Nome da instância do mecanismo de computação ou da fonte de dados. É possível obter esse nome nas configurações da fonte de dados.
EntityId	Long	Sim	1234	ID da expressão de filtro de partição. Chame a operação GetQualityEntity para consultar o ID da expressão de filtro de partição.
PageNumber	Integer	Sim	1	Número da página.
PageSize	Integer	Sim	20	Quantidade de entradas por página. Valores válidos: 1 a 20. Valor padrão: 10.
ProjectId	Long	Não	12345	ID do workspace do DataWorks.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	Código de status HTTP.
RequestId	String	38cbdef0-f6cf-49****	ID da solicitação. Utilize este ID para solucionar erros.
ErrorMessage	String	You have no permission.	Mensagem de erro.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	Código de erro.
Data	Object		Lista de regras de monitoramento.
PageNumber	Integer	1	Número da página.
PageSize	Integer	20	Quantidade de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
TotalCount	Long	400	Número total de entradas retornadas.
Rules	Array of Rules		Detalhes da regra de monitoramento.
BlockType	Integer	0	Força da regra de monitoramento, que indica a importância da regra. Valores válidos: 1: a regra de monitoramento é forte. 0: a regra de monitoramento é fraca. Especifique se uma regra de monitoramento é forte conforme suas necessidades de negócios. Se a regra for forte e o limiar crítico for excedido, um alerta crítico será gerado e as tarefas associadas à regra serão bloqueadas.
OnDutyAccountName	String	test	Nome da conta Alibaba Cloud usada para configurar a regra de monitoramento.
Property	String	id	Nome do campo.
WarningThreshold	String	10	Limiar para alerta de aviso, representando o desvio do resultado de monitoramento em relação ao valor esperado. Personalize este limiar conforme suas necessidades de negócios.
TableName	String	dual	Nome da tabela.
OnDuty	String	1912****	ID da conta Alibaba Cloud usada para configurar a regra de monitoramento.
Comment	String	Monitoring rule for a table	Descrição da regra de monitoramento.
RuleCheckerRelationId	Integer	132323	ID da tarefa associada à expressão de filtro de partição.
FixCheck	Boolean	true	Indica se o monitoramento usa um valor fixo como base.
MethodId	Integer	21	ID do método de amostragem da regra de monitoramento.
TemplateName	String	Check for the fluctuations of table rows on an SQL task on the first, seventh, and thirtieth days	Nome do modelo de monitoramento.
Trend	String	abs	Tendência do resultado de monitoramento.
HistoryWarningThreshold	String	history max:40%,history min:10%	Limiar histórico para alerta de aviso.
RuleType	Integer	0	Tipo da regra de monitoramento. Valores válidos: 0: regra criada pelo sistema. 1: regra criada por um usuário. 2: regra no nível do workspace.
MatchExpression	String	dt=$[yyyymmdd]	Expressão de filtro de partição.
ProjectName	String	autotest	Nome da instância do mecanismo de computação ou da fonte de dados.
PropertyKey	String	table_count	Campo usado para associação com regras de monitoramento no frontend. Este parâmetro pode ser ignorado.
CriticalThreshold	String	40	Limiar para alerta crítico, representando o desvio do resultado de monitoramento em relação ao valor esperado. Personalize este limiar conforme suas necessidades de negócios. Se a regra de monitoramento for forte e o limiar crítico for excedido, um alerta crítico será gerado e as tarefas associadas à regra serão bloqueadas.
HistoryCriticalThreshold	String	history max:80%,history min:50%	Limiar histórico para alerta crítico.
MethodName	String	count/table_count	Nome do método usado para coletar dados de amostra, 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 ou table_count-count_distinct.
CheckerId	Integer	7	ID do verificador.
EntityId	Integer	1234	ID da expressão de filtro de partição.
ExpectValue	String	1000	Valor esperado.
TemplateId	Integer	7	ID do modelo de monitoramento.
Id	Integer	1234	ID da regra de monitoramento.
RuleName	String	test	Nome da regra de monitoramento.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.