Todos os produtos
Search
Central de documentação

:Lista de operações por função

Última atualização: Jul 04, 2026

As tabelas a seguir listam as operações de API disponíveis no Data Management (DMS).

Pedidos

API

Descrição

BuyPayAsYouGoOrder

Adquire um recurso do DMS com pagamento conforme o uso.

RefundPayAsYouGoOrder

Cancela a assinatura de um recurso do DMS com pagamento conforme o uso.

ListEffectiveOrders

Consulta informações sobre pedidos vigentes.

Gerenciamento de usuários

API

Descrição

RegisterUser

Adiciona um usuário à empresa.

DisableUser

Desativa um usuário temporariamente inativo.

EnableUser

Reativa um usuário desativado.

DeleteUser

Remove um usuário desnecessário.

UpdateUser

Atualiza as informações de um usuário.

ListUsers

Consulta os usuários cadastrados.

ListUserTenants

Lista os tenants disponíveis.

GetUserActiveTenant

Obtém informações sobre o tenant atual.

GetUser

Recupera detalhes de um usuário específico.

Gerenciamento de instâncias

API

Descrição

RegisterInstance

Registra uma instância de banco de dados na empresa.

UpdateInstance

Atualiza os dados de uma instância de banco de dados e verifica sua conectividade.

GetInstance

Consulta os detalhes de uma instância de banco de dados.

DeleteInstance

Remove uma instância de banco de dados do DMS Enterprise.

ListInstances

Lista instâncias de banco de dados e seus respectivos detalhes.

Auditoria de operações

API

Descrição

GetOpLog

Consulta detalhes dos logs de operação gerados em um período especificado.

ListSQLExecAuditLog

Recupera logs de auditoria de execuções SQL.

ListProxySQLExecAuditLog

Lista logs de auditoria para endpoints de proxy gerados pelo recurso de proxy de acesso seguro.

ListInstanceLoginAuditLog

Consulta registros de login em uma instância.

ListSensitiveDataAuditLog

Obtém logs de auditoria relacionados a dados sensíveis.

Gerenciamento de processos de aprovação

API

Descrição

ListWorkFlowNodes

Consulta nós de aprovação.

ListWorkFlowTemplates

Lista modelos de aprovação.

Gerenciamento de metadados de bancos de dados e tabelas

API

Descrição

SearchDatabase

Pesquisa um banco de dados.

SearchTable

Pesquisa uma tabela.

ListDatabases

Lista os bancos de dados em uma instância.

ListTables

Consulta as tabelas existentes em um banco de dados.

ListColumns

Lista as colunas de uma tabela.

ListIndexes

Consulta os índices de uma tabela.

GetDatabase

Obtém detalhes de um banco de dados.

GetPhysicalDatabase

Recupera informações detalhadas de um banco de dados físico.

GetTableTopology

Consulta a topologia de uma tabela.

GetMetaTableDetailInfo

Obtém detalhes sobre colunas e índices de uma tabela.

GetMetaTableColumn

Consulta informações detalhadas das colunas de uma tabela.

SyncInstanceMeta

Sincroniza os metadados de todos os bancos de dados em uma instância.

SyncDatabaseMeta

Sincroniza os metadados de um banco de dados específico.

Bancos de dados e tabelas lógicos

API

Descrição

CreateLogicDatabase

Cria um banco de dados lógico no DMS.

EditLogicDatabase

Modifica as informações de um banco de dados lógico.

DeleteLogicDatabase

Exclui um banco de dados lógico do DMS.

ListLogicDatabases

Consulta detalhes de bancos de dados lógicos.

GetLogicDatabase

Obtém detalhes de um banco de dados lógico específico.

GetDBTopology

Consulta um banco de dados lógico e a topologia do shard de banco de dados físico correspondente.

ListLogicTables

Lista as tabelas lógicas em um banco de dados lógico.

GetTableDBTopology

Consulta a topologia de uma tabela em um banco de dados lógico e o shard de banco de dados físico correspondente.

AddLogicTableRouteConfig

