Visão geral da API - DataWorks: Central de Documentação do Alibaba Cloud

Padrões de API e SDKs predefinidos multilíngues

A OpenAPI deste produto (dataworks-public/2024-05-18) utiliza o estilo de assinatura RPC. Encapsulamos SDKs para linguagens de programação comuns para desenvolvedores. Os desenvolvedores podem baixar o SDK para chamar diretamente a OpenAPI deste produto sem se preocupar com detalhes técnicos. Se o SDK existente não atender às suas necessidades, você pode usar o mecanismo de assinatura para integração com assinatura própria. Como os detalhes da autoassinatura são muito complexos, isso pode levar cerca de 5 dias úteis. Portanto, recomendamos ingressar em nosso grupo de serviço DingTalk (147535001692) e realizar a integração de assinatura sob orientação especializada.

Antes de usar a API, você precisa preparar sua conta de identidade e chave de acesso (AccessKey) para acessar efetivamente a API por meio de ferramentas cliente (SDK, CLI, etc.). Para obter detalhes, consulte Obter um AccessKey.

Cenários de assinatura personalizada

Se o seu cenário de negócios tiver requisitos especiais e você precisar integrar a API por meio de autoassinatura, recomendamos consultar primeiro nossa equipe de suporte técnico (grupo de serviço DingTalk: 147535001692) para obter orientação profissional e garantir uma integração eficiente.

Preparação de conta e segurança

As contas da Alibaba Cloud têm permissões administrativas completas sobre todos os recursos. Quando um AccessKey é comprometido, todos os recursos associados estarão em risco de acesso não autorizado. Para garantir a segurança, recomenda-se criar um usuário RAM com apenas permissões de acesso à API e configurar seu AccessKey, além de configurar políticas RAM com base no princípio do menor privilégio (PoLP). Use a conta da Alibaba Cloud apenas em cenários específicos em que as permissões da conta da Alibaba Cloud sejam explicitamente necessárias.

Agente de dados

API	Título	Descrição
Gerenciamento de servidor MCP	Gerenciamento de servidor MCP
CreateMcpServer	Criar um servidor MCP	Cria um servidor MCP.
DeleteMcpServer	Delete MCP Server	Exclui um servidor MCP.
UpdateMcpServer	Atualizar um servidor MCP	Atualiza um servidor MCP.
GetMcpServer	GetMcpServer	Retorna os detalhes de um MCP Server.
ListMcpServers	ListMcpServers.	Obtém uma lista paginada de servidores MCP.
Gerenciamento de habilidades	Gerenciamento de habilidades
CreateSkill	Criar uma skill	Cria uma skill no DataWorks.
UpdateSkill	Atualizar uma Skill.	Atualiza uma Skill especificada e gera uma nova versão.
DeleteSkill	Excluir Skill	Exclui um Skill.
GetSkill	GetSkill.	Obtém os detalhes de uma Skill especificada por nome, incluindo o corpo do arquivo SKILL.md e o link de download do pacote.
ListSkills	Listar habilidades	Realiza uma consulta paginada para listar as habilidades da conta atual.
Gerenciamento de agentes	Gerenciamento de agentes
CreateAgent	Criar um agente	Cria um agente.
ListCustomAgents	Listar agentes personalizados	Lista agentes personalizados com paginação.
DeleteAgent	Delete an agent.	Exclui um Agent.
GetAgent	GetAgent.	Obtém os detalhes do agente por nome.
ListAgents	Consultar lista de agentes.	Consulta a lista de agentes disponíveis para o locatário atual, com suporte a filtragem por nome e paginação.
Gerenciamento de sessões de agente	Gerenciamento de sessões de agente
PromptAgentSession	Send session prompt.	Envia um prompt do usuário para uma sessão existente e retorna a resposta do Agent em modo de streaming.
ReplyAgentSession	Resposta à entrada da solicitação da sessão	Responde a uma interação de usuário pendente em uma sessão do DataAgent.
LoadAgentSession	LoadAgentSession.	Carrega o histórico de mensagens de uma sessão existente e o retorna como um fluxo SSE. Se a sessão não existir, o servidor envia um JSONRPCResponse.error com o código 400 por meio do fluxo SSE. O Content-Type é text/event-stream. Use esta operação para restaurar o contexto da sessão.
ListAgentSessions	Consultar lista de sessões.	Carrega a lista de histórico de conversas de uma Sessão de Agente.
ListAgentSessionArtifacts	Consultar lista de artefatos da sessão.	Consulta a lista de arquivos de artefato produzidos por uma sessão especificada.
GetAgentSessionTokenUsage	GetAgentSessionTokenUsage	Obtém o uso cumulativo de tokens de IA para uma sessão especificada.
GetAgentSessionArtifactMeta	GetAgentSessionArtifactMeta.	Obtém os metadados e o conteúdo de um artefato com base em um ID de sessão e no caminho do artefato.
CreateAgentSession	Criar uma sessão de agente.	Cria uma nova sessão de agente e retorna o ID da sessão.
CancelAgentSession	Cancelar uma sessão.	Interrompe a chamada do Agent para uma sessão especificada, suportando interrupção durante respostas em streaming.

Gerenciamento de espaço de trabalho

API	Título	Descrição
Espaços de trabalho	Espaços de trabalho
CreateProject	Create a workspace.	Cria um workspace.
DeleteProject	Excluir um workspace.	Exclui um workspace do DataWorks.
UpdateProject	UpdateProject.	Atualiza um workspace do DataWorks.
ListProjects	ListProjects.	Consulta uma lista de workspaces do DataWorks do tenant ao qual sua conta pertence.
GetProject	Obter detalhes do workspace.	Consulta os detalhes de um workspace do DataWorks.
Funções do espaço de trabalho	Funções do espaço de trabalho
CreateProjectRole	CreateProjectRole.	Cria uma função personalizada para um workspace.
DeleteProjectRole	DeleteProjectRole	Exclui uma função personalizada de um workspace.
UpdateProjectRole	Atualizar uma função personalizada do workspace.	Atualiza as permissões de uma função personalizada em um workspace.
GetProjectRole	GetProjectRole.	Consulta os detalhes de uma função de espaço de trabalho.
ListProjectRoles	Detalhes das funções do workspace	Consulta os detalhes das funções do workspace por paginação.
Membros do espaço de trabalho	Membros do espaço de trabalho
CreateProjectMember	Criar um membro do workspace.	Adiciona um membro ao workspace e concede funções do workspace ao membro.
DeleteProjectMember	Remover um membro do workspace.	Remove um membro do workspace e as funções de workspace concedidas ao membro.
GrantMemberProjectRoles	GrantMemberProjectRoles.	Atribui funções aos membros de um espaço de trabalho.
RevokeMemberProjectRoles	Revoke workspace roles from a workspace member	Revoga funções de um membro do workspace.
GetProjectMember	GetProjectMember.	Obtém os detalhes de um membro específico em um workspace.
ListProjectMembers	ListProjectMembers	Obtém uma lista paginada dos detalhes dos membros do workspace.

Fontes de dados

API	Título	Descrição
UpdateDataSource	Atualiza uma fonte de dados	Modifica uma fonte de dados especificada com base no ID da fonte de dados.
TestDataSourceConnectivity	Teste de conectividade de uma fonte de dados.	Testa a conectividade de uma fonte de dados em um grupo de recursos.
CreateDataSource	Criar uma fonte de dados	Cria uma fonte de dados em um espaço de trabalho especificado para o ambiente de desenvolvimento ou produção.
DeleteDataSource	DeleteDataSource.	Exclui uma fonte de dados pelo ID da fonte de dados.
CloneDataSource	Clonar uma fonte de dados	Clona uma fonte de dados existente para criar uma nova.
ListDataSources	ListDataSources.	Obtém uma lista de fontes de dados que correspondem às condições de filtro especificadas.
Regras de compartilhamento de fontes de dados	Regras de compartilhamento de fontes de dados
CreateDataSourceSharedRule	CreateDataSourceSharedRule.	Cria uma regra de compartilhamento para uma fonte de dados para compartilhá-la com outros workspaces ou usuários RAM.
DeleteDataSourceSharedRule	Excluir uma regra de compartilhamento de fonte de dados	Exclui uma regra de compartilhamento de fonte de dados pelo seu ID.
ListDataSourceSharedRules	Regras de compartilhamento de fonte de dados.	Obtém uma lista de regras de compartilhamento para uma fonte de dados.

