Obter um relatório de análise pré-migração

OBTER /analysis/{projectId}/report

Obtenha um relatório de análise pré-migração.

parâmetros de caminho

projectId string Obrigatório

ID do Projeto

O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

Respostas

200 aplicação/json

OK
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- id string Obrigatório
  
  O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.
- projectId string Obrigatório
  
  O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.
- generatedAt string(data-hora) Obrigatório
- preflightChecks array[objeto]
  
  Ocultar atributos de preflightChecks Mostrar atributos de preflightChecks objeto
  
  name string Obrigatório
  
  migrationMode string Obrigatório
  
  Os valores são SNAPSHOT, CDC ou CDC_ONLY.
  
  passou booleano Obrigatório
- Regras array[objeto] Obrigatório
  
  Ocultar atributos das regras Mostrar atributos de regras objeto
  
  id string Obrigatório
  
  dboType string Obrigatório
  
  Os valores são TABLE, VIEW, ROUTINE, INDEX, TRIGGER, DATABASE ou COLUMN.
  
  ruleType string Obrigatório
  
  Os valores são TASK, RISK ou NOTICE.
  
  Nome da entidade string Obrigatório
  
  detectionText string Obrigatório
  
  dificuldade string Obrigatório
  
  Os valores são HIGH, MEDIUM ou LOW.
  
  mitigaçãoText string Obrigatório
  
  categoria string Obrigatório
  
  Os valores são DATA_TYPE, UNSUPPORTED_FEATURE, PERFORMANCE ou SCHEMA.
  
  incompatibleFeatureType string
  
  Os valores são ORACLE-PACKAGE, ROUTINE, TRIGGERS ou MATERIALIZED-VIEWS.
- dbMetrics objeto Obrigatório
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributos dbMetrics Mostrar atributos dbMetrics objeto
  
  totalDbSize integer(int64) Obrigatório
  
  readHeavyTables array[objeto] Obrigatório
  
  Ocultar atributos readHeavyTables Mostrar atributos readHeavyTables objeto
  
  database string Obrigatório
  
  schema string Obrigatório
  
  name string Obrigatório
  
  writeHeavyTables array[objeto] Obrigatório
  
  Ocultar atributos writeHeavyTables Mostrar atributos writeHeavyTables objeto
  
  database string Obrigatório
  
  schema string Obrigatório
  
  name string Obrigatório
  
  allTables array[objeto] Obrigatório
  
  Ocultar atributos allTables Mostrar atributos de allTables objeto
  
  caminho objeto Obrigatório
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributos de caminho Mostrar atributos do caminho objeto
  
  database string Obrigatório
  
  schema string Obrigatório
  
  name string Obrigatório
  
  tamanho de dados integer(int64) Obrigatório
  
  rowCount integer(int64) Obrigatório
  
  readCount integer(int64) Obrigatório
  
  writeCount integer(int64) Obrigatório
  
  readWriteClassification string Obrigatório
  
  Os valores são READ_HEAVY, WRITE_HEAVY, READ_AND_WRITE_HEAVY ou NONE.
  
  colunas objeto Obrigatório
  
  Ocultar atributo de colunas Mostrar atributo de colunas objeto
  
  * objeto Propriedades adicionais
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributos * Mostrar atributos * objeto
  
  type objeto Obrigatório
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributos de tipo Mostrar atributos de tipo objeto
  
  defaultMongoFieldType string
  
  Os valores são AUTO, STRING, INTEGER, BOOL, DOUBLE, LONG, DECIMAL, ARRAY, DATE, TIMESTAMP, OBJECT, OBJECT_ID, BIN_DATA, MIN_KEY, MAX_KEY, JAVASCRIPT, REGEX ou NULL.
  
  databaseSpecificType string Obrigatório
  
  Precisão inteiro
  
  dimensionar inteiro
  
  ordinalPosition inteiro Obrigatório
  
  O valor mínimo é 1.
  
  chave primária objeto
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributo primaryKey Mostrar atributo primaryKey objeto
  
  name string Obrigatório
  
  foreignKey objeto
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributos foreignKey Mostrar atributos foreignKey objeto
  
  name string Obrigatório
  
  schema string
  
  mesa string
  
  coluna string
  
  cardinalidade string
  
  Os valores são UNKNOWN, ZERO_TO_ONE, ONE_TO_ONE ou ZERO_TO_MANY.
  
  sintético booleano
  
  anulável booleano Obrigatório
  
  autoIncremented booleano Obrigatório
  
  gerado booleano Obrigatório
  
  escondida booleano Obrigatório
  
  indexado booleano Obrigatório
  
  uniqueIndexed booleano Obrigatório
  
  allStoredProceduras array[objeto] Obrigatório
  
  Ocultar atributos allStoredProceduras Mostrar atributos de allStoredProceduras objeto
  
  caminho objeto Obrigatório
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributos de caminho Mostrar atributos do caminho objeto
  
  database string Obrigatório
  
  schema string Obrigatório
  
  name string Obrigatório
  
  Definição string Obrigatório
  
  allTriggers array[objeto] Obrigatório
  
  Ocultar atributos de allTriggers Mostrar atributos de allTriggers objeto
  
  caminho objeto Obrigatório
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributos de caminho Mostrar atributos do caminho objeto
  
  database string Obrigatório
  
  schema string Obrigatório
  
  name string Obrigatório
  
  Definição string Obrigatório
  
  allViews array[objeto] Obrigatório
  
  Ocultar atributos allViews Mostrar atributos de allViews objeto
  
  caminho objeto Obrigatório
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributos de caminho Mostrar atributos do caminho objeto
  
  database string Obrigatório
  
  schema string Obrigatório
  
  name string Obrigatório
  
  Definição string Obrigatório
