Cria uma regra de monitoramento de qualidade.
Esta API foi descontinuada. Recomendamos migrar para dataworks-public(2024-05-18) - CreateDataQualityScan para funcionalidade aprimorada e suporte contínuo. Embora a API descontinuada permaneça temporariamente acessível, nenhuma atualização ou correção de bugs será fornecida.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| BlockType |
integer |
Sim |
A força da regra. Valores válidos:
|
0 |
| EntityId |
integer |
Sim |
O ID da expressão de partição. |
15224 |
| Comment |
string |
Não |
A descrição da regra. |
Verification |
| Checker |
integer |
Não |
O ID do verificador. Valores válidos:
|
9 |
| ExpectValue |
string |
Não |
O valor esperado. |
0 |
| Trend |
string |
Não |
A tendência do resultado da verificação. Valores válidos:
|
abs |
| MethodName |
string |
Não |
O método de amostragem. Se for usado SQL personalizado, o valor deste parâmetro é user_defined. |
count/table_count |
| Operator |
string |
Não |
O operador de comparação. Os valores válidos incluem >, >=, =, ≠, < e <=. Nota
Quando Checker é definido como 9, Operator é obrigatório. |
> |
| ProjectName |
string |
Sim |
O nome do motor ou da fonte de dados. |
autotest |
| Property |
string |
Não |
A coluna à qual a regra se aplica. Para verificações no nível da tabela, as colunas são table_count para o número de linhas e table_size para o tamanho da tabela. |
table_id |
| PropertyType |
string |
Não |
O tipo da coluna. Insira table para verificações no nível da tabela ou um tipo de dados como bigint para verificações no nível da coluna. |
bigint |
| RuleType |
integer |
Sim |
O tipo da regra. Valores válidos:
|
0 |
| WhereCondition |
string |
Não |
A condição de filtro ou instrução SQL personalizada. |
table_id>1 |
| CriticalThreshold |
string |
Não |
O limite para um alerta crítico, que indica o grau de desvio em relação ao valor de amostra esperado. Você pode personalizar esse limite com base nos seus requisitos de negócios. Se uma regra forte for usada e o limite crítico for acionado, a tarefa de agendamento será bloqueada. |
20 |
| WarningThreshold |
string |
Não |
O limite para um alerta de aviso, que indica o grau de desvio em relação ao valor de amostra esperado. Você pode personalizar esse limite com base nos seus requisitos de negócios. |
10 |
| TemplateId |
integer |
Não |
O ID do modelo. |
7 |
| RuleName |
string |
Sim |
O nome da regra. |
1234 |
| PredictType |
integer |
Sim |
Especifica se o limite é dinâmico. Valores válidos:
|
0 |
| ProjectId |
integer |
Não |
O ID do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do workspace para obter o ID do workspace. |
10000 |
| TaskSetting |
string |
Não |
As configurações de variáveis inseridas antes da regra personalizada. Formato: x=a,y=b. |
x=a,y=b |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Os parâmetros de resposta. |
||
| HttpStatusCode |
integer |
O código de status HTTP. |
200 |
| Data |
string |
O ID da regra criada. |
12345 |
| ErrorMessage |
string |
A mensagem de erro. |
You have no permission. |
| RequestId |
string |
O ID da solicitação. |
ecb967ec-c137-48**** |
| ErrorCode |
string |
O código de erro. |
401 |
| Success |
boolean |
Indica se a chamada foi bem-sucedida. |
true |
Exemplos
Resposta de sucesso
JSON formato
{
"HttpStatusCode": 200,
"Data": "12345",
"ErrorMessage": "You have no permission.",
"RequestId": "ecb967ec-c137-48****",
"ErrorCode": "401",
"Success": true
}Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.