Recursos de computação

API	Título	Descrição
DeleteComputeResource	Excluir um recurso de computação.	Exclui o recurso de computação especificado com base no ID do recurso de computação.
GetComputeResource	GetComputeResource.	Consulta o recurso de computação especificado com base no ID do recurso de computação.
UpdateComputeResource	Atualiza um recurso de computação	Modifica um recurso de computação especificado com base no ID do recurso de computação.
ListComputeResources	ListComputeResources	Consulta a lista de recursos de computação que atendem às informações de negócios especificadas.
CreateComputeResource	Cria um recurso de computação	Cria um recurso de computação em um espaço de trabalho especificado. O recurso de computação pode ser usado no ambiente de desenvolvimento ou de produção.
GetComputeResourceAuthUserMappings	Informações de mapeamento de conta de recurso de computação.	Consulta os mapeamentos de usuário de um recurso de computação. Suporta os tipos de recurso EMR e Serverless Spark.
UpdateComputeResourceAuthUserMappings	Atualizar mapeamento de conta de recurso de computação.	Atualiza o mapeamento de conta de um recurso de computação. Atualmente, suporta os tipos de recurso EMR e Serverless Spark.

Gerenciamento de grupos de recursos

API	Título	Descrição
Grupos de recursos	Grupos de recursos
CreateResourceGroup	Criar um grupo de recursos	Cria um grupo de recursos.
DeleteResourceGroup	Exclui um grupo de recursos de uso geral.	Exclui um grupo de recursos de uso geral.
UpdateResourceGroup	UpdateResourceGroup	Atualiza as informações básicas de um grupo de recursos.
GetResourceGroup	Obter detalhes do grupo de recursos por ID	Obtém os detalhes de um grupo de recursos especificado por ID.
ListResourceGroups	Listar grupos de recursos	Obtém uma lista de grupos de recursos.
DissociateProjectFromResourceGroup	Desassociar um grupo de recursos de um workspace	Desassocia um grupo de recursos de um workspace.
AssociateProjectToResourceGroup	Associa um grupo de recursos a um workspace.	Associa um grupo de recursos a um workspace.
ListResourceGroupAssociateProjects	ListResourceGroupAssociateProjects	Consulta a lista de workspaces aos quais um grupo de recursos está associado.
ListResourceGroupMetricData	ListResourceGroupMetricData	Consulta os dados de métricas de um grupo de recursos.
Rotas	Rotas
CreateRoute	CreateRoute.	Cria uma rota para uma rede.
DeleteRoute	DeleteRoute.	Exclui uma rota de um recurso de rede.
UpdateRoute	UpdateRoute.	Atualiza as informações sobre uma rota.
GetRoute	GetRoute.	Consulta as informações de uma rota com base em seu ID.
ListRoutes	Lista de rotas de um recurso de rede.	Obtém a lista de rotas de um recurso de rede.
Redes	Redes
CreateNetwork	CreateNetwork.	Cria uma rede e associa a rede a um grupo de recursos geral.
DeleteNetwork	Desassociar e excluir um recurso de rede de um grupo de recursos de uso geral.	Desassocia e exclui um recurso de rede de um grupo de recursos de uso geral.
GetNetwork	Detalhes do recurso de rede	Obtém os detalhes de um recurso de rede.
ListNetworks	Consulta de recursos de rede em um grupo de recursos	Consulta os recursos de rede em um grupo de recursos.

Gerenciamento de imagens

API	Título	Descrição
CreateImage	Criar uma imagem	Cria uma imagem.
UpdateImage	Atualizar imagem	Atualiza uma imagem.
RunImageTest	Run image test.	Executa um teste de imagem.
ListImageTestResults	Obter resultados de teste de imagem	Consulta uma lista de resultados de teste de imagem.
GetImageTestResult	Resultado de uma tarefa de teste de imagem especificada	Obtém os detalhes do resultado de um teste de imagem.
CancelImageTest	Cancelamento de teste de imagem	Cancela um teste de imagem.
PublishImage	Publish an image.	Publica uma imagem.
BuildImage	Build an image.	Compila uma imagem.
RollbackImage	Reverter uma imagem	Reverte uma imagem.
EnableImage	Ativar uma imagem	Ativa uma imagem.
DisableImage	Desativar uma imagem	Desativa uma imagem.
GetImage	Obter detalhes da imagem por ID	Obtém os detalhes de uma imagem especificada pelo ID da imagem.
ListImages	Obter uma lista de imagens	Obtém uma lista de imagens.
ListImageVersions	Obter detalhes da versão da imagem.	Obtém os detalhes de uma versão de imagem especificada.
DeleteImage	Excluir uma imagem	Exclui uma imagem.
AssociateProjectToImage	Associar uma imagem a um workspace.	Associa uma imagem a um workspace.
DissociateProjectFromImage	Desassociar uma imagem de um workspace.	Desassocia uma imagem de um workspace.
ListImageAssociatedProjects	Lista de workspaces associados a uma imagem.	Lista os workspaces associados a uma imagem.

Data Studio (nova versão)