Adiciona um algoritmo de roteamento a uma tabela lógica.

DeleteLogicTableRouteConfig

Remove um algoritmo de roteamento de uma tabela lógica.

ListLogicTableRouteConfig

Consulta algoritmos de roteamento de uma tabela lógica.

Gerenciamento de tickets

CategoriaAPIDescrição
Operações geraisApproveOrderAprova um ticket.
CloseOrderFecha um ticket.
GetApprovalDetailConsulta os detalhes de aprovação de um ticket.
GetOrderBaseInfoObtém informações básicas sobre um ticket.
ListOrdersLista os tickets existentes.
CreateOrderCria um novo ticket.
SubmitOrderApprovalEnvia um ticket para aprovação.
Solicitação de permissãoGetOwnerApplyOrderDetailConsulta detalhes de um ticket usado para configurar o proprietário de uma instância, banco de dados ou tabela.
GetPermApplyOrderDetailObtém detalhes de um ticket de solicitação de permissões.
Sincronização de tabelas entre bancos de dadosCreateStructSyncOrderCria um ticket de sincronização de schema.
GetStructSyncOrderDetailConsulta detalhes de um ticket de sincronização de schema.
GetStructSyncJobDetailObtém detalhes de uma tarefa de sincronização de schema.
GetStructSyncJobAnalyzeResultRecupera o resultado da análise de uma tarefa de sincronização de schema.
GetStructSyncExecSqlDetailConsulta as instruções SQL envolvidas em um ticket de sincronização de schema.
SubmitStructSyncOrderApprovalEnvia um ticket de sincronização de schema para aprovação.
ExecuteStructSyncExecuta um ticket de sincronização de schema.
Alteração de dadosCreateDataCorrectOrderCria um ticket de alteração de dados.
CreateDataCronClearOrderCria um ticket para limpeza de dados históricos.
CreateDataImportOrderCria um ticket de importação de dados.
CreateFreeLockCorrectOrderCria um ticket de alteração sem bloqueio.
ExecuteDataCorrectExecuta um ticket de alteração de dados.
GetDataCorrectTaskDetailConsulta detalhes de uma tarefa usada para alterar dados, executar alterações sem bloqueio ou importar dados.
GetDataCronClearTaskDetailListLista tarefas de limpeza de dados históricos.
GetDataCorrectOrderDetailObtém detalhes de um ticket de alteração de dados.
GetDataCorrectBackupFilesConsulta a URL de baixe dos arquivos de backup de um ticket de alteração de dados.
GetDataCorrectSQLFileRecupera o anexo SQL de um ticket de alteração de dados.
ModifyDataCorrectExecSQLModifica o script SQL enviado por meio de um ticket de alteração de dados.
ListDataCorrectPreCheckSQLConsulta informações de pré-verificação de uma instrução SQL especificada em um ticket de alteração de dados.
ListDataCorrectPreCheckDBLista os bancos de dados envolvidos na pré-verificação de um ticket de alteração de dados.
PauseDataCorrectSQLJobPausa uma tarefa SQL de alteração de dados.
RetryDataCorrectPreCheckReexecuta a pré-verificação de um ticket de alteração de dados.
RestartDataCorrectSQLJobReinicia uma tarefa SQL de alteração de dados que falhou.
Design de schemaCreatePublishGroupTaskExecuta um ticket de design de schema.
ListDDLPublishRecordsConsulta os detalhes de publicação de um ticket de design de schema.
Exportação de dadosGetDataExportDownloadURLObtém a URL de baixe dos resultados de exportação de um ticket de exportação de dados.
ExecuteDataExportExecuta um ticket de exportação de dados.
GetDataExportOrderDetailConsulta detalhes de um ticket de exportação de dados.
Revisão de SQLCreateSQLReviewOrderCria um ticket de revisão de SQL.
GetSQLReviewCheckResultStatusConsulta o resultado da revisão de um ticket de revisão de SQL.
ListSQLReviewOriginSQLObtém detalhes das instruções SQL envolvidas em um ticket de revisão de SQL.
GetSQLReviewOptimizeDetailConsulta detalhes das sugestões de otimização de SQL.
Upload de arquivoCreateUploadFileJobCria uma tarefa de upload de arquivo.
CreateUploadOSSFileJobCria uma tarefa para fazer upload de um objeto do Object Storage Service (OSS).
GetUserUploadFileJobConsulta informações sobre uma tarefa de upload de arquivo.