- databaseMetadata objeto Obrigatório
  
  Hide databaseMetadata attributes Mostrar atributos databaseMetadata objeto
  
  databaseVersion string
  
  ID de conexão string Obrigatório
  
  connectionName string
  
  connectionUrl string
  
  databaseType string Obrigatório
  
  Tipo de conexão string
  
  Os valores são DEMO, QA, STAGING, DEVELOPMENT, PRODUCTION ou NONE.
- healthScore número Obrigatório
- resolvidoRules array[string] Obrigatório
- tópicos array[objeto] Obrigatório
  
  Ocultar atributos de tópicos Mostrar atributos de tópicos objeto
  
  type string Obrigatório
  
  Os valores são DATA_TYPE, UNSUPPORTED_FEATURE, PERFORMANCE ou SCHEMA.
  
  valor número Obrigatório
- uniqueDboAlerts objeto Obrigatório
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributos uniqueDboAlerts Mostrar atributos uniqueDboAlerts objeto
  
  Tarefa inteiro Obrigatório
  
  risco inteiro Obrigatório
  
  notice inteiro Obrigatório
  
  none inteiro Obrigatório
- detecçãoCountsByDboType objeto Obrigatório
  
  Ocultar atributo detecçãoCountsByDboType Mostrar atributo detecçãoCountsByDboType objeto
  
  * objeto Propriedades adicionais
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributo * Mostrar atributo * objeto
  
  severityCountsByDetectionCategory objeto
  
  Ocultar atributo severityCountsByDetectionCategory Mostrar atributo severityCountsByDetectionCategory objeto
  
  * objeto
  
  Propriedades adicionais NÃO são permitidas.
  
  Ocultar atributos * Mostrar atributos * objeto
  
  Tarefa inteiro Obrigatório
  
  risco inteiro Obrigatório
  
  notice inteiro Obrigatório
  
  none inteiro Obrigatório
- errors array[string]
404 aplicação/json

Não encontrado
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- jobId string
  
  O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.
- mensagem string Obrigatório
- Descrição string
- timestamp string(data-hora) Obrigatório

GET /analysis/{projectId}/report

curl \
 --request GET 'http://127.0.0.1:8278/api/v1/analysis/{projectId}/report'

Exemplos de resposta (200)