API	Título	Descrição
Snapshots	Snapshots
GetSnapshot	Obter detalhes do snapshot de versão	Obtém os detalhes de um snapshot de versão.
ListSnapshots	Obter lista de snapshots de versão.	Obtém uma lista de snapshots de versão.
Componentes	Componentes
CreateComponent	Criar um componente	Cria um componente.
DeleteComponent	Exclusão de um componente	Exclui um componente.
GetComponent	GetComponent.	Obtém as informações do componente.
UpdateComponent	Atualizar um componente.	Atualiza componentes.
ListComponents	ListComponents.	Obtém uma lista de componentes.
Nós	Nós
CreateNode	Cria um nó do Data Studio.	Cria um nó do Data Studio na nova versão do Data Studio.
DeleteNode	Excluir um nó do Data Studio.	Exclui um nó do Data Studio especificado.
UpdateNode	UpdateNode.	Atualiza as informações básicas de um nó no Data Studio. Esta operação de API realiza uma atualização incremental. As informações de atualização são descritas por meio do FlowSpec.
MoveNode	MoveNode.	Move um nó para um caminho no Data Studio.
RenameNode	RenameNode.	Renomeia um nó no Data Studio.
GetNode	GetNode.	Consulta as informações sobre um nó no Data Studio.
ListNodes	Lista de nós de desenvolvimento de dados	Obtém uma lista de nós de desenvolvimento de dados com paginação. Você também pode realizar uma consulta filtrada na lista usando condições especificadas.
ListNodeDependencies	Obter nós dependentes de um nó de desenvolvimento de dados	Obtém os nós dependentes de um nó de desenvolvimento de dados especificado de forma paginada.
Definições de fluxo de trabalho	Definições de fluxo de trabalho
CreateWorkflowDefinition	Criar um fluxo de trabalho do Data Studio	Cria um fluxo de trabalho em um diretório especificado no Data Studio.
ImportWorkflowDefinition	Importar um fluxo de trabalho do Data Studio.	Importa um nó de fluxo de trabalho definido pelo FlowSpec e seus nós filhos internos para o Data Studio.
DeleteWorkflowDefinition	Excluir um fluxo de trabalho do Data Studio.	Exclui um fluxo de trabalho especificado no Data Studio.
UpdateWorkflowDefinition	UpdateWorkflowDefinition.	Atualiza as informações básicas de um fluxo de trabalho no Data Studio. Esta operação de API realiza uma atualização incremental. As informações de atualização são descritas por meio do FlowSpec.
MoveWorkflowDefinition	MoveWorkflowDefinition.	Move um fluxo de trabalho para um caminho no Data Studio.
RenameWorkflowDefinition	Renomear um fluxo de trabalho do Data Studio.	Renomeia um fluxo de trabalho no Data Studio.
GetWorkflowDefinition	Obter detalhes do fluxo de trabalho do Data Studio.	Consulta as informações sobre um fluxo de trabalho.
ListWorkflowDefinitions	Lista de fluxos de trabalho de desenvolvimento de dados	Consulta uma lista paginada de fluxos de trabalho de desenvolvimento de dados. Você também pode filtrar fluxos de trabalho com base em condições especificadas.
Recursos	Recursos
CreateResource	Criar um recurso de arquivo do Data Studio.	Cria um recurso de arquivo para o Data Studio. As informações do recurso de arquivo são definidas no formato FlowSpec.
DeleteResource	DeleteResource.	Exclui um recurso de arquivo do Data Studio.
UpdateResource	Atualização das informações do recurso de arquivo do Data Studio.	Atualiza as informações básicas de um recurso de arquivo no Data Studio. Esta operação de API realiza uma atualização incremental. As informações de atualização são descritas por meio do FlowSpec.
GetResource	Obter detalhes do recurso de arquivo do Data Studio.	Consulta as informações sobre um recurso de arquivo.
ListResources	Obtenção de recursos de arquivo de desenvolvimento de dados	Obtém uma lista paginada de arquivos de recurso e filtra recursos.
MoveResource	Mover recurso de arquivo do Data Studio	Move um recurso de arquivo especificado do Data Studio para uma pasta especificada do Data Studio.
RenameResource	Renomear um recurso de arquivo do Data Studio	Renomeia um recurso de arquivo no Data Studio.
Funções	Funções
CreateFunction	Criar uma função do Data Studio.	Cria uma função UDF no Data Studio. As informações da função UDF são descritas no formato FlowSpec.
DeleteFunction	DeleteFunction.	Exclui uma função definida pelo usuário (UDF) no Data Studio.
UpdateFunction	Atualizar informações da função do Data Studio.	Atualiza as informações básicas de uma função definida pelo usuário (UDF) no Data Studio. Esta operação de API realiza uma atualização incremental. As informações de atualização são descritas por meio do FlowSpec.
MoveFunction	Move uma função do Data Studio.	Move uma função definida pelo usuário (UDF) para um caminho no Data Studio.
RenameFunction	Renomear uma função do Data Studio.	Renomeia uma função definida pelo usuário (UDF) no Data Studio.
GetFunction	Detalhes da função do Data Studio.	Consulta as informações sobre uma função definida pelo usuário (UDF) no Data Studio.
ListFunctions	Lista de funções do Data Studio.	Obtém uma lista paginada de funções UDF no Data Studio. Você também pode usar condições de filtro para filtrar funções UDF.
Fluxos de trabalho de implantação	Fluxos de trabalho de implantação
CreatePipelineRun	Cria um processo de implantação	Cria um processo de implantação para uma entidade no Data Studio.
AbolishPipelineRun	Interromper um processo de implantação.	Altera o status de um processo de implantação especificado para encerrado. O processo de implantação não é excluído e ainda pode ser consultado por meio de operações de consulta.
ExecPipelineRunStage	Execução de um estágio especificado de um processo de implantação.	Executa um estágio especificado de um processo de implantação.
GetPipelineRun	Obter detalhes do processo de implantação.	Obtém os detalhes de um processo de implantação.
ListPipelineRuns	Listar processos de implantação.	Obtém uma lista paginada de processos de implantação. Você também pode filtrar essa lista com base em critérios específicos.
ListPipelineRunItems	Obter conteúdo da implantação.	Consulta as informações sobre objetos de implantação por ID do processo de implantação.
Ambientes de desenvolvimento pessoal	Ambientes de desenvolvimento pessoal
ListServerIdeInstances	Listar instâncias de ambiente de desenvolvimento pessoal	Realiza uma consulta paginada de instâncias de ambiente de desenvolvimento pessoal. Ao invocar esta operação, utilize o endpoint do DataWorks correspondente à região do workspace de destino.
GetServerIdeInstance	Consultar instância de ambiente de desenvolvimento pessoal.	Consulta os detalhes de uma instância especificada de ambiente de desenvolvimento pessoal.
ListServerIdeImages	Consultar imagens para ambientes de desenvolvimento pessoal.	Consulta a lista de imagens disponíveis para ambientes de desenvolvimento pessoal com paginação.
ListServerIdeEcsSpecs	Consulta tipos de instância ECS para ambientes de desenvolvimento pessoal.	Consulta a lista de tipos de instância ECS disponíveis para ambientes de desenvolvimento pessoal.
CreateServerIdeInstance	Criar uma instância de ambiente de desenvolvimento pessoal.	Cria uma instância de ambiente de desenvolvimento pessoal.
UpdateServerIdeInstance	Atualizar uma instância de ambiente de desenvolvimento pessoal.	Atualiza a configuração de uma instância de ambiente de desenvolvimento pessoal especificada.
StopServerIdeInstance	Parar uma instância de ambiente de desenvolvimento pessoal.	Para uma instância especificada de ambiente de desenvolvimento pessoal.
StartServerIdeInstance	Iniciar uma instância de ambiente de desenvolvimento pessoal.	Inicia uma instância especificada de ambiente de desenvolvimento pessoal.
DeleteServerIdeInstance	Excluir uma instância de ambiente de desenvolvimento pessoal.	Exclui uma instância de ambiente de desenvolvimento pessoal especificada.

Data Studio (legado)

API	Título	Descrição
Arquivos	Arquivos
CreateFile	Criação de um arquivo no DataStudio	Cria um arquivo no DataStudio. Esta operação não oferece suporte à criação de tarefas de nó de integração de dados.
CreateResourceFile	Criar arquivo de recurso.	Permite que os usuários especifiquem seus próprios arquivos (como JAR, PY, arquivo compactado ou arquivo) para criar arquivos de recursos do Data Studio.
CreateUdfFile	Criação de um arquivo de função no Data Studio.	Cria um arquivo para uma função no Data Studio.
UpdateFile	Atualizar um nó de arquivo existente	Atualiza um arquivo existente.
UpdateUdfFile	Atualização das informações do arquivo da função	Atualiza as informações do arquivo de uma função.
GetFile	Obter os detalhes de um arquivo.	Obtém os detalhes de um arquivo.
ListFiles	Consulta de lista de arquivos.	Consulta uma lista de arquivos chamando ListFiles.
SubmitFile	Submissão de um arquivo ao ambiente de desenvolvimento do sistema de agendamento.	Submete um arquivo ao ambiente de desenvolvimento do sistema de agendamento para gerar uma tarefa.
DeployFile	Deploy file.	Implanta um arquivo no ambiente de produção.
Pastas	Pastas
CreateFolder	Criar uma pasta.	Cria uma pasta.
DeleteFolder	Excluir uma pasta no Data Studio.	Exclui uma pasta na página do Data Studio.
UpdateFolder	Atualizar informações da pasta.	Invoca UpdateFolder para atualizar as informações da pasta.
GetFolder	Obter detalhes da pasta.	Consulta as informações sobre uma pasta.
ListFolders	Consultar lista de pastas.	Consulta uma lista de pastas.
Fluxos de negócios	Fluxos de negócios
CreateBusiness	Criar um processo de negócios.	Cria um processo de negócios no Data Studio para desenvolvimento de dados.
DeleteBusiness	Excluir um processo de negócios.	Exclui um fluxo de trabalho.
UpdateBusiness	UpdateBusiness.	Atualiza um fluxo de trabalho.
GetBusiness	Consultar detalhes do fluxo de negócios	Consulta os detalhes de um fluxo de negócios.
ListBusiness	ListBusiness	Consulta uma lista de workflows.
Pacotes de implantação	Pacotes de implantação
GetDeploymentPackage	Detalhes do pacote de implantação.	Obtém os detalhes de um pacote de implantação.
ListDeploymentPackages	Consulta de pacotes de implantação.	Consulta uma lista de pacotes de implantação.
ListDeploymentPackageFiles	Obter versões de arquivo pendentes de implantação.	Obtém a lista de versões de arquivo pendentes de implantação.
Versões de arquivo	Versões de arquivo
GetFileVersion	Detalhes da versão do arquivo.	Obtém os detalhes da versão de um arquivo.
ListFileVersions	Consulta de versões de arquivo.	Consulta a lista de versões de um arquivo.
Eventos de ponto de extensão	Eventos de ponto de extensão
UpdateIDEEventResult	Atualiza o resultado da verificação de um evento de ponto de extensão.	Reporta o resultado da verificação de uma mensagem de evento de ponto de extensão por meio de um callback.
GetIDEEventDetail	GetIDEEventDetail.	Consulta o snapshot de dados de um ponto de extensão com base no ID de uma mensagem no DataWorks OpenEvent quando o evento do ponto de extensão relacionado é acionado.
Tabelas	Tabelas
EstablishRelationTableToBusiness	EstablishRelationTableToBusiness.	Importa uma tabela para um fluxo de trabalho. A chamada desta operação equivale a clicar com o botão direito do mouse em um fluxo de trabalho na página Data Studio e selecionar Importar Tabela.

