As tabelas a seguir listam as operações de API disponíveis no Data Management (DMS).
Pedidos
|
API |
Descrição |
|
Adquire um recurso do DMS com pagamento conforme o uso. |
|
|
Cancela a assinatura de um recurso do DMS com pagamento conforme o uso. |
|
|
Consulta informações sobre pedidos vigentes. |
Gerenciamento de usuários
|
API |
Descrição |
|
Adiciona um usuário à empresa. |
|
|
Desativa um usuário temporariamente inativo. |
|
|
Reativa um usuário desativado. |
|
|
Remove um usuário desnecessário. |
|
|
Atualiza as informações de um usuário. |
|
|
Consulta os usuários cadastrados. |
|
|
Lista os tenants disponíveis. |
|
|
Obtém informações sobre o tenant atual. |
|
|
Recupera detalhes de um usuário específico. |
Gerenciamento de instâncias
|
API |
Descrição |
|
Registra uma instância de banco de dados na empresa. |
|
|
Atualiza os dados de uma instância de banco de dados e verifica sua conectividade. |
|
|
Consulta os detalhes de uma instância de banco de dados. |
|
|
Remove uma instância de banco de dados do DMS Enterprise. |
|
|
Lista instâncias de banco de dados e seus respectivos detalhes. |
Auditoria de operações
|
API |
Descrição |
|
Consulta detalhes dos logs de operação gerados em um período especificado. |
|
|
Recupera logs de auditoria de execuções SQL. |
|
|
Lista logs de auditoria para endpoints de proxy gerados pelo recurso de proxy de acesso seguro. |
|
|
Consulta registros de login em uma instância. |
|
|
Obtém logs de auditoria relacionados a dados sensíveis. |
Gerenciamento de processos de aprovação
|
API |
Descrição |
|
Consulta nós de aprovação. |
|
|
Lista modelos de aprovação. |
Gerenciamento de metadados de bancos de dados e tabelas
|
API |
Descrição |
|
Pesquisa um banco de dados. |
|
|
Pesquisa uma tabela. |
|
|
Lista os bancos de dados em uma instância. |
|
|
Consulta as tabelas existentes em um banco de dados. |
|
|
Lista as colunas de uma tabela. |
|
|
Consulta os índices de uma tabela. |
|
|
Obtém detalhes de um banco de dados. |
|
|
Recupera informações detalhadas de um banco de dados físico. |
|
|
Consulta a topologia de uma tabela. |
|
|
Obtém detalhes sobre colunas e índices de uma tabela. |
|
|
Consulta informações detalhadas das colunas de uma tabela. |
|
|
Sincroniza os metadados de todos os bancos de dados em uma instância. |
|
|
Sincroniza os metadados de um banco de dados específico. |
Bancos de dados e tabelas lógicos
|
API |
Descrição |
|
Cria um banco de dados lógico no DMS. |
|
|
Modifica as informações de um banco de dados lógico. |
|
|
Exclui um banco de dados lógico do DMS. |
|
|
Consulta detalhes de bancos de dados lógicos. |
|
|
Obtém detalhes de um banco de dados lógico específico. |
|
|
Consulta um banco de dados lógico e a topologia do shard de banco de dados físico correspondente. |
|
|
Lista as tabelas lógicas em um banco de dados lógico. |
|
|
Consulta a topologia de uma tabela em um banco de dados lógico e o shard de banco de dados físico correspondente. |
|
|
Adiciona um algoritmo de roteamento a uma tabela lógica. |
|
|
Remove um algoritmo de roteamento de uma tabela lógica. |
|
|
Consulta algoritmos de roteamento de uma tabela lógica. |
Gerenciamento de tickets
| Categoria | API | Descrição |
| Operações gerais | ApproveOrder | Aprova um ticket. |
| CloseOrder | Fecha um ticket. | |
| GetApprovalDetail | Consulta os detalhes de aprovação de um ticket. | |
| GetOrderBaseInfo | Obtém informações básicas sobre um ticket. | |
| ListOrders | Lista os tickets existentes. | |
| CreateOrder | Cria um novo ticket. | |
| SubmitOrderApproval | Envia um ticket para aprovação. | |
| Solicitação de permissão | GetOwnerApplyOrderDetail | Consulta detalhes de um ticket usado para configurar o proprietário de uma instância, banco de dados ou tabela. |
| GetPermApplyOrderDetail | Obtém detalhes de um ticket de solicitação de permissões. | |
| Sincronização de tabelas entre bancos de dados | CreateStructSyncOrder | Cria um ticket de sincronização de schema. |
| GetStructSyncOrderDetail | Consulta detalhes de um ticket de sincronização de schema. | |
| GetStructSyncJobDetail | Obtém detalhes de uma tarefa de sincronização de schema. | |
| GetStructSyncJobAnalyzeResult | Recupera o resultado da análise de uma tarefa de sincronização de schema. | |
| GetStructSyncExecSqlDetail | Consulta as instruções SQL envolvidas em um ticket de sincronização de schema. | |
| SubmitStructSyncOrderApproval | Envia um ticket de sincronização de schema para aprovação. | |
| ExecuteStructSync | Executa um ticket de sincronização de schema. | |
| Alteração de dados | CreateDataCorrectOrder | Cria um ticket de alteração de dados. |
| CreateDataCronClearOrder | Cria um ticket para limpeza de dados históricos. | |
| CreateDataImportOrder | Cria um ticket de importação de dados. | |
| CreateFreeLockCorrectOrder | Cria um ticket de alteração sem bloqueio. | |
| ExecuteDataCorrect | Executa um ticket de alteração de dados. | |
| GetDataCorrectTaskDetail | Consulta detalhes de uma tarefa usada para alterar dados, executar alterações sem bloqueio ou importar dados. | |
| GetDataCronClearTaskDetailList | Lista tarefas de limpeza de dados históricos. | |
| GetDataCorrectOrderDetail | Obtém detalhes de um ticket de alteração de dados. | |
| GetDataCorrectBackupFiles | Consulta a URL de baixe dos arquivos de backup de um ticket de alteração de dados. | |
| GetDataCorrectSQLFile | Recupera o anexo SQL de um ticket de alteração de dados. | |
| ModifyDataCorrectExecSQL | Modifica o script SQL enviado por meio de um ticket de alteração de dados. | |
| ListDataCorrectPreCheckSQL | Consulta informações de pré-verificação de uma instrução SQL especificada em um ticket de alteração de dados. | |
| ListDataCorrectPreCheckDB | Lista os bancos de dados envolvidos na pré-verificação de um ticket de alteração de dados. | |
| PauseDataCorrectSQLJob | Pausa uma tarefa SQL de alteração de dados. | |
| RetryDataCorrectPreCheck | Reexecuta a pré-verificação de um ticket de alteração de dados. | |
| RestartDataCorrectSQLJob | Reinicia uma tarefa SQL de alteração de dados que falhou. | |
| Design de schema | CreatePublishGroupTask | Executa um ticket de design de schema. |
| ListDDLPublishRecords | Consulta os detalhes de publicação de um ticket de design de schema. | |
| Exportação de dados | GetDataExportDownloadURL | Obtém a URL de baixe dos resultados de exportação de um ticket de exportação de dados. |
| ExecuteDataExport | Executa um ticket de exportação de dados. | |
| GetDataExportOrderDetail | Consulta detalhes de um ticket de exportação de dados. | |
| Revisão de SQL | CreateSQLReviewOrder | Cria um ticket de revisão de SQL. |
| GetSQLReviewCheckResultStatus | Consulta o resultado da revisão de um ticket de revisão de SQL. | |
| ListSQLReviewOriginSQL | Obtém detalhes das instruções SQL envolvidas em um ticket de revisão de SQL. | |
| GetSQLReviewOptimizeDetail | Consulta detalhes das sugestões de otimização de SQL. | |
| Upload de arquivo | CreateUploadFileJob | Cria uma tarefa de upload de arquivo. |
| CreateUploadOSSFileJob | Cria uma tarefa para fazer upload de um objeto do Object Storage Service (OSS). | |
| GetUserUploadFileJob | Consulta informações sobre uma tarefa de upload de arquivo. |
Gerenciamento de tarefas SQL
|
API |
Descrição |
|
Consulta tarefas SQL. |
|
|
Obtém detalhes de uma tarefa SQL. |
|
|
Consulta o log que registra detalhes de agendamento de uma tarefa SQL. |
|
|
Verifica o progresso de uma tarefa de Online DDL. |
Gerenciamento de permissões
|
API |
Descrição |
|
Defina os proprietários de uma instância, banco de dados ou tabela. |
|
|
Revoga a permissão de um usuário sobre um recurso. |
|
|
Consulta as permissões de um usuário em bancos de dados e tabelas. |
|
|
Lista as permissões dos usuários em um banco de dados. |
|
|
Concede permissões em um banco de dados ou tabela a um usuário. |
|
|
Consulta as permissões de um usuário em uma instância. |
Gerenciamento de segurança
| Categoria | API | Descrição |
| Gerenciamento de conjuntos de regras de segurança | CreateStandardGroup | Cria um conjunto de regras de segurança. |
| ListStandardGroups | Consulta conjuntos de regras de segurança. | |
| Proxy de acesso seguro | CreateProxy | Ativa o recurso de proxy de acesso seguro para uma instância de banco de dados. |
| CreateProxyAccess | Autoriza um usuário a acessar uma instância de banco de dados usando os endpoints de proxy gerados pelo recurso de proxy de acesso seguro. | |
| ListProxyAccesses | Lista usuários autorizados a acessar uma instância de banco de dados via endpoints de proxy gerados pelo recurso de proxy de acesso seguro. | |
| InspectProxyAccessSecret | Consulta o segredo da AccessKey que um usuário autorizado utiliza para conectar-se aos endpoints de proxy gerados pelo recurso de proxy de acesso seguro de uma instância de banco de dados. | |
| ListProxies | Lista os endpoints de proxy gerados pelo recurso de proxy de acesso seguro. | |
| GetProxy | Obtém detalhes de um endpoint de proxy gerado pelo recurso de proxy de acesso seguro. | |
| DeleteProxyAccess | Revoga permissões de um usuário autorizado que não acessa mais uma instância de banco de dados pelos endpoints de proxy gerados pelo recurso de proxy de acesso seguro. | |
| DeleteProxy | Desativa o recurso de proxy de acesso seguro para uma instância de banco de dados. | |
| Gerenciamento de campos sensíveis | ListSensitiveColumns | Consulta campos sensíveis. |
| ListSensitiveColumnsDetail | Obtém detalhes de um campo sensível. | |
| AddDesensitizationRule | Adiciona uma regra de mascaramento. | |
| ListDesensitizationRule | Lista regras de mascaramento. | |
| ModifyDesensitizationStrategy | Modifica a regra de mascaramento vinculada a um campo específico. | |
| ListClassificationTemplates | Consulta modelos de classificação. | |
| ChangeColumnSecLevel | Ajusta o nível de sensibilidade de um campo. |
Consulta de dados
|
API |
Descrição |
|
Executa instruções SQL. |
Desenvolvimento de dados
| Categoria | API | Descrição |
| Desenvolvimento de data warehouse | CreateLakeHouseSpace | Cria um workspace para desenvolvimento de data warehouse. |
| GetLhSpaceByName | Consulta detalhes de um workspace identificado pelo nome especificado. | |
| DeleteLakeHouseSpace | Exclui um workspace de desenvolvimento de data warehouse. | |
| ListLhTaskFlowAndScenario | Consulta informações sobre fluxos de tarefas correspondentes a diferentes cenários de negócios em um workspace de desenvolvimento de data warehouse. | |
| AddLhMembers | Adiciona um ou mais administradores, membros ou desenvolvedores de fluxo de tarefas a um workspace de desenvolvimento de data warehouse. | |
| DeleteLhMembers | Remove um ou mais membros ou desenvolvedores de fluxo de tarefas de um workspace de desenvolvimento de data warehouse. | |
| ChangeLhDagOwner | Altera o proprietário de um fluxo de tarefas. | |
| Orquestração de tarefas | ListTaskFlow | Consulta fluxos de tarefas. |
| DeleteTaskFlow | Exclui um fluxo de tarefas. | |
| OfflineTaskFlow | Retira de publicação um fluxo de tarefas publicado. | |
| ListTaskFlowInstance | Consulta registros de execução de um fluxo de tarefas. | |
| GetTaskInstanceRelation | Obtém informações sobre os nós em um registro de execução de fluxo de tarefas. | |
| ListDAGVersions | Lista as versões publicadas de um fluxo de tarefas. | |
| ReDeployLhDagVersion | Reimplanta uma ou todas as versões publicadas de um fluxo de tarefas. | |
| CreateTaskFlow | Cria um fluxo de tarefas. | |
| DeleteTask | Exclui uma tarefa em um fluxo de tarefas especificado. | |
| MakeTaskFlowInstanceSuccess | Define o status de um fluxo de tarefas especificado como "Successful". | |
| SuspendTaskFlowInstance | Suspende uma instância de fluxo de tarefas em execução. | |
| PublishAndDeployTaskFlow | Publica e implanta um fluxo de tarefas especificado. | |
| ListTasksInTaskFlow | Consulta as tarefas em um fluxo de tarefas especificado. | |
| UpdateTaskConfig | Atualiza a configuração avançada de uma tarefa especificada. | |
| ListTaskFlowConstants | Consulta as constantes de um fluxo de tarefas especificado. | |
| UpdateTaskFlowConstants | Atualiza as constantes de um fluxo de tarefas especificado. | |
| ResumeTaskFlowInstance | Retoma um fluxo de tarefas suspenso. | |
| ListTaskFlowsByPage | Consulta registros de execução de fluxos de tarefas paginados. | |
| UpdateTaskContent | Atualiza a configuração de um nó de tarefa especificado. | |
| UpdateScenario | Atualiza o nome e a descrição de um cenário de negócios especificado de um fluxo de tarefas. | |
| ListScenarios | Consulta os cenários de negócios. | |
| DeleteScenario | Exclui um cenário de negócios. | |
| CreateScenario | Cria um cenário de negócios. | |
| UpdateTaskTimeVariables | Atualiza as variáveis de tempo de uma tarefa especificada. | |
| UpdateTaskFlowTimeVariables | Atualiza as variáveis de tempo de um fluxo de tarefas especificado. | |
| ListTaskFlowTimeVariables | Consulta as variáveis de tempo de um fluxo de tarefas especificado. | |
| UpdateTaskFlowCooperators | Atualiza os usuários envolvidos em um fluxo de tarefas especificado. | |
| MoveTaskFlowToScenario | Move um fluxo de tarefas para um cenário de negócios especificado. | |
| UpdateTaskName | Atualiza o nome de um nó de tarefa especificado. | |
| ListTaskFlowCooperators | Lista os usuários envolvidos em um fluxo de tarefas especificado. | |
| UpdateTaskOutput | Atualiza as variáveis de saída de um nó de tarefa especificado. | |
| GetTask | Consulta a configuração de um nó de tarefa especificado, incluindo suas variáveis de tempo. | |
| UpdateTaskFlowSchedule | Atualiza as configurações de agendamento de um fluxo de tarefas especificado. | |
| StopTaskFlowInstance | Para uma instância de fluxo de tarefas em execução. | |
| ReRunTaskFlowInstance | Reexecuta uma instância de fluxo de tarefas. | |
| CreateTask | Cria um nó de tarefa para um fluxo de tarefas especificado. | |
| UpdateTaskFlowNotification | Atualiza as configurações de notificação para fluxos de tarefas. | |
| DeleteTaskFlowEdgesByCondition | Exclui arestas de fluxo de tarefas com base em múltiplas condições. | |
| ListTaskFlowEdgesByCondition | Consulta as arestas do grafo acíclico dirigido (DAG) de um fluxo de tarefas especificado com base em múltiplas condições. | |
| UpdateTaskFlowEdges | Atualiza simultaneamente vários nós iniciais e finais de arestas especificadas de um fluxo de tarefas. | |
| GetTaskFlowGraph | Consulta o DAG de um fluxo de tarefas. | |
| UpdateTaskFlowRelations | Atualiza todas as arestas de um fluxo de tarefas especificado. | |
| UpdateTaskFlowNameAndDesc | Atualiza o nome e a descrição de um fluxo de tarefas especificado. | |
| UpdateTaskFlowOwner | Atualiza o proprietário de um fluxo de tarefas especificado. | |
| BackFill | Realiza backfill de dados para orquestração de tarefas. |