Gerenciamento de tarefas SQL

API

Descrição

ListDBTaskSQLJob

Consulta tarefas SQL.

ListDBTaskSQLJobDetail

Obtém detalhes de uma tarefa SQL.

GetDBTaskSQLJobLog

Consulta o log que registra detalhes de agendamento de uma tarefa SQL.

GetOnlineDDLProgress

Verifica o progresso de uma tarefa de Online DDL.

Gerenciamento de permissões

API

Descrição

SetOwners

Defina os proprietários de uma instância, banco de dados ou tabela.

RevokeUserPermission

Revoga a permissão de um usuário sobre um recurso.

ListUserPermissions

Consulta as permissões de um usuário em bancos de dados e tabelas.

ListDatabaseUserPermssions

Lista as permissões dos usuários em um banco de dados.

GrantUserPermission

Concede permissões em um banco de dados ou tabela a um usuário.

ListInstanceUserPermissions

Consulta as permissões de um usuário em uma instância.

Gerenciamento de segurança

CategoriaAPIDescrição
Gerenciamento de conjuntos de regras de segurançaCreateStandardGroupCria um conjunto de regras de segurança.
ListStandardGroupsConsulta conjuntos de regras de segurança.
Proxy de acesso seguroCreateProxyAtiva o recurso de proxy de acesso seguro para uma instância de banco de dados.
CreateProxyAccessAutoriza 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.
ListProxyAccessesLista usuários autorizados a acessar uma instância de banco de dados via endpoints de proxy gerados pelo recurso de proxy de acesso seguro.
InspectProxyAccessSecretConsulta 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.
ListProxiesLista os endpoints de proxy gerados pelo recurso de proxy de acesso seguro.
GetProxyObtém detalhes de um endpoint de proxy gerado pelo recurso de proxy de acesso seguro.
DeleteProxyAccessRevoga 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.
DeleteProxyDesativa o recurso de proxy de acesso seguro para uma instância de banco de dados.
Gerenciamento de campos sensíveisListSensitiveColumnsConsulta campos sensíveis.
ListSensitiveColumnsDetailObtém detalhes de um campo sensível.
AddDesensitizationRuleAdiciona uma regra de mascaramento.
ListDesensitizationRuleLista regras de mascaramento.
ModifyDesensitizationStrategyModifica a regra de mascaramento vinculada a um campo específico.
ListClassificationTemplatesConsulta modelos de classificação.
ChangeColumnSecLevelAjusta o nível de sensibilidade de um campo.

Consulta de dados

API

Descrição

ExecuteScript

Executa instruções SQL.

Desenvolvimento de dados