Integração de dados

API	Título	Descrição
Tarefas de sincronização	Tarefas de sincronização
CreateDIJob	Criação de uma tarefa de sincronização de integração de dados.	Cria uma tarefa na nova versão do Data Integration.
UpdateDIJob	UpdateDIJob.	Atualiza uma tarefa de Data Integration.
DeleteDIJob	DeleteDIJob.	Exclui uma tarefa de sincronização da nova versão.
StopDIJob	Parar uma tarefa de sincronização de integração de dados.	Aborta uma tarefa de integração de dados.
StartDIJob	StartDIJob.	Inicia uma tarefa de sincronização de nova versão.
GetDIJob	Obtém os detalhes da configuração da tarefa de sincronização de integração de dados.	Consulta as tarefas de integração de dados.
GetDIJobLog	Visualizar os logs de execução de uma tarefa de sincronização de integração de dados.	Obtém os logs de uma tarefa de integração de dados.
ListDIJobs	Configurações de tarefas de sincronização do Data Integration.	Lista as tarefas da nova versão do Data Integration, incluindo tarefas de sincronização de banco de dados em tempo real, tarefas de sincronização de banco de dados em lote e tarefas de sincronização de tabela única em tempo real.
ListDIJobRunDetails	ListDIJobRunDetails.	Consulta as informações de execução de uma tarefa de sincronização.
ListDIJobMetrics	ListDIJobMetrics.	Consulta as métricas de uma tarefa de sincronização.
ListDIJobEvents	ListDIJobEvents.	Consulta os eventos de uma tarefa de sincronização.
Alertas de tarefa	Alertas de tarefa
CreateDIAlarmRule	Criar uma regra de alerta para uma tarefa de sincronização de integração de dados.	Cria uma regra de alerta para uma tarefa de integração de dados.
UpdateDIAlarmRule	UpdateDIAlarmRule.	Atualiza uma regra de alerta configurada para uma tarefa de sincronização.
DeleteDIAlarmRule	DeleteDIAlarmRule.	Exclui uma regra de alerta configurada para uma tarefa de sincronização.
ListDIAlarmRules	ListDIAlarmRules.	Consulta as regras de alerta configuradas para uma tarefa de sincronização.

Mapa de dados

