Chama CreateQualityRule para criar uma regra 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 intensidade da regra. Valores válidos:
|
0 |
| EntityId |
integer |
Sim |
O ID da expressão de filtro de partição. |
15224 |
| Comment |
string |
Não |
Os comentários 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 verificação. Se você usar uma instrução SQL personalizada, defina este parâmetro como user_defined. |
count/table_count |
| Operator |
string |
Não |
O operador de comparação. Exemplos: >, >=, =, <>, < e <=. Nota
Se você definir o parâmetro Checker como 9, deverá especificar o parâmetro Operator. |
> |
| ProjectName |
string |
Sim |
O nome do motor de computação ou da fonte de dados. |
autotest |
| Property |
string |
Não |
O campo monitorado pela regra. Para realizar uma verificação em nível de tabela, defina este parâmetro como table_count para o número de linhas ou table_size para o tamanho da tabela. |
table_id |
| PropertyType |
string |
Não |
O tipo de dados do campo. Para uma verificação em nível de tabela, defina este parâmetro como table. Para uma verificação em nível de campo, defina este parâmetro como um tipo de dados específico, como bigint. |
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 crítico. Indica o desvio do resultado da verificação em relação ao valor esperado. Você pode personalizar este limite com base nos seus requisitos de negócio. Se uma regra forte for usada e um alerta crítico for acionado, a tarefa de agendamento será bloqueada. |
20 |
| WarningThreshold |
string |
Não |
O limite de aviso. Indica o desvio do resultado da verificação em relação ao valor esperado. Você pode personalizar este limite com base nos seus requisitos de negócio. |
10 |
| TemplateId |
integer |
Não |
O ID do modelo. |
7 |
| RuleName |
string |
Sim |
O nome da regra. |
1234 |
| PredictType |
integer |
Sim |
Especifica se um limite dinâmico deve ser usado. Valores válidos: |
0 |
| ProjectId |
integer |
Sim |
O ID do workspace do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Gerenciamento de 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 nova regra. |
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 solicitação 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.