CategoriaAPIDescrição
Desenvolvimento de data warehouseCreateLakeHouseSpaceCria um workspace para desenvolvimento de data warehouse.
GetLhSpaceByNameConsulta detalhes de um workspace identificado pelo nome especificado.
DeleteLakeHouseSpaceExclui um workspace de desenvolvimento de data warehouse.
ListLhTaskFlowAndScenarioConsulta informações sobre fluxos de tarefas correspondentes a diferentes cenários de negócios em um workspace de desenvolvimento de data warehouse.
AddLhMembersAdiciona um ou mais administradores, membros ou desenvolvedores de fluxo de tarefas a um workspace de desenvolvimento de data warehouse.
DeleteLhMembersRemove um ou mais membros ou desenvolvedores de fluxo de tarefas de um workspace de desenvolvimento de data warehouse.
ChangeLhDagOwnerAltera o proprietário de um fluxo de tarefas.
Orquestração de tarefasListTaskFlowConsulta fluxos de tarefas.
DeleteTaskFlowExclui um fluxo de tarefas.
OfflineTaskFlowRetira de publicação um fluxo de tarefas publicado.
ListTaskFlowInstanceConsulta registros de execução de um fluxo de tarefas.
GetTaskInstanceRelationObtém informações sobre os nós em um registro de execução de fluxo de tarefas.
ListDAGVersionsLista as versões publicadas de um fluxo de tarefas.
ReDeployLhDagVersionReimplanta uma ou todas as versões publicadas de um fluxo de tarefas.
CreateTaskFlowCria um fluxo de tarefas.
DeleteTaskExclui uma tarefa em um fluxo de tarefas especificado.
MakeTaskFlowInstanceSuccessDefine o status de um fluxo de tarefas especificado como "Successful".
SuspendTaskFlowInstanceSuspende uma instância de fluxo de tarefas em execução.
PublishAndDeployTaskFlowPublica e implanta um fluxo de tarefas especificado.
ListTasksInTaskFlowConsulta as tarefas em um fluxo de tarefas especificado.
UpdateTaskConfigAtualiza a configuração avançada de uma tarefa especificada.
ListTaskFlowConstantsConsulta as constantes de um fluxo de tarefas especificado.
UpdateTaskFlowConstantsAtualiza as constantes de um fluxo de tarefas especificado.
ResumeTaskFlowInstanceRetoma um fluxo de tarefas suspenso.
ListTaskFlowsByPageConsulta registros de execução de fluxos de tarefas paginados.
UpdateTaskContentAtualiza a configuração de um nó de tarefa especificado.
UpdateScenarioAtualiza o nome e a descrição de um cenário de negócios especificado de um fluxo de tarefas.
ListScenariosConsulta os cenários de negócios.
DeleteScenarioExclui um cenário de negócios.
CreateScenarioCria um cenário de negócios.
UpdateTaskTimeVariablesAtualiza as variáveis de tempo de uma tarefa especificada.
UpdateTaskFlowTimeVariablesAtualiza as variáveis de tempo de um fluxo de tarefas especificado.
ListTaskFlowTimeVariablesConsulta as variáveis de tempo de um fluxo de tarefas especificado.
UpdateTaskFlowCooperatorsAtualiza os usuários envolvidos em um fluxo de tarefas especificado.
MoveTaskFlowToScenarioMove um fluxo de tarefas para um cenário de negócios especificado.
UpdateTaskNameAtualiza o nome de um nó de tarefa especificado.
ListTaskFlowCooperatorsLista os usuários envolvidos em um fluxo de tarefas especificado.
UpdateTaskOutputAtualiza as variáveis de saída de um nó de tarefa especificado.
GetTaskConsulta a configuração de um nó de tarefa especificado, incluindo suas variáveis de tempo.
UpdateTaskFlowScheduleAtualiza as configurações de agendamento de um fluxo de tarefas especificado.
StopTaskFlowInstancePara uma instância de fluxo de tarefas em execução.
ReRunTaskFlowInstanceReexecuta uma instância de fluxo de tarefas.
CreateTaskCria um nó de tarefa para um fluxo de tarefas especificado.
UpdateTaskFlowNotificationAtualiza as configurações de notificação para fluxos de tarefas.
DeleteTaskFlowEdgesByConditionExclui arestas de fluxo de tarefas com base em múltiplas condições.
ListTaskFlowEdgesByConditionConsulta as arestas do grafo acíclico dirigido (DAG) de um fluxo de tarefas especificado com base em múltiplas condições.
UpdateTaskFlowEdgesAtualiza simultaneamente vários nós iniciais e finais de arestas especificadas de um fluxo de tarefas.
GetTaskFlowGraphConsulta o DAG de um fluxo de tarefas.
UpdateTaskFlowRelationsAtualiza todas as arestas de um fluxo de tarefas especificado.
UpdateTaskFlowNameAndDescAtualiza o nome e a descrição de um fluxo de tarefas especificado.
UpdateTaskFlowOwnerAtualiza o proprietário de um fluxo de tarefas especificado.
BackFillRealiza backfill de dados para orquestração de tarefas.