API	Título	Descrição
Análise semântica	Análise semântica
ListSemanticJobs	ListSemanticJobs.	Consulta as definições de nós semânticos do locatário atual com paginação. Os campos Name, ProjectId e Source nos itens da lista podem ser usados para executar/excluir nós, consultar detalhes de execução e verificar o escopo de entrada, respectivamente.
CreateSemanticJob	Cria um job semântico.	Salva uma definição de job semântico reutilizável. Se você utilizar uma origem de arquivo único, solicite e conclua o upload do anexo primeiro. Após a criação, chame RunSemanticJob com o Name retornado.
DeleteSemanticJob	Excluir um job semântico.	Exclui uma definição de job semântico pelo nome de um job criado. Se o job estiver em execução, chame KillSemanticJob com o ExecutorJobId dessa execução e confirme a parada antes da exclusão.
DownloadSemanticResults	Obter URL de download de resultado de job semântico.	Retorna a URL de download de artefatos pelo nome do job e um ID de execução opcional após a conclusão de uma execução. Se JobRunId não for especificado, os resultados da execução mais recente do job serão retornados.
GetSemanticJobDetail	Consultar detalhes da execução do job semântico.	Consulta o status do executor e a configuração de tempo de execução usando o ExecutorJobId retornado por RunSemanticJob ou ListSemanticJobRuns.
RunSemanticJob	Executar um trabalho semântico.	Envia um trabalho semântico salvo para execução por nome e retorna os identificadores de execução e do executor. Uma chamada bem-sucedida indica que o trabalho foi enviado, não que os resultados do modelo semântico foram gerados.
ListSemanticJobRuns	Consultar registros de execução de job semântico.	Consulta os registros de execução de um nó criado por Nome com paginação. O JobRunId em cada registro é ativo para recuperar os resultados de uma execução específica, e o ExecutorJobId é ativo para consultar detalhes, recuperar logs ou interromper a execução.
GetSemanticJobLog	Consultar logs de execução de tarefa semântica.	Consulta logs de execução usando o ExecutorJobId retornado por RunSemanticJob ou ListSemanticJobRuns. O contrato POP atual expõe apenas os identificadores da tarefa e do workspace e retorna segmentos de log padrão.
KillSemanticJob	Interromper uma execução de job semântico.	Interrompe uma execução especificada usando o ExecutorJobId retornado por RunSemanticJob ou ListSemanticJobRuns. Uma chamada bem-sucedida indica apenas que a solicitação de interrupção foi aceita. Consulte o status final chamando GetSemanticJobDetail.
UploadSemanticFile	Solicitar uma URL de upload para anexos de tarefa semântica.	Solicita uma URL temporária de upload PUT do OSS. Conclua o upload PUT antes que a URL expire e, em seguida, passe o FileId retornado para o parâmetro ReferenceFileIds de CreateSemanticJob.
Propriedades personalizadas	Propriedades personalizadas
ListCustomAttributes	Listar atributos personalizados.	Consulta a lista de definições de atributos personalizados.
GetCustomAttribute	GetCustomAttribute	Obtém uma definição de atributo personalizado.
CreateCustomAttribute	Criar um atributo personalizado.	Cria uma definição de atributo personalizado.
UpdateCustomAttribute	UpdateCustomAttribute.	Atualiza um atributo personalizado.
DeleteCustomAttribute	DeleteCustomAttribute	Exclui uma definição de atributo personalizado.
Definições de entidades de metadados personalizadas	Definições de entidades de metadados personalizadas
ListMetaEntityDefs	Consultar lista de definições de entidades de metadados.	Consulta a lista de definições de entidades personalizadas, incluindo tipos de entidades personalizadas e tipos de tabelas de extensão.
GetMetaEntityDef	GetMetaEntityDef	Obtém os detalhes de uma definição de entidade personalizada.
CreateMetaEntityDef	Criar uma definição de tipo de entidade de metadados.	Cria uma definição de entidade de metadados, incluindo tipos personalizados e tipos de tabela estendidos.
UpdateMetaEntityDef	Atualizar definição de entidade de metadados.	Atualiza uma definição de entidade de metadados, incluindo tipos de entidade personalizados e tipos de tabela de extensão.
DeleteMetaEntityDef	Excluir uma definição de entidade de metadados.	Exclui uma definição de entidade de metadados, incluindo tipos de entidade personalizados e tipos de tabela de extensão.
Coletores de metadados	Coletores de metadados
ListCrawlerTypes	ListCrawlerTypes	Consulta uma lista de tipos de crawler de metadados suportados no Data Map. Os subtipos dos tipos e o relacionamento hierárquico entre os subtipos também são retornados.
GetCrawlerTypeCapabilities	Query crawler type capabilities.	Consulta os tipos de crawler suportados na região atual, juntamente com suas capacidades de escopo de coleta, agendamento e configuração de extensão.
CreateCrawler	Create a metadata crawler.	Cria um rastreador de metadados e configura a fonte de dados, o escopo de coleta, o grupo de recursos e o método de agendamento.
ListCrawlers	List metadata crawlers.	Consulta crawlers de metadados por consulta paginada e suporta filtragem por workspace, fonte de dados, tipo, ambiente, proprietário e nome.
GetCrawler	Consultar detalhes do rastreador de metadados.	Consulta a configuração, o status e as informações da execução mais recente de um rastreador de metadados especificado.
UpdateCrawler	Update a metadata crawler.	Atualiza o grupo de recursos, o escopo de coleta, o agendamento e as configurações de extensão de um rastreador de metadados especificado.
RunCrawler	Executar um rastreador de metadados.	Aciona a execução de um rastreador de metadados especificado e retorna o status de aceitação e as informações da instância de tarefa associada.
StopCrawler	Interromper uma execução de rastreador de metadados.	Interrompe a tarefa em execução de um rastreador de metadados especificado.
ListCrawlerRuns	Consultar registros de execução do rastreador.	Consulta os registros de execução de um rastreador de metadados especificado por paginação, com filtragem opcional por intervalo de tempo e status de execução.
DeleteCrawler	Delete a metadata crawler.	Exclui um rastreador de metadados especificado.
Entidades de metadados	Entidades de metadados
Entidades personalizadas	Entidades personalizadas
ListMetaEntities	Consultar lista de entidades de metadados.	Consulta uma lista de entidades de metadados. Atualmente, apenas tipos de entidade personalizados são suportados.
GetMetaEntity	GetMetaEntity.	Obtém os detalhes da entidade de metadados. Atualmente, apenas tipos de entidade puramente personalizados são suportados.
BatchCreateMetaEntities	Criação em lote de entidades de metadados.	Cria entidades de metadados em lotes. Todas as entidades no mesmo lote devem ser do mesmo tipo. Atualmente, apenas tipos de entidade personalizados e tipos de tabela de extensão (correspondentes a Banco de dados/Tabela) são suportados.
UpdateMetaEntity	UpdateMetaEntity.	Atualiza uma entidade de metadados. Você pode atualizar entidades personalizadas ou objetos do tipo de tabela estendida, como bancos de dados, tabelas e colunas.
BatchDeleteMetaEntities	Excluir entidades de metadados em lote.	Exclui objetos de entidade de metadados em lotes. Suporta a exclusão de entidades personalizadas e objetos do tipo tabela de extensão (Database/Table). Não suporta a exclusão individual de colunas. Você pode excluir objetos Column associados excluindo a Table.
Catálogos de dados	Catálogos de dados
ListCatalogs	Lista catálogos de dados no Data Map.	Consulta uma lista de catálogos no Data Map. Somente catálogos dos tipos de rastreador de metadados Data Lake Formation (DLF) e StarRocks são suportados. Para o tipo de rastreador de metadados DLF, todos os catálogos de dados suportados são retornados. Para o tipo de rastreador de metadados StarRocks, os catálogos de dados de uma instância específica são retornados.
GetCatalog	Obter detalhes do catálogo de dados no mapa de dados.	Obtém os detalhes de um catálogo de dados especificado no Data Map do DataWorks. Atualmente, os tipos de catálogo DLF e StarRocks são suportados.
Bancos de dados	Bancos de dados
ListDatabases	Listar bancos de dados no Data Map.	Consulta uma lista de bancos de dados em uma instância, cluster ou catálogo de dados no Data Map. Para fontes de dados DLF ou StarRocks, você pode chamar esta operação de API para consultar bancos de dados em um catálogo de dados. Para fontes de dados StarRocks, você pode chamar esta operação de API para consultar bancos de dados apenas no Internal Catalog. Para outros tipos de fontes de dados, você pode chamar esta operação de API para consultar bancos de dados em uma instância ou cluster.
GetDatabase	Detalhes do banco de dados no Data Map.	Consulta as informações sobre um banco de dados específico no Data Map.
Schemas	Schemas
ListSchemas	Consulta a lista de esquemas de banco de dados no Data Map.	Consulta a lista de esquemas em um banco de dados ou projeto MaxCompute especificado no Data Map. Atualmente, suporta os tipos MaxCompute e Holo.
GetSchema	Obtém informações de esquema de banco de dados no Data Map.	Obtém os detalhes de um esquema especificado no Data Map. Somente esquemas do MaxCompute e do Hologres são suportados.
Tabelas	Tabelas
ListTables	Lista de tabelas de dados no Data Map do DataWorks	Consulta uma lista de tabelas de dados no Data Map do DataWorks. Para tipos de fonte de dados que não suportam o nível de schema, esta operação consulta tabelas de dados em um banco de dados especificado. Para tipos de fonte de dados que suportam o nível de schema, esta operação consulta tabelas de dados em um banco de dados, projeto MaxCompute ou schema especificado. A resposta inclui apenas informações básicas sobre as tabelas de dados e exclui metadados técnicos e de negócios. Para fontes de dados que não sejam MaxCompute, a resposta não é em tempo real e pode ter um atraso de até uma hora em comparação com os resultados da coleta de metadados.
GetTable	Retrieve data map table details	Obtém os detalhes de uma tabela especificada no Data Map. Você pode escolher se deseja retornar metadados de negócios.
UpdateTableBusinessMetadata	Atualização dos metadados de negócios de uma tabela do Data Map.	Atualiza os metadados de negócios de uma tabela no Data Map. Atualmente, apenas a descrição de uso da tabela e os atributos personalizados podem ser atualizados.
SubmitBatchChangeTableOwner	Atualização em lote do proprietário da tabela.	Envia uma solicitação em lote para transferir a propriedade de tabelas.
GetBatchChangeTableOwnerStatus	Recuperar o status de transferência de proprietário de tabela em lote	Consulta o status de uma tarefa de transferência de proprietário de tabela em lote.
Colunas	Colunas
ListColumns	Consulta colunas de tabela no Mapa de Dados do DataWorks	Consulta as colunas de uma tabela especificada no Mapa de Dados do DataWorks.
GetColumn	Obter informações de coluna para uma tabela do Data Map do DataWorks	Obtém os detalhes de uma coluna especificada em uma tabela do Data Map do DataWorks.
UpdateColumnBusinessMetadata	UpdateColumnBusinessMetadata.	Atualiza os metadados de negócio de uma coluna em um mapa de dados. Esta operação pode atualizar apenas a descrição de negócio e os atributos personalizados.
Conjuntos de dados	Conjuntos de dados
ListDatasets	Listar conjuntos de dados.	Consulta uma lista de conjuntos de dados. Atualmente, há suporte para conjuntos de dados do DataWorks e do PAI.
GetDataset	GetDataset	Obtém os detalhes de um dataset.
CreateDataset	Criar um conjunto de dados.	Cria um conjunto de dados. Você pode criar um conjunto de dados apenas em um workspace do qual tenha participado. Apenas conjuntos de dados do DataWorks são suportados. O número máximo de conjuntos de dados por locatário é 2000.
UpdateDataset	Atualizar um conjunto de dados.	Atualiza as informações do conjunto de dados. Somente conjuntos de dados do DataWorks são suportados. O operador deve ser o criador do conjunto de dados ou o administrador do workspace onde o conjunto de dados está localizado.
DeleteDataset	Excluir um conjunto de dados.	Exclui um conjunto de dados. Apenas conjuntos de dados do DataWorks são suportados. As versões correspondentes do conjunto de dados são excluídas em cascata. O operador deve ser o criador do conjunto de dados ou um administrador do workspace ao qual o conjunto de dados pertence.
Versões de conjunto de dados	Versões de conjunto de dados
ListDatasetVersions	ListDatasetVersions.	Obtém a lista de versões de um determinado conjunto de dados.
GetDatasetVersion	GetDatasetVersion	Obtém informações de uma determinada versão do conjunto de dados.
CreateDatasetVersion	Criar uma versão de conjunto de dados.	Cria uma versão de conjunto de dados. Atualmente, apenas conjuntos de dados do DataWorks são suportados. O número máximo de versões é 20.
UpdateDatasetVersion	UpdateDatasetVersion	Atualiza as informações da versão do conjunto de dados. Somente conjuntos de dados do DataWorks são suportados. Requer permissões de criador do conjunto de dados ou administrador do workspace.
DeleteDatasetVersion	Excluir uma versão de conjunto de dados.	Exclui uma versão de conjunto de dados. Apenas versões de conjuntos de dados do DataWorks que não sejam v1 podem ser excluídas por meio desta operação. Para excluir uma versão de conjunto de dados v1, use a operação DeleteDataset. O operador deve ser o criador do conjunto de dados ou um administrador do workspace ao qual o conjunto de dados pertence.
PreviewDatasetVersion	PreviewDatasetVersion	Visualiza o conteúdo de uma versão de conjunto de dados especificada. Atualmente, apenas a visualização de arquivos de texto é suportada para conjuntos de dados do tipo OSS. Tipos MIME suportados: 1. application/json 2. application/xml 3. text/html 4. text/plain 5. application/octet-stream.
Partições	Partições
ListPartitions	Consultar partições de uma tabela do data map.	Consulta a lista de partições de uma tabela especificada no Data Map do DataWorks. Atualmente, suporta os tipos MaxCompute e HMS (cluster EMR).
GetPartition	Obter detalhes da partição da tabela no Mapa de Dados.	Obtém os detalhes da partição de uma tabela do Mapa de Dados. Atualmente, suporta apenas os tipos MaxCompute e HMS (cluster EMR).
Linhagem	Linhagem
ListLineageRelationships	Consulta de relações de linhagem de dados no Data Map do DataWorks	Consulta a lista de relações de linhagem de dados entre duas entidades fornecidas (como tabelas, campos ou arquivos OSS) no Data Map do DataWorks.
GetLineageRelationship	Obter detalhes da relação de linhagem de dados.	Obtém os detalhes de uma relação de linhagem especificada no DataWorks Data Map.
DeleteLineageRelationship	Excluir uma relação de linhagem de dados.	Exclui uma relação de linhagem de dados especificada do Data Map do DataWorks.
CreateLineageRelationship	Registra relação de linhagem de dados no Mapa de Dados.	Registra uma relação de linhagem de dados no Data Map do DataWorks. Você pode usar esta operação para estabelecer relações de linhagem entre entidades de metadados gerenciadas pelo DataWorks, incluindo cenários de tabela para tabela, coluna para coluna, tabela para coluna e conjunto de dados para tabela. Você também pode estabelecer relações de linhagem entre entidades gerenciadas e objetos de entidade personalizados registrados por usuários. Esta operação é compatível com objetos personalizados não gerenciados, mas essa abordagem não é mais recomendada. Antes de chamar esta operação, certifique-se de que as entidades gerenciadas envolvidas no registro de linhagem já existam na plataforma DataWorks.
ListLineages	Consulta de entidades de linhagem para uma entidade do Data Map	Consulta as entidades de linhagem upstream e downstream para uma entidade especificada no Data Map, com a opção de incluir informações detalhadas de relacionamento de linhagem.
Coleções de metadados	Coleções de metadados
ListMetaCollections	Consultar lista de coleções do Data Map.	Consulta a lista de coleções do Data Map. Suporta a consulta tanto de categorias do Data Map quanto de álbuns de dados.
CreateMetaCollection	CreateMetaCollection	Cria uma coleção no Data Map. As coleções incluem categorias, subcategorias, álbuns de dados e categorias criadas nos álbuns de dados.
GetMetaCollection	Obter informações da coleção do Data Map.	Consulta as informações sobre uma coleção no Data Map. As coleções incluem categorias e álbuns de dados.
UpdateMetaCollection	Update Data Map Collection Object	Atualiza objetos de coleção do Data Map, incluindo categorias do Data Map e álbuns de dados. Você pode atualizar o nome da coleção, a descrição e as informações do administrador. Ao atualizar um álbum de dados, o chamador deve ter a permissão AliyunDataWorksFullAccess ou ser o criador ou um administrador do álbum.
DeleteMetaCollection	Exclui um objeto de coleção do Data Map	Exclui um objeto de coleção no Data Map especificado, incluindo categorias do Data Map e álbuns de dados. Ao excluir um álbum de dados, o chamador deve ter a permissão AliyunDataWorksFullAccess ou ser o criador ou administrador do álbum.
ListEntitiesInMetaCollection	Lista de entidades em uma coleção do Data Map.	Consulta uma lista de entidades em uma coleção no Data Map. As coleções incluem categorias e álbuns de dados. As entidades podem ser apenas tabelas.
AddEntityIntoMetaCollection	Adicionar um objeto de entidade a uma coleção do mapa de dados.	Adiciona um objeto de entidade especificado a uma coleção do Mapa de Dados. O objeto de coleção pode ser uma categoria do Mapa de Dados ou um álbum de dados. Atualmente, o objeto de entidade suporta apenas o tipo tabela de dados. Para adicionar uma entidade a um álbum de dados, o chamador deve ter a permissão AliyunDataWorksFullAccess ou ser o criador ou administrador do álbum.
RemoveEntityFromMetaCollection	Remove um objeto de entidade de uma coleção do Data Map	Remove um objeto de entidade de uma coleção do Data Map. A coleção oferece suporte a categorias do Data Map e álbuns de dados, e a entidade atualmente oferece suporte apenas ao tipo Tabela de Dados.\nAo remover uma entidade de um álbum de dados, o solicitante deve ter a permissão AliyunDataWorksFullAccess ou ser o criador ou administrador do álbum.

Centro de operações

API	Título	Descrição
Calendários de agendamento	Calendários de agendamento
UpdateCalendar	Atualizar um calendário de agendamento	Atualiza um calendário de agendamento. Esta é uma atualização completa que exige o envio da configuração editável completa.
ListCalendarVersions	Listar versões do calendário de agendamento	Consulta as versões de um calendário de agendamento especificado.
ListCalendars	Lista de calendários de agendamento	Consulta uma lista de calendários de agendamento.
GetCalendar	Obtém um calendário de agendamento especificado	Obtém a configuração atual de um calendário de agendamento especificado.
DeleteCalendar	Excluir um calendário de agendamento	Exclui um calendário de agendamento.
CreateCalendar	Criar um calendário de agendamento	Cria um calendário de agendamento.
Parâmetros	Parâmetros
CreateParameter	Criar um parâmetro	Cria um parâmetro.
DeleteParameter	Excluir um parâmetro.	Exclui um parâmetro especificado.
UpdateParameter	Atualizar um parâmetro.	Atualiza um parâmetro. Esta operação realiza uma atualização incremental e modifica apenas os campos especificados.
RollbackParameter	Reverter um parâmetro.	Reverte um parâmetro especificado.
GetParameter	GetParameter.	Obtém os detalhes de um parâmetro pelo seu ID.
ListParameters	Obter lista de parâmetros	Consulta a lista de parâmetros de consulta.
ListParameterVersions	Listar versões de parâmetros.	Lista as versões de parâmetros.
Monitoramento e alertas	Monitoramento e alertas
ListAlertRules	ListAlertRules.	Consulta uma lista de regras de alerta de monitoramento personalizadas.
GetAlertRule	Obter uma regra de alerta de monitoramento personalizado.	Obtém uma regra de alerta de monitoramento personalizado.
UpdateAlertRule	UpdateAlertRule.	Atualiza as informações sobre uma regra de monitoramento de alerta personalizada.
DeleteAlertRule	Excluir uma regra personalizada.	Exclui uma regra de alerta de monitoramento personalizado.
CreateAlertRule	Criar uma regra de alerta de monitoramento personalizado.	Cria uma regra de alerta de monitoramento personalizado.
Tarefas	Tarefas
GetUpdateTaskResult	Obtém o resultado de uma tarefa de atualização de nó.	Consulta o resultado da criação assíncrona de uma instância de fluxo de trabalho.
UpdateTaskAsync	Atualização assíncrona de um nó.	Atualiza assincronamente um nó especificado e sincroniza as alterações com o Data Studio como uma nova versão salva.
DeleteTask	Excluir uma tarefa	Exclui uma tarefa especificada.
UpdateTask	Atualizar um nó.	Atualiza um nó especificado. As modificações são sincronizadas com o Data Studio, onde uma nova versão salva é criada.
BatchUpdateTasks	Atualização de nós em lote.	Atualiza vários nós em lotes usando atualizações incrementais.
GetTask	GetTask.	Consulta as informações de uma tarefa.
ListTasks	ListTasks	Consulta uma lista de tarefas por página. Você também pode especificar condições de filtro para consultar tarefas.
ListUpstreamTasks	ListUpstreamTasks.	Consulta uma lista de tarefas ancestrais de uma tarefa por página.
ListDownstreamTasks	ListDownstreamTasks.	Consulta uma lista de tarefas descendentes de uma tarefa por página.
ListTaskOperationLogs	Recupera logs de operação de uma tarefa	Consulta uma lista paginada de logs de operação para uma tarefa especificada.
Instâncias de tarefa	Instâncias de tarefa
UpdateTaskInstances	Modificação das propriedades das instâncias de tarefa.	Modifica as propriedades de várias instâncias de tarefa em lote, incluindo prioridade, grupo de recursos, fonte de dados, entre outros.
GetTaskInstance	Detalhes da instância de tarefa	Obtém os detalhes de uma instância de tarefa especificada.
GetTaskInstanceLog	GetTaskInstanceLog.	Consulta o log de execução gerado durante uma execução específica de uma instância.
ListTaskInstances	Lista de instâncias de tarefa	Obtém uma lista paginada de instâncias de tarefa. Você também pode realizar uma consulta filtrada com base em condições.
ListUpstreamTaskInstances	Listar instâncias upstream.	Obtém as instâncias upstream de uma instância especificada por página.
ListTaskInstanceOperationLogs	Lista de logs de operação de instâncias de tarefa.	Obtém uma lista paginada de logs de operação para uma instância de tarefa.
ListDownstreamTaskInstances	Listar instâncias downstream.	Obtém uma lista paginada de instâncias downstream de uma instância especificada.
SuspendTaskInstances	SuspendTaskInstances.	Suspende várias instâncias simultaneamente.
ResumeTaskInstances	ResumeTaskInstances.	Retoma várias instâncias suspensas simultaneamente.
StopTaskInstances	Interromper instâncias de tarefa	Interrompe várias instâncias de tarefa.
SetSuccessTaskInstances	SetSuccessTaskInstances.	Define os status de várias instâncias como bem-sucedidos simultaneamente.
RerunTaskInstances	Reexecutar instâncias de nó.	Reexecuta várias instâncias de nó em lote.
RemoveTaskInstanceDependencies	RemoveTaskInstanceDependencies.	Remove várias dependências upstream de uma instância por vez.
TriggerSchedulerTaskInstance	TriggerSchedulerTaskInstance.	Aciona a execução de uma tarefa por meio de um nó HTTP Trigger em um horário especificado.
Fluxos de trabalho	Fluxos de trabalho
DeleteWorkflow	Excluir um fluxo de trabalho.	Exclui um fluxo de trabalho especificado.
Instâncias de fluxo de trabalho	Instâncias de fluxo de trabalho
GetRerunWorkflowInstancesResult	Obtenção do resultado de uma instância de workflow de reexecução	Consulta o resultado de uma instância de workflow de reexecução assíncrona.
RerunWorkflowInstances	Reexecução de uma instância de fluxo de trabalho	Reexecuta uma instância de fluxo de trabalho.
CreateWorkflowInstances	Criar uma instância de workflow	Cria uma instância de workflow com base em configurações, como uma instância de workflow de backfill de dados.
GetCreateWorkflowInstancesResult	GetCreateWorkflowInstancesResult.	Consulta o resultado da criação assíncrona de uma instância de fluxo de trabalho.
GetWorkflowInstance	GetWorkflowInstance.	Consulta as informações de uma instância de fluxo de trabalho.
ListWorkflowInstances	Lista de instâncias de fluxo de trabalho	Obtém uma lista de instâncias de fluxo de trabalho usando paginação. Você também pode realizar uma consulta filtrada com base em condições.
StartWorkflowInstances	Iniciar instâncias de fluxo de trabalho.	Inicia várias instâncias de fluxo de trabalho em lote.
StopWorkflowInstances	Encerrar instâncias de fluxo de trabalho	Encerra múltiplas instâncias de fluxo de trabalho em lotes.
ExecuteAdhocWorkflowInstance	Executar uma instância de workflow temporária	Cria uma instância de workflow temporária com base nas configurações especificadas.