{
  "id": "string",
  "projectId": "string",
  "generatedAt": "2025-05-04T09:42:00Z",
  "preflightChecks": [
    {
      "name": "string",
      "migrationMode": "SNAPSHOT",
      "passed": true
    }
  ],
  "rules": [
    {
      "id": "string",
      "dboType": "TABLE",
      "ruleType": "TASK",
      "entityName": "string",
      "detectionText": "string",
      "difficulty": "HIGH",
      "mitigationText": "string",
      "category": "DATA_TYPE",
      "incompatibleFeatureType": "ORACLE-PACKAGE"
    }
  ],
  "dbMetrics": {
    "totalDbSize": 42,
    "readHeavyTables": [
      {
        "database": "string",
        "schema": "string",
        "name": "string"
      }
    ],
    "writeHeavyTables": [
      {
        "database": "string",
        "schema": "string",
        "name": "string"
      }
    ],
    "allTables": [
      {
        "path": {
          "database": "string",
          "schema": "string",
          "name": "string"
        },
        "dataSize": 42,
        "rowCount": 42,
        "readCount": 42,
        "writeCount": 42,
        "readWriteClassification": "READ_HEAVY",
        "columns": {
          "additionalProperty1": {
            "type": {
              "defaultMongoFieldType": "AUTO",
              "databaseSpecificType": "string",
              "precision": 42,
              "scale": 42
            },
            "ordinalPosition": 42,
            "primaryKey": {
              "name": "string"
            },
            "foreignKey": {
              "name": "string",
              "schema": "string",
              "table": "string",
              "column": "string",
              "cardinality": "UNKNOWN",
              "synthetic": true
            },
            "nullable": true,
            "autoIncremented": true,
            "generated": true,
            "hidden": true,
            "indexed": true,
            "uniqueIndexed": true
          },
          "additionalProperty2": {
            "type": {
              "defaultMongoFieldType": "AUTO",
              "databaseSpecificType": "string",
              "precision": 42,
              "scale": 42
            },
            "ordinalPosition": 42,
            "primaryKey": {
              "name": "string"
            },
            "foreignKey": {
              "name": "string",
              "schema": "string",
              "table": "string",
              "column": "string",
              "cardinality": "UNKNOWN",
              "synthetic": true
            },
            "nullable": true,
            "autoIncremented": true,
            "generated": true,
            "hidden": true,
            "indexed": true,
            "uniqueIndexed": true
          }
        }
      }
    ],
    "allStoredProcedures": [
      {
        "path": {
          "database": "string",
          "schema": "string",
          "name": "string"
        },
        "definition": "string"
      }
    ],
    "allTriggers": [
      {
        "path": {
          "database": "string",
          "schema": "string",
          "name": "string"
        },
        "definition": "string"
      }
    ],
    "allViews": [
      {
        "path": {
          "database": "string",
          "schema": "string",
          "name": "string"
        },
        "definition": "string"
      }
    ]
  },
  "databaseMetadata": {
    "databaseVersion": "string",
    "connectionId": "string",
    "connectionName": "string",
    "connectionUrl": "string",
    "databaseType": "string",
    "connectionType": "DEMO"
  },
  "healthScore": 42.0,
  "resolvedRules": [
    "string"
  ],
  "takeaways": [
    {
      "type": "DATA_TYPE",
      "value": 42.0
    }
  ],
  "uniqueDboAlerts": {
    "task": 42,
    "risk": 42,
    "notice": 42,
    "none": 42
  },
  "detectionCountsByDboType": {
    "additionalProperty1": {
      "severityCountsByDetectionCategory": {
        "*": {
          "task": 42,
          "risk": 42,
          "notice": 42,
          "none": 42
        }
      }
    },
    "additionalProperty2": {
      "severityCountsByDetectionCategory": {
        "*": {
          "task": 42,
          "risk": 42,
          "notice": 42,
          "none": 42
        }
      }
    }
  },
  "errors": [
    "string"
  ]
}

Exemplos de resposta (404)

{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}