Qualidade de dados

API	Título	Descrição
Modelos de regras de qualidade de dados	Modelos de regras de qualidade de dados
CreateDataQualityTemplate	Criar um modelo de regra de qualidade de dados.	Cria um modelo de regra de qualidade de dados em um projeto especificado.
UpdateDataQualityTemplate	Atualizar um modelo de regra de qualidade de dados.	Atualiza um modelo de regra de qualidade de dados em um projeto.
ListDataQualityTemplates	Listar modelos de regras de qualidade de dados.	Consulta a lista de modelos de regras de qualidade de dados em um projeto especificado.
GetDataQualityTemplate	GetDataQualityTemplate	Obtém os detalhes de um modelo de regra de qualidade de dados pelo ID do modelo.
DeleteDataQualityTemplate	DeleteDataQualityTemplate	Exclui um modelo de regra de qualidade de dados por ID.
Monitoramento de qualidade de dados	Monitoramento de qualidade de dados
CreateDataQualityScan	CreateDataQualityScan.	Cria um monitor de qualidade de dados.
UpdateDataQualityScan	Atualizar um monitor de qualidade de dados.	Atualiza um monitor de qualidade de dados.
ListDataQualityScans	Lista de tarefas de verificação de qualidade de dados.	Consulta a lista de tarefas de verificação de qualidade de dados em um projeto.
GetDataQualityScan	GetDataQualityScan.	Obtém os detalhes do monitoramento de qualidade de dados.
DeleteDataQualityScan	DeleteDataQualityScan	Exclui um monitor de qualidade de dados.
Regras de alerta	Regras de alerta
CreateDataQualityAlertRule	Criar uma regra de alerta de qualidade de dados	Cria uma regra de alerta de monitoramento de qualidade de dados em um projeto especificado.
UpdateDataQualityAlertRule	Atualizar uma regra de alerta de qualidade de dados	Atualiza uma regra de alerta de monitoramento de qualidade de dados especificada.
ListDataQualityAlertRules	Listar regras de alerta de qualidade de dados.	Consulta a lista de regras de alerta de qualidade de dados em um projeto.
GetDataQualityAlertRule	GetDataQualityAlertRule	Obtém os detalhes de uma regra de alerta de qualidade de dados por ID da regra.
DeleteDataQualityAlertRule	Excluir uma regra de alerta de qualidade de dados.	Exclui uma regra de alerta de monitoramento de qualidade de dados com base no ID especificado.
Execuções de qualidade de dados	Execuções de qualidade de dados
CreateDataQualityScanRun	Criar uma execução de verificação de qualidade de dados.	Aciona a execução de uma tarefa de monitoramento de qualidade de dados especificada e retorna o ID da instância de execução.
ListDataQualityScanRuns	Consultar registros de execução de varredura de qualidade de dados	Consulta os registros de execução de varredura de qualidade de dados de um projeto especificado.
GetDataQualityScanRunLog	Obter logs de execução de varredura de qualidade de dados.	Consulta o conteúdo de log de uma instância de tarefa de monitoramento de qualidade de dados especificada.
GetDataQualityScanRun	GetDataQualityScanRun.	Consulta os detalhes de execução de uma tarefa de verificação de qualidade de dados pelo seu ID.

Centro de segurança

API	Título	Descrição
Solicitações e aprovações de permissão	Solicitações e aprovações de permissão
ApplyResourceAccessPermission	Enviar uma solicitação de permissões de acesso a recursos.	Envia uma solicitação de permissões de acesso para recursos específicos.
StopProcessInstance	StopProcessInstance	Retira ou encerra uma instância de processo especificada.
ApproveProcessInstance	Aprovar uma instância de fluxo de trabalho.	Aprova ou rejeita uma instância de processo de aprovação especificada.
GetApplicationContents	Get Resource Permission Application Details	Queries the content of resource permission applications under the specified process instance ID.
GetProcessInstance	GetProcessInstance	Obtém os detalhes de uma instância de processo de aprovação especificada, incluindo seus nós de aprovação e lista de tarefas.
ListPendingApprovals	Consulta de ordens de solicitação de permissão pendentes.	Obtém a lista de ordens de solicitação de permissão pendentes para as quais o usuário atual é o aprovador.
ListMyRelatedApprovals	Query permission application orders related to me	Query all permission application orders where the current user is an approver or stakeholder.
ListMyApplications	Consulta de ordens de solicitação de permissão iniciadas por mim.	Consulta todas as ordens de solicitação de permissão de acesso a recursos iniciadas pelo usuário atual.
Políticas de controle de resultados de consulta	Políticas de controle de resultados de consulta
CreateSecurityStrategy	Cria uma política de segurança	Cria uma nova política de controle de segurança e oferece suporte à configuração de vários módulos e submódulos. Requer as permissões de administrador de locatário do DataWorks e de administrador de segurança.
DeleteSecurityStrategy	Excluir uma política de segurança.	Exclui uma política de segurança por seu ID. Para chamar esta operação, você deve ter as permissões de administrador de locatário e administrador de segurança do DataWorks.
UpdateSecurityStrategy	UpdateSecurityStrategy.	Para modificar a configuração de uma política de segurança existente, você deve ser administrador de locatário do DataWorks e administrador de segurança.
GetSecurityStrategy	Obter detalhes da política de segurança	Obtém os detalhes de uma política de segurança com base no ID da política de segurança fornecido.
ListSecurityStrategies	Obtém políticas de segurança por página	Obtém uma lista paginada de políticas de segurança no sistema com base em condições especificadas. Esta operação requer permissões de administrador de locatário e administrador de segurança do DataWorks.
FindBestMatchSecurityStrategy	Correspondência da melhor política de segurança	Consulta a política de segurança mais adequada com base nas condições especificadas.
Políticas de aprovação	Políticas de aprovação
CreateProcessDefinition	Criar uma definição de processo de aprovação.	Cria uma nova definição de processo de aprovação, com suporte à configuração personalizada de regras de aprovação e serviços de notificação.
DeleteProcessDefinition	DeleteProcessDefinition	Exclui uma definição de processo pelo ID especificado.
EnableProcessDefinition	EnableProcessDefinition	Ativa uma definição de processo com o ID especificado.
DisableProcessDefinition	DisableProcessDefinition	Desativa a definição de processo de aprovação especificada.
UpdateProcessDefinition	UpdateProcessDefinition.	Atualiza uma definição de processo de aprovação existente.
GetProcessDefinition	GetProcessDefinition	Obtém a política de aprovação para um determinado ID de definição de processo.
ListProcessDefinitions	ListProcessDefinitions	Consulta as definições de processo de um tipo especificado.
CreateIdentifyCredential	Criar uma credencial de identidade.	Cria uma credencial de identidade.

Gerenciamento de tags

API	Título	Descrição
CreateDataAssetTag	Criar uma tag	Cria uma tag.
DeleteDataAssetTag	DeleteDataAssetTag	Exclui uma tag.
UpdateDataAssetTag	Update a label.	Atualiza um rótulo.
ListDataAssetTags	Listar tags	Consulta uma lista de tags.
TagDataAssets	Anexar tags de ativos de dados	Anexa tags a ativos de dados.
UnTagDataAssets	Desassociar tags de ativos de dados	Desassocia tags de ativos de dados.
ListDataAssets	Lista de ativos associados a tags	Executa uma consulta paginada nos ativos de dados do DataWorks associados a tags.

Plataforma aberta

API	Título	Descrição
GetJobStatus	Obter status de execução de API assíncrona.	Retorna o status de uma tarefa assíncrona. Após chamar uma API assíncrona, consulte esta API periodicamente para obter o status de sucesso.

Outros

API	Título	Descrição
ListDataQualityEvaluationTasks	Tarefas de monitoramento de qualidade.	Consulta uma lista paginada de tarefas de monitoramento de qualidade.
ListDataQualityRules	Listar regras de qualidade.	Consulta regras de monitoramento de qualidade por paginação.
ListDataQualityEvaluationTaskInstances	Consulta a lista de instâncias de tarefas de monitoramento de qualidade	Realiza uma consulta paginada da lista de instâncias de tarefas de monitoramento de qualidade.
ListDataQualityResults	Consulta de resultados de qualidade de dados	Consulta uma lista de resultados de qualidade de dados usando paginação.
DetachDataQualityRulesFromEvaluationTask	Remover a associação entre uma regra de qualidade de dados e uma tarefa de monitoramento	Remove a associação entre uma regra de qualidade de dados e uma tarefa de monitoramento de qualidade de dados.
DeleteDataQualityEvaluationTask	Excluir um monitor de qualidade de dados	Exclui uma tarefa de monitoramento de qualidade de dados.
GetDataQualityEvaluationTaskInstance	Obter detalhes da instância de tarefa de verificação de qualidade de dados	Obtém os detalhes de uma instância de tarefa de verificação de qualidade de dados.
GetDataQualityEvaluationTask	Consulta dos detalhes de monitoramento de qualidade de dados	Consulta os detalhes de uma tarefa de validação de qualidade de dados.
AttachDataQualityRulesToEvaluationTask	Associar regras de qualidade de dados ao monitoramento de qualidade.	Associa regras de qualidade de dados a uma tarefa de verificação de qualidade de dados.
UpdateDataQualityEvaluationTask	Atualização do monitoramento de qualidade de dados	Atualiza uma tarefa de verificação de qualidade de dados.
CreateDataQualityEvaluationTaskInstance	Criação de uma instância de monitoramento de verificação de qualidade de dados.	Cria uma instância de tarefa de verificação de qualidade de dados.
CreateDataQualityEvaluationTask	Criação de monitoramento de qualidade de dados	Cria uma tarefa de monitoramento de qualidade de dados do DataWorks.
DeleteDataQualityRule	DeleteDataQualityRule	Exclui uma regra de monitoramento de qualidade de dados.
UpdateDataQualityRuleTemplate	Atualiza um modelo de regra de qualidade de dados.	Atualiza um modelo de regra de qualidade de dados.
CreateDataQualityRuleTemplate	Cria um modelo de regra de qualidade.	Cria um modelo de regra.
DeleteDataQualityRuleTemplate	Excluir um modelo de regra de qualidade de dados personalizado	Exclui um modelo de regra de qualidade de dados personalizado.
GetDataQualityRuleTemplate	Consulta os detalhes de um modelo de regra de qualidade de dados.	Consulta os detalhes de um modelo de regra de qualidade de dados.
CreateDataQualityRule	Criar uma regra de qualidade	Cria uma regra de qualidade.
UpdateDataQualityRule	Atualizar uma regra de qualidade	Atualiza uma regra de qualidade.
GetDataQualityRule	Consultar detalhes da regra de qualidade de dados.	Consulta os detalhes de uma regra de qualidade de dados.
ListDataQualityRuleTemplates	Listar modelos de regras de qualidade de dados.	Consulta uma lista de modelos de regras de qualidade de dados.
DeleteCertificate	Excluir um arquivo de certificado.	Exclui um arquivo de certificado.
GetCertificate	Visualizar um arquivo de certificado	Obtém um arquivo de certificado.
GetDataSource	Visualizar detalhes da fonte de dados.	Consulta uma fonte de dados especificada pelo ID da fonte de dados.
ImportCertificate	Importar um arquivo de autenticação.	Importa um arquivo de certificado.
ListCertificates	ListCertificates.	Obtém uma lista de arquivos de certificado.
DeleteFile	Exclui um arquivo do Data Studio.	Exclui um arquivo do Data Studio. Se o arquivo tiver sido submetido, um processo assíncrono será acionado para excluir o arquivo no sistema de agendamento. O valor do parâmetro DeploymentId retornado é usado para chamar a operação GetDeployment a fim de consultar o status do processo assíncrono.
GetWorkflow	GetWorkflow.	Consulta as informações de um fluxo de trabalho.
ListWorkflows	Listar workflows	Obtém uma lista de workflows com paginação e oferece suporte a consultas filtradas por condições.
UpdateWorkflow	Atualizar um fluxo de trabalho.	Atualiza um fluxo de trabalho especificado usando o método de atualização completa. Os campos que podem ser atualizados sincronamente para o Data Studio incluem: proprietário, fonte de dados, grupo de recursos de agendamento, descrição e modo de execução do gatilho (Normal, Skip ou Pause).
AbolishCrossProjectPipelineRun	Interromper um fluxo de publicação entre workspaces.	Interrompe um fluxo de publicação entre workspaces.
CreateCrossProjectPipelineRun	Cria um fluxo de implantação entre workspaces.	Cria um fluxo de implantação entre workspaces.
ExecCrossProjectPipelineRun	Executa um fluxo de implantação entre workspaces.	Executa um fluxo de implantação entre workspaces.
GetCrossProjectPipelineRun	Consulta os detalhes do fluxo de implantação entre workspaces.	Consulta os detalhes de um fluxo de implantação entre workspaces.
ListCrossProjectDeploymentCandidates	Consulta de objetos candidatos à implantação entre espaços de trabalho.	Consulta os objetos candidatos à implantação entre espaços de trabalho.
ListCrossProjectDeploymentEnvironments	Consulta de ambientes de implantação entre espaços de trabalho.	Consulta os ambientes de implantação entre espaços de trabalho.
ListCrossProjectPipelineRunItems	Itens do pipeline de publicação entre workspaces.	Consulta os itens de publicação de um pipeline de publicação entre workspaces.
ListCrossProjectPipelineRuns	Consulta de fluxos de publicação entre espaços de trabalho.	Consulta a lista de fluxos de publicação entre espaços de trabalho.

Others

API	Título	Descrição
UpdateAgentSessionTitle	Modifica o título da sessão do agente	Modifica o título de uma sessão de agente acessível à identidade atual sem alterar o status de execução da tarefa.