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/2020-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.

Locatário

API	Título	Descrição
ListCalcEngines	ListCalcEngines	Queries a list of compute engines that are associated with a DataWorks workspace.
CreateDataSource	CreateDataSource.	Adiciona uma fonte de dados ao DataWorks.
ListDataSources	ListDataSources.	Consulta as fontes de dados adicionadas a um espaço de trabalho do DataWorks.
UpdateDataSource	UpdateDataSource.	Atualiza uma fonte de dados.
DeleteDataSource	DeleteDataSource.	Remove uma fonte de dados.
ListResourceGroups	Listar grupos de recursos	Consulta uma lista de grupos de recursos de um tipo especificado.
GetProject	Consultar detalhes do workspace.	Consulta os detalhes de um workspace do DataWorks.
AddProjectMemberToRole	Adicionar um usuário do espaço de trabalho a uma função.	Adiciona um usuário do espaço de trabalho do DataWorks a uma função. Antes de chamar esta operação, você deve primeiro adicionar a conta de destino como membro do espaço de trabalho do DataWorks.
CreateProjectMember	Adicionar um usuário a um workspace	Adiciona um usuário a um workspace do DataWorks.
DeleteProjectMember	Remover um usuário de um workspace do DataWorks.	Remove um usuário de um workspace do DataWorks.
ListProjectRoles	Obter todas as funções em um workspace.	Obtém uma lista de todas as funções em um workspace.
RemoveProjectMemberFromRole	Remoção de um usuário de uma função em um workspace.	Remove um usuário de uma função do DataWorks em um workspace do DataWorks.
ListProjectMembers	Listar membros do workspace	Consulta a lista de membros existentes em um workspace do DataWorks.
ListProjects	Listar workspaces	Consulta uma lista de workspaces do DataWorks no tenant ao qual o usuário pertence.
ListProjectIds	Lista os IDs de workspaces do DataWorks para uma conta.	Consulta os IDs dos workspaces nos quais uma conta específica da Alibaba Cloud ou um usuário RAM tem permissões em uma região específica.
CreateProject	Criar um espaço de trabalho do DataWorks.	Cria um espaço de trabalho do DataWorks.
ChangeResourceManagerResourceGroup	Alterar o grupo de recursos de um recurso.	Altera o grupo de recursos de um recurso.
ListMeasureData	ListMeasureData.	Consulta as estatísticas sobre o número de alertas por chamada telefônica ou por mensagem de texto reportados no tenant ao qual sua conta pertence nos últimos 30 dias.

Metadados

API	Título	Descrição
ListTables	ListTables.	Obtém tabelas de diferentes tipos de fonte de dados em um locatário por página.
GetMetaDBInfo	Obter metadados básicos de uma instância de mecanismo.	Obtém as informações básicas de metadados de uma instância de mecanismo.
GetMetaDBTableList	Obter tabelas em uma instância de mecanismo.	Obtém tabelas na instância do mecanismo especificada.
CheckMetaTable	Verificar se uma tabela existe.	Verifica se uma tabela existe.
CheckMetaPartition	CheckMetaPartition.	Verifica se uma partição em uma metatabela do MaxCompute existe.
SearchMetaTables	SearchMetaTables.	Consulta metatabelas com base em condições específicas.
GetMetaTableBasicInfo	GetMetaTableBasicInfo.	Consulta as informações básicas de uma metatabela.
GetMetaTableColumn	GetMetaTableColumn.	Consulta as informações dos campos de uma metatabela.
GetMetaTablePartition	Obtenção das partições de uma tabela	Obtém as partições de uma tabela.
GetMetaTableOutput	Obter informações de saída da tabela.	Obtém as informações de saída de uma tabela.
GetMetaTableChangeLog	Retrieve table change log.	Obtém o log de alterações de uma tabela.
GetMetaTableIntroWiki	Obter instruções de uso da tabela.	Obtém as instruções de uso de uma tabela.
CreateMetaCategory	CreateMetaCategory.	Cria uma categoria.
DeleteMetaCategory	DeleteMetaCategory.	Exclui uma categoria.
UpdateMetaCategory	UpdateMetaCategory.	Atualiza uma categoria.
GetMetaCategory	Consulta da árvore de categorias.	Consulta a árvore de categorias.
GetMetaTableListByCategory	GetMetaTableListByCategory.	Consulta metatabelas em uma categoria especificada.
AddToMetaCategory	AddToMetaCategory.	Adiciona uma metatabela a uma categoria especificada.
DeleteFromMetaCategory	DeleteFromMetaCategory.	Remove uma tabela de uma categoria especificada.
UpdateMetaTable	UpdateMetaTable.	Esta operação atualiza os metadados de uma tabela.
UpdateMetaTableIntroWiki	Atualizar descrição da tabela.	Atualiza a descrição de uma tabela. Se os dados não existirem, a descrição é adicionada.
ListMetaDB	Listar bancos de dados	Consulta a lista de bancos de dados.
UpdateTableModelInfo	Modificar informações do modelo de tabela	Modifica o tema, a hierarquia e a classificação física de uma tabela.
CreateTableTheme	CreateTableTheme.	Cria um tema de tabela. Esta operação será substituída em breve. Recomendamos que você não chame esta operação.
DeleteTableTheme	DeleteTableTheme.	Exclui um tema de tabela. Esta operação será substituída em breve. Recomendamos que você não chame esta operação.
UpdateTableTheme	UpdateTableTheme.	Atualiza um tema de tabela. Esta operação será substituída em breve. Recomendamos que você não chame esta operação.
ListTableTheme	ListTableTheme.	Lista os temas de tabela. Esta operação será substituída em breve. Recomendamos que você não chame esta operação.
GetMetaTableThemeLevel	Query theme and level information of a table	Consulta as informações de tema e nível de uma tabela.
CreateTableLevel	CreateTableLevel.	Cria um nível de hierarquia. Esta operação será substituída em breve. Recomendamos que você não chame esta operação.
UpdateTableLevel	UpdateTableLevel.	Atualiza um nível de hierarquia. Esta operação será substituída em breve. Recomendamos que você não chame esta operação.
DeleteTableLevel	DeleteTableLevel.	Exclui um nível de hierarquia. Esta operação será descontinuada em breve. Recomendamos que você não utilize esta operação.
ListTableLevel	ListTableLevel.	Lista os níveis de hierarquia. Esta operação será substituída em breve. Recomendamos que você não chame esta operação.
UpdateMetaCollection	Atualizar um objeto de coleção.	Atualiza o nome e o comentário de um objeto de coleção.
ListMetaCollections	Consulta informações de coleções.	Consulta informações de coleções. As coleções incluem álbuns e subcategorias dentro de álbuns na página Mapa de Dados. Você pode chamar esta operação para consultar informações de coleções especificando um tipo de coleção.
ListMetaCollectionEntities	Consulta de entidades em uma coleção.	Consulta entidades em uma coleção.
DeleteMetaCollection	Excluir uma coleção.	Exclui uma coleção.
GetMetaCollectionDetail	Consulta de detalhes da coleção.	Consulta os detalhes de uma coleção.
DeleteMetaCollectionEntity	Exclui uma entidade de uma coleção.	Exclui uma entidade de uma coleção.
AddMetaCollectionEntity	Adicionar uma entidade a uma coleção.	Adiciona uma entidade a uma coleção.
CreateMetaCollection	Criar um objeto de coleção.	Cria um objeto de coleção.
ListLineage	Consulta de linhagem da entidade.	Consulta as relações de linhagem upstream e downstream de uma entidade.
DeleteLineageRelation	DeleteLineageRelation.	Exclui relações de linhagem entre entidades. Apenas relações de linhagem personalizadas registradas pelos usuários podem ser excluídas.
RegisterLineageRelation	Registrar relacionamento de linhagem.	Registra relacionamentos de entidades. Você pode registrar relacionamentos de entidades personalizadas.
GetMetaTableLineage	Consulta a linhagem da tabela.	Consulta a linhagem de dados de uma tabela.
GetMetaColumnLineage	Obter linhagem da coluna.	Consulta a linhagem de uma coluna chamando GetMetaColumnLineage.

Data Studio

API	Título	Descrição
CreateFile	Criar um arquivo no Data Studio	Cria um arquivo no Data Studio. Esta operação não oferece suporte à criação de tarefas de nó de integração de dados.
CreateUdfFile	Criar um arquivo de função no Data Studio	Cria um arquivo de função no Data Studio.
CreateBusiness	Criar um fluxo de trabalho	Cria um fluxo de trabalho no Data Studio.
DeleteBusiness	DeleteBusiness.	Exclui um fluxo de trabalho.
CreateFolder	CreateFolder.	Cria uma pasta.
UpdateBusiness	UpdateBusiness.	Atualiza um fluxo de trabalho.
ListFiles	Listar arquivos.	Consulta uma lista de arquivos.
EstablishRelationTableToBusiness	Importa uma tabela para um fluxo de trabalho.	Importa uma tabela para um fluxo de trabalho. Isso equivale a clicar com o botão direito do mouse em um fluxo de trabalho na página Data Studio e selecionar Importar Tabela.
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 criar uma tarefa correspondente.
ListBusiness	Lista de processos de negócios.	Consulta uma lista de fluxos de trabalho.
GetFileVersion	Detalhes da versão do arquivo.	Consulta as informações sobre uma versão de arquivo.
DeleteFolder	Excluir uma pasta do Data Studio.	Exclui uma pasta da página do Data Studio.
DeleteFile	Exclui um arquivo do Data Studio.	Exclui um arquivo do Data Studio. Se o arquivo tiver sido confirmado, 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.
GetDeployment	Obter detalhes do pacote de implantação.	Consulta as informações sobre um pacote de implantação.
UpdateFile	Atualização de um nó de arquivo existente	Atualiza um arquivo existente.
GetFolder	Obter detalhes da pasta	Obtém os detalhes de uma pasta.
ListFileVersions	ListFileVersions.	Consulta uma lista de versões de arquivo.
GetFile	Obter informações do arquivo.	Consulta as informações sobre um arquivo.
ListFolders	Listar pastas.	Chama a operação ListFolders para consultar pastas.
DeployFile	Implantar um arquivo.	Implanta um arquivo no ambiente de produção.
UpdateUdfFile	Atualizar informações do arquivo da função	Atualiza as informações do arquivo de uma função.
GetBusiness	Obter informações do fluxo de trabalho.	Consulta as informações de um fluxo de trabalho.
UpdateFolder	Atualizar uma pasta.	Atualiza uma pasta.
ListDeployments	Lista de pacotes de implantação.	Consulta uma lista de pacotes de implantação. Esta operação equivale a visualizar uma lista de pacotes de implantação na página Pacotes de Implantação do console do DataWorks.
UpdateIDEEventResult	Atualiza o resultado da verificação de um evento de ponto de extensão.	Retorna o resultado da verificação de um evento de ponto de extensão para o Data Studio após o evento de ponto de extensão ser acionado durante o desenvolvimento de dados e verificado por uma extensão.
GetIDEEventDetail	Consulta do snapshot de dados quando um evento de ponto de extensão é acionado.	Consulta o snapshot de dados do ponto de extensão no momento em que um evento de ponto de extensão é acionado, com base no ID da mensagem de uma mensagem aberta do DataWorks.
CreateResourceFile	Cria um arquivo de recurso.	Cria ou carrega um arquivo de recurso no Data Studio. A funcionalidade implementada ao chamar esta operação é a mesma que a funcionalidade de criação de recursos fornecida no ambiente de desenvolvimento integrado (IDE).

Integração de Dados

API	Título	Descrição
CreateDISyncTask	Criar uma tarefa de sincronização do Data Integration	Cria uma tarefa de sincronização do Data Integration.
DeleteDISyncTask	DeleteDISyncTask.	Exclui uma tarefa de sincronização em tempo real.
UpdateDISyncTask	Atualizar uma tarefa de sincronização do Data Integration.	Atualiza uma tarefa de sincronização de dados.
TestNetworkConnection	Testar a conectividade de rede da fonte de dados	Testa a conectividade de rede entre a fonte de dados de destino e o grupo de recursos.
GetDataSourceMeta	Obtenção de metadados da fonte de dados.	Consulta os metadados de uma fonte de dados especificada.
ListDIProjectConfig	Configuração padrão do projeto do Data Integration.	Consulta as configurações globais padrão das soluções de sincronização em um workspace do DataWorks especificado.
UpdateDIProjectConfig	Atualização da configuração padrão do projeto do Data Integration.	Modifica a configuração global padrão das soluções de sincronização em um workspace do DataWorks.
GetDISyncTask	GetDISyncTask.	Obtém os detalhes de uma tarefa de sincronização ou de uma solução de sincronização de dados.
DeployDISyncTask	Implantar e publicar uma tarefa de sincronização	Publica uma tarefa de sincronização em tempo real.
GetDISyncInstanceInfo	Obter informações da instância de sincronização do Data Integration.	Consulta o status de uma tarefa de sincronização em tempo real ou de uma solução de sincronização de dados.
TerminateDISyncInstance	Encerrar uma instância de sincronização do Data Integration.	Cancela a implantação de uma tarefa de sincronização em tempo real.
GenerateDISyncTaskConfigForCreating	Geração assíncrona da configuração JSON para uma tarefa de sincronização	Gera assincronamente a configuração JSON para uma tarefa de sincronização.
GenerateDISyncTaskConfigForUpdating	Gerar assincronamente a configuração para atualizar uma tarefa de sincronização	Gera assincronamente a configuração JSON para atualizar uma tarefa de sincronização.
StartDISyncInstance	StartDISyncInstance.	Inicia uma tarefa de sincronização em tempo real ou uma solução de sincronização.
StopDISyncInstance	StopDISyncInstance.	Interrompe uma tarefa de sincronização em tempo real.
QueryDISyncTaskConfigProcessResult	Consulta do resultado de uma tarefa assíncrona	Consulta o resultado de uma tarefa assíncrona.
CreateDIJob	CreateDIJob.	Cria uma tarefa na nova versão do Data Integration. Atualmente, os tipos de tarefa suportados incluem a solução de sincronização completa de banco de dados em tempo real do MySQL para o Hologres.
DeleteDIJob	DeleteDIJob.	Exclui uma tarefa do Data Integration da nova versão. Somente o seguinte tipo de tarefa é compatível: sincronização em tempo real de um banco de dados MySQL inteiro para o Hologres.
GetDIJob	GetDIJob.	Consulta as informações sobre uma tarefa de sincronização de nova versão criada no Data Integration. Os seguintes tipos de tarefas de sincronização são suportados: sincronização em tempo real de todos os dados em um banco de dados MySQL para o Hologres.
ListDIJobs	ListDIJobs	Consulta a lista de tarefas de integração de dados da nova versão. Os tipos de tarefa suportados atualmente incluem tarefas de sincronização em tempo real de banco de dados completo do MySQL para o Hologres.
StartDIJob	StartDIJob.	Inicia uma tarefa de sincronização de uma nova versão. Somente o seguinte tipo de tarefa é suportado: sincronização em tempo real de um banco de dados MySQL inteiro para o Hologres.
StopDIJob	StopDIJob.	Interrompe uma tarefa de sincronização de nova versão. O seguinte tipo de tarefa de sincronização é compatível: sincronização em tempo real de todos os dados de um banco de dados MySQL para o Hologres.
UpdateDIJob	UpdateDIJob.	Atualiza uma tarefa de sincronização da nova versão. O seguinte tipo de tarefa é compatível: sincronização em tempo real de todos os dados de um banco de dados MySQL para o Hologres.
CreateDIAlarmRule	CreateDIAlarmRule.	Cria uma regra de alerta para uma tarefa na nova versão do Data Integration. Atualmente, os tipos de tarefa suportados incluem a solução de sincronização de banco de dados completo em tempo real do MySQL para o Hologres.
DeleteDIAlarmRule	DeleteDIAlarmRule.	Exclui uma regra de alerta para uma tarefa do Data Integration da nova versão. Somente o seguinte tipo de tarefa é compatível: sincronização em tempo real de um banco de dados MySQL inteiro para o Hologres.
GetDIAlarmRule	Obter uma regra de alerta para uma tarefa de Integração de Dados da nova versão.	Obtém uma regra de alerta para uma tarefa de Integração de Dados da nova versão. Atualmente, o tipo de tarefa suportado é a solução de sincronização de banco de dados em tempo real do MySQL para o Hologres.
ListDIAlarmRules	Lista de regras de alerta para tarefas de integração de dados de nova versão.	Consulta a lista de regras de alerta para nós de nova versão de integração de dados. Atualmente, os tipos de nó suportados incluem as soluções em tempo real de banco de dados completo do MySQL para Hologres.
UpdateDIAlarmRule	Atualização das regras de alerta para novas tarefas de integração de dados	Atualiza as regras de alerta para novas tarefas de integração de dados. Os tipos de tarefa atualmente suportados incluem a solução de sincronização em tempo real de banco de dados completo do MySQL para o Hologres.

Modelagem de Dados

API	Título	Descrição
QueryPublicModelEngine	QueryPublicModelEngine.	Consulta informações sobre o mecanismo de Modelagem de Dados usando instruções FML.

Centro de Operações

API	Título	Descrição
GetAlertMessage	GetAlertMessage.	Consulta as informações de alerta com base no ID de alerta especificado pelo parâmetro AlertId.
ListAlertMessages	ListAlertMessages.	Consulta uma lista de alertas.
GetBaselineConfig	Obter detalhes de configuração da linha de base.	Obtém os detalhes de configuração de uma linha de base chamando GetBaselineConfig.
ListNodesByBaseline	Obter nós em uma linha de base	Obtém os nós de uma linha de base, excluindo seus nós upstream.
ListBaselineConfigs	ListBaselineConfigs.	Consulta uma lista de linhas de base.
GetBaselineKeyPath	Obter o caminho crítico de uma instância de linha de base	Obtém o caminho crítico de uma instância de linha de base.
GetBaselineStatus	Obter detalhes da instância de linha de base.	Obtém os detalhes de uma instância de linha de base.
ListBaselineStatuses	Lista de instâncias de linha de base.	Obtém uma lista de instâncias de linha de base.
DeleteRemind	Excluir uma regra de alerta de monitoramento personalizado.	Exclui uma regra de alerta de monitoramento personalizado.
UpdateRemind	Atualização de uma regra de alerta personalizada	Atualiza uma regra de alerta personalizada.
CreateRemind	Criar uma regra de alerta personalizada.	Cria uma regra de alerta personalizada chamando CreateRemind.
GetRemind	GetRemind.	Consulta as informações sobre uma regra de alerta personalizada.
ListReminds	ListReminds	Consulta uma lista de regras de alerta personalizadas.
ListTopics	Query or search for events	Consulta ou pesquisa uma lista de eventos.
GetTopic	Consultar detalhes do evento	Consulta os detalhes de um evento.
GetTopicInfluence	Obter a lista de instâncias de linha de base afetadas por um evento	Obtém a lista de instâncias de linha de base afetadas por um evento.
GetNode	Obter detalhes do nó.	Obtém os detalhes de um nó.
ListNodeInputOrOutput	Consultar informações de entrada e saída do nó.	Consulta as informações de entrada e saída do nó atual.
ListNodes	Listar nós	Consulta uma lista de nós.
GetNodeCode	GetNodeCode.	Obtém o código de um nó.
GetInstance	GetInstance.	Consulta as informações de uma instância.
ListInstances	Recuperar uma lista de instâncias	Consulta uma lista de instâncias.
GetInstanceLog	Obter logs da instância	Obtém os logs de uma instância.
StopInstance	Encerrar uma instância	Encerra uma instância.
RestartInstance	Reiniciar uma instância	Reinicia uma instância.
SetSuccessInstance	SetSuccessInstance.	Define o estado de uma instância com falha como bem-sucedido.
SuspendInstance	Suspender uma instância	Suspende uma instância.
ResumeInstance	ResumeInstance.	Retoma uma instância pausada.
RunCycleDagNodes	Criar um fluxo de trabalho de backfill de dados	Cria um fluxo de trabalho de backfill de dados.
RunSmokeTest	RunSmokeTest.	Cria um fluxo de trabalho de teste de fumaça chamando a operação RunSmokeTest.
ListSuccessInstanceAmount	Obter a contagem de instâncias concluídas com sucesso.	Obtém a tendência de contagens de instâncias concluídas com sucesso em diferentes horas na data de negócios para instâncias periódicas geradas nessa data.
ListInstanceAmount	ListInstanceAmount.	Consulta a tendência do número de instâncias de nó acionadas automaticamente em um período de tempo especificado.
TopTenElapsedTimeInstance	Classificação das tarefas com maior tempo de execução de ontem	Obtém a classificação de instâncias por duração de execução.
TopTenErrorTimesInstance	TopTenErrorTimesInstance.	Consulta a classificação dos nós nos quais ocorreram erros no último mês.
GetFileTypeStatistic	Obter distribuição de tipos de tarefa de nó	Consulta a distribuição dos tipos de tarefa de nó.
GetInstanceStatusStatistic	Estatísticas de status de execução de instâncias	Obtém o número de tarefas de instância em cada status de execução.
ListFileType	ListFileType.	Consulta as informações sobre os tipos de nó, como o código e o nome.
RunManualDagNodes	Execução de um fluxo de trabalho manual.	Aciona a execução de um fluxo de trabalho manual. O fluxo de trabalho manual deve ter sido submetido e publicado na página do ambiente antes de aparecer no Operation Center e poder ser acionado por esta operação.
ListManualDagInstances	ListManualDagInstances.	Consulta as informações sobre as instâncias em um fluxo de negócios executado manualmente.
GetDag	GetDag.	Consulta os detalhes do DAG para fluxos de negócios manuais, tarefas manuais e backfill de dados. Não há suporte para detalhes de DAG de tarefas agendadas regularmente.
ListDags	Listar DAGs	Consulta os detalhes de todos os DAGs para um único backfill de dados com base no OpSeq, o identificador exclusivo do backfill de dados.
ListNodesByOutput	ListNodesByOutput.	Consulta nós por uma correspondência exata na saída dos nós.
RunTriggerNode	Run a trigger node.	Executa um nó de gatilho.
GetNodeParents	Obter lista de nós upstream.	Chama GetNodeParents para obter a lista de nós upstream.
GetNodeChildren	Obter nós downstream	Obtém os nós downstream de um nó.
UpdateNodeRunMode	UpdateNodeRunMode.	Congela ou descongela um nó especificado.
UpdateNodeOwner	Atualizar proprietário do nó	Atualiza o proprietário de um nó especificado.
UpdateWorkbenchEventResult	Atualiza o resultado do processamento de uma extensão	Retorna o resultado do processamento de uma extensão para o Operation Center. Chame esta operação quando um processo do Operation Center for bloqueado pela extensão.
ListShiftPersonnels	Obtém a lista de pessoal de plantão para uma escala de turnos	Obtém a lista de pessoal de plantão para uma escala de turnos.
ListShiftSchedules	ListShiftSchedules.	Consulta uma lista de escalas de plantão no Centro de Operações.
ListInstanceHistory	Obter todos os registros de histórico da instância.	Obtém todos os registros de histórico de uma instância. Um registro de histórico é gerado sempre que um nó é reexecutado.
ListInnerNodes	ListInnerNodes.	Obtém uma lista de nós internos dentro de um grupo de nós ou nó do-while. Esta operação não oferece suporte à consulta dos nós internos de um nó PAI.
OfflineNode	OfflineNode.	Cancela a implantação de um nó.
GetBaseline	Obter configuração da linha de base	Obtém a configuração da linha de base com base em um ID de linha de base.
UpdateBaseline	Atualizar configurações da linha de base	Atualiza uma linha de base.

Qualidade de Dados

API	Título	Descrição
UpdateQualityFollower	UpdateQualityFollower.	Atualiza uma relação de assinatura.
UpdateQualityRule	Atualizar regra.	Chama UpdateQualityRule para atualizar as informações de uma regra de verificação de qualidade.
GetQualityRule	Obter informações da regra de qualidade.	Obtém informações sobre uma regra de qualidade.
ListQualityRules	Recuperar regras por expressão de partição	Consulta a lista de regras de qualidade com base em uma expressão de partição.
CreateQualityRule	CreateQualityRule.	Chama CreateQualityRule para criar uma regra de qualidade.
DeleteQualityFollower	DeleteQualityFollower	Exclui um assinante de uma expressão de partição. Após a exclusão do assinante, ele deixa de receber notificações quando uma regra de monitoramento de qualidade de dados é acionada.
DeleteQualityRule	DeleteQualityRule.	Exclui uma regra de qualidade de dados.
GetQualityFollower	Get subscribers of a partition expression	Obtém os assinantes de uma expressão de partição.
CreateQualityFollower	CreateQualityFollower.	Cria um assinante para uma expressão de partição chamando CreateQualityFollower.
DeleteQualityEntity	DeleteQualityEntity	Exclui uma expressão de partição.
GetQualityEntity	Retrieve a partition expression.	Obtém uma expressão de partição.
CreateQualityEntity	CreateQualityEntity	Cria uma expressão de partição para qualidade de dados.
CreateQualityRelativeNode	CreateQualityRelativeNode.	Cria uma associação de expressão de partição.
DeleteQualityRelativeNode	DeleteQualityRelativeNode	Exclui uma associação de agendamento.
ListQualityResultsByEntity	ListQualityResultsByEntity	Usa ListQualityResultsByEntity para obter resultados de validação com base em uma expressão de partição.
ListQualityResultsByRule	ListQualityResultsByRule.	Valida a qualidade de uma fonte de dados em relação às regras de validação e retorna os resultados da validação.

Serviço de Dados

API	Título	Descrição
CreateDataServiceApi	Cria uma API de serviço de dados	Cria uma API de serviço de dados.
PublishDataServiceApi	Publicar API de serviço de dados	Publica uma API de serviço de dados.
DeleteDataServiceApi	DeleteDataServiceApi.	Exclui uma API do DataService.
ListDataServiceApis	Lista de APIs de serviço de dados em desenvolvimento	Consulta uma lista de APIs de serviço de dados em desenvolvimento.
GetDataServiceApi	GetDataServiceApi.	Obtém os detalhes de uma API do DataService Studio no estado de desenvolvimento.
UpdateDataServiceApi	UpdateDataServiceApi.	Atualiza as informações de uma API no estado de desenvolvimento no DataService Studio.
GetDataServicePublishedApi	GetDataServicePublishedApi.	Obtém os detalhes de uma API publicada do DataService Studio.
ListDataServicePublishedApis	Lista as APIs publicadas do Data Service.	Consulta a lista de APIs publicadas do Data Service chamando ListDataServicePublishedApis.
ListDataServiceApiAuthorities	Consulta de APIs autorizadas para outros usuários	Consulta a lista de APIs autorizadas para outros usuários.
ListDataServiceAuthorizedApis	Lista de APIs autorizadas no DataService.	Obtém uma lista de APIs autorizadas no DataService.
AbolishDataServiceApi	AbolishDataServiceApi.	Cancela a publicação de uma API do DataService Studio.
GetDataServiceApplication	Obter detalhes do aplicativo do Data Service.	Obtém os detalhes de um aplicativo do Data Service.
ListDataServiceApplications	ListDataServiceApplications.	Obtém uma lista de aplicações.
CreateDataServiceFolder	CreateDataServiceFolder.	Cria uma pasta no DataService Studio.
GetDataServiceFolder	Obter pasta de serviço de dados	Consulta uma pasta de serviço de dados.
ListDataServiceFolders	Listar pastas do serviço de dados	Consulta as pastas do serviço de dados.
CreateDataServiceGroup	CreateDataServiceGroup.	Cria um processo de negócios.
GetDataServiceGroup	Consulta a um fluxo de negócios do Data Service	Consulta um fluxo de negócios do Data Service.
ListDataServiceGroups	Consulta de processos de negócios do Data Service.	Consulta a lista de processos de negócios do Data Service.
CreateDataServiceApiAuthority	Concessão de autorização para API de serviço de dados	Concede autorização para uma API de serviço de dados.
DeleteDataServiceApiAuthority	Revogação de autorização de API de serviço de dados	Revoga a autorização de uma API de serviço de dados.
ListDataServiceApiTest	Listar registros de teste da API do DataService.	Lista os registros de teste de uma API do DataService. Apenas dados do último mês podem ser consultados.
TestDataServiceApi	Testar uma API do Data Service.	Testa uma API do Data Service em modo assíncrono. Você pode chamar a operação GetDataServiceApiTest para consultar o resultado do teste.
GetDataServiceApiTest	Obter resultados de teste da API.	Consulta os resultados de teste de uma API no Data Service.
SubmitDataServiceApi	Submeter uma API do Data Service.	Submete uma API no Data Service.
SaveDataServiceApiTestResult	Salvar resultados de teste da API.	Salva os resultados de teste de uma API.

Data Security Guard

API	Título	Descrição
DsgQueryRowDetail	Data Security Guard - acesso a dados - consulta de lista detalhada de exportação.	Consulta os detalhes de exportação no nível de linha.
DsgQueryDetails	Data Security Guard - acesso a dados - consulta de exportação.	Consulta os detalhes de exportação.
DsgGetVisitStat	Data Security Guard - Consulta de registros de comportamento de acesso a dados.	Consulta os registros de acesso a dados.
DsgGetVisitDetail	Data Security Guard - Detalhes do comportamento de acesso.	Consulta os detalhes do comportamento de acesso.
DsgUpdateDesensStatusList	Atualiza o status dos switches de mascaramento de dados.	Atualiza o status dos switches de mascaramento de dados.
DsgQueryDesensStatusList	Consulta do switch de mascaramento de dados.	Consulta o status do switch de mascaramento de dados.
GetOpSensitiveData	Obtenção de registros de acesso a dados sensíveis	Obtém os registros de acesso a dados sensíveis para uma data especificada em todos os workspaces do DataWorks de um tenant.
DesensitizeData	Mascaramento de dados.	Envia dados para mascaramento e retorna o resultado mascarado.
GetOpRiskData	Obter registros de acesso a dados sensíveis de risco	Obtém os registros de acesso a dados sensíveis de risco em uma data especificada em todos os workspaces do DataWorks de um tenant.
GetSensitiveData	Obter resultados de identificação de dados sensíveis.	Consulta os resultados mais recentes de identificação de dados sensíveis em todos os workspaces do DataWorks de um locatário.
ScanSensitiveData	Verificação de dados sensíveis.	Verifica se os dados de entrada contêm dados sensíveis.
DsgQuerySensResult	Obter resultados de identificação de dados sensíveis.	Obtém os resultados de identificação de dados sensíveis do Data Security Guard.
QueryDefaultTemplate	Consulta do modelo padrão de classificação e nivelamento de dados.	Consulta o modelo padrão de classificação e nivelamento de dados definido pelo Data Security Guard.
DsgStopSensIdentify	Interromper uma tarefa de identificação de classificação e graduação de dados sensíveis.	Interrompe uma tarefa de identificação de dados sensíveis.
QuerySensClassification	Consulta de nós de classificação na classificação e graduação de dados	Consulta os nós de classificação no recurso de classificação e graduação de dados do Data Security Guard.
QuerySensLevel	Consulta de níveis de sensibilidade de dados.	Consulta os níveis de sensibilidade de dados no Data Security Guard.
QueryRecognizeRulesType	Tipos de regras de identificação integradas para campos sensíveis.	Consulta os tipos de regras de identificação integradas para campos sensíveis definidos no Data Security Guard.
DsgRunSensIdentify	Iniciar uma tarefa de identificação de dados sensíveis.	Inicia uma tarefa de identificação de dados sensíveis no Data Security Guard.
DeleteRecognizeRule	Exclui regras de classificação e graduação de dados.	Exclui uma regra de classificação e graduação de dados definida no Data Security Guard.
QuerySensNodeInfo	Consulta das regras de identificação de classificação e nivelamento de dados.	Consulta as regras de identificação de classificação e nivelamento de dados no Data Security Guard.
AddRecognizeRule	Adição de um campo sensível definido por regras de classificação e graduação	Adiciona um campo sensível definido pelas regras de classificação e graduação de dados do Data Security Guard.
EditRecognizeRule	Editar campos sensíveis definidos nas regras de classificação e graduação	Modifica os campos sensíveis definidos nas regras de classificação e graduação do Data Security Guard.
QueryRecognizeDataByRuleType	Consulta da lista de métodos de reconhecimento de campos sensíveis.	Consulta a lista de métodos de reconhecimento de campos sensíveis no Data Security Guard chamando a operação QueryRecognizeDataByRuleType.
QueryRecognizeRuleDetail	QueryRecognizeRuleDetail.	Obtém os detalhes de um campo sensível especificado no Data Security Guard.
DsgUserGroupGetOdpsRoleGroups	Lista as funções do MaxCompute disponíveis.	Consulta as funções do MaxCompute disponíveis para seleção como membros de grupo de usuários quando um locatário cria ou modifica um grupo de usuários no Data Security Guard.
DsgDesensPlanAddOrUpdate	Criar ou atualizar uma regra de mascaramento de dados	Cria ou atualiza uma regra de mascaramento de dados.
DsgPlatformQueryProjectsAndSchemaFromMeta	DsgPlatformQueryProjectsAndSchemaFromMeta.	Consulta uma lista de mecanismos de computação de diferentes tipos no tenant atual.
DsgUserGroupDelete	DsgUserGroupDelete.	Exclui um grupo de usuários configurado no Data Security Guard.
DsgWhiteListDeleteList	DsgWhiteListDeleteList.	Exclui uma lista de permissões de mascaramento de dados configurada no Data Security Guard.
DsgScenedDeleteScene	DsgScenedDeleteScene.	Exclui um cenário de mascaramento de dados de nível 2 criado no Data Security Guard.
DsgDesensPlanDelete	DsgDesensPlanDelete	Exclui uma regra de mascaramento de dados criada no Data Security Guard.
DsgDesensPlanUpdateStatus	DsgDesensPlanUpdateStatus.	Modifica o status de uma regra de mascaramento de dados.
DsgWhiteListQueryList	DsgWhiteListQueryList	Consulta as listas de permissões de mascaramento de dados configuradas no Data Security Guard.
DsgSceneAddOrUpdateScene	Criar ou modificar um cenário de mascaramento de nível 2	Cria ou modifica um cenário de mascaramento de nível 2.
DsgSceneQuerySceneListByName	Consulta de cenários de mascaramento	Consulta a lista de cenários de mascaramento.
DsgUserGroupAddOrUpdate	Adicionar ou modificar um grupo de usuários no Data Security Guard	Adiciona ou modifica um grupo de usuários no Data Security Guard.
DsgUserGroupQueryList	Lista de grupos de usuários no Data Security Guard	Consulta a lista de grupos de usuários no Data Security Guard.
DsgUserGroupQueryUserList	DsgUserGroupQueryUserList	Consulta uma lista de usuários ou funções do tenant atual.
DsgDesensPlanQueryList	Lista as regras de mascaramento de dados.	Chama a API DsgDesensPlanQueryList para consultar as regras de mascaramento de dados do Data Security Guard (DSG).
DsgWhiteListAddOrUpdate	Criar ou modificar uma lista de permissões de mascaramento de dados	Cria ou modifica uma lista de permissões de mascaramento de dados.
DsgQueryDefaultTemplates	Consulta os modelos de tipos de dados sensíveis disponíveis e seus detalhes.	Obtém os modelos de tipo de dados sensíveis disponíveis e as regras de dessensibilização que eles suportam. Use a resposta desta API para configurar suas regras de dessensibilização.

Assistente de Migração

API	Título	Descrição
CreateImportMigration	CreateImportMigration	Cria uma tarefa de importação para importar um pacote de importação e exportação do DataWorks que contém objetos como fontes de dados, tarefas e tabelas.
GetMigrationProcess	GetMigrationProcess.	Consulta o progresso de uma tarefa de migração.
StartMigration	StartMigration.	Inicia uma tarefa de migração.
CreateExportMigration	CreateExportMigration.	Cria uma tarefa de exportação no DataWorks. Esta operação de API apenas cria a tarefa de exportação e não a inicia.
GetMigrationSummary	GetMigrationSummary.	Consulta as informações sobre uma tarefa de migração.
ListMigrations	Obter tarefas de migração	Obtém uma lista de tarefas de migração de importação e exportação.

Centro de Segurança

API	Título	Descrição
CreatePermissionApplyOrder	Criar uma ordem de solicitação de permissão.	Cria uma ordem de solicitação de permissão. Nota: A versão de 2020 da OpenAPI será descontinuada. Migre para a versão de 2024 da OpenAPI — ApplyResourceAccessPermission o mais rápido possível.
GetPermissionApplyOrderDetail	Consulta dos detalhes de um ticket de solicitação de permissão	Consulta os detalhes de um ticket de solicitação de permissão. Nota: A versão de 2020 da OpenAPI será descontinuada em uma data posterior. Migre para a versão de 2024 da OpenAPI (GetApplicationContents ou GetProcessInstance) o mais rápido possível.
ListPermissionApplyOrders	Consulta da lista de ordens de solicitação de permissão.	Consulta uma lista de ordens de solicitação de permissão. Nota: A versão de 2020 da OpenAPI será descontinuada em um momento agendado. Migre para a versão de 2024 da OpenAPI o mais rápido possível — ListMyApplications/ListPendingApprovals/ListMyRelatedApprovals.
ApprovePermissionApplyOrder	Aprova um ticket de solicitação de permissão	Aprova um ticket de solicitação de permissão. Nota: a OpenAPI de 2020 será desativada em breve. Migre para a OpenAPI ApproveProcessInstance de 2024 o mais rápido possível.
RevokeTablePermission	Revogar permissões de tabela de um usuário.	Revoga as permissões de tabela de um usuário.

Plataforma Aberta

API	Título	Descrição
ListExtensions	Obter lista de extensões.	Obtém a lista de extensões da plataforma aberta.
GetExtension	GetExtension.	Obtém os detalhes de uma extensão.
GetOptionValueForProject	GetOptionValueForProject.	Consulta as configurações de opções de uma extensão em um espaço de trabalho.
ListEnabledExtensionsForProject	ListEnabledExtensionsForProject.	Consulta uma lista de extensões integradas e personalizadas habilitadas em um workspace.
CallbackExtension	Retorna o resultado da verificação de uma extensão para um evento de ponto de extensão	Retorna o resultado da verificação de uma extensão para um evento de ponto de extensão para a plataforma DataWorks quando o ponto de extensão é acionado.
ListCheckProcesses	Query the check list of extension events	Consulta a lista de verificação de eventos de extensão.

Outros

API	Título	Descrição
UpdateTableAddColumn	Atualizar informações das colunas de uma tabela	Atualiza as informações das colunas de uma tabela do MaxCompute.
GetMetaTableFullInfo	Obter informações completas da tabela, incluindo informações de colunas.	Obtém as informações completas sobre uma tabela, incluindo informações de colunas.
GetDDLJobStatus	Obtém o status da tarefa DDL.	Obtém o status das tarefas de criação, atualização e exclusão de tabelas.
DeleteTable	Excluir uma tabela do MaxCompute	Exclui uma tabela do MaxCompute.
UpdateTable	UpdateTable	Atualiza uma tabela do MaxCompute.
CreateTable	CreateTable.	Cria uma tabela do MaxCompute.
CheckFileDeployment	Verificação da implantação de arquivo	Envia o resultado da verificação de publicação de um arquivo para o DataWorks. Depois que um arquivo criado na página Data Studio do DataWorks é enviado com sucesso, o arquivo entra no estado de verificação de publicação e o DataWorks retorna um evento de verificação de publicação. Você pode determinar se o arquivo pode prosseguir com a verificação de publicação com base no conteúdo do evento e enviar o resultado da verificação do arquivo a ser publicado para o DataWorks.
ListRefDISyncTasks	ListRefDISyncTasks.	Consulta as tarefas de sincronização no Data Integration que usam uma fonte de dados específica.
ExportDataSources	ExportDataSources.	Exporta uma lista de fontes de dados.
ImportDataSources	ImportDataSources.	Importa fontes de dados da sua máquina local para um espaço de trabalho específico do DataWorks.
UpdateClusterConfigs	UpdateClusterConfigs	Atualiza as configurações de submódulos de um cluster em um espaço de trabalho. Atualmente, apenas os parâmetros do Spark são suportados.
ListClusterConfigs	ListClusterConfigs.	Lista as configurações de um cluster por módulo em um workspace específico. Atualmente, há suporte para parâmetros SPARK.
ListClusters	ListClusters.	Consulta os clusters registrados no DataWorks. Há suporte para clusters E-MapReduce (EMR) e clusters Cloudera's Distribution Including Apache Hadoop (CDH).

APIs Obsoletas

API	Título	Descrição
ListEntitiesByTags	Listar entidades por tag.	Lista entidades por tag. Atualmente, apenas entidades do tipo maxcompute-table são suportadas.
RemoveEntityTags	Remover tags de uma entidade.	Remove tags de uma entidade. Atualmente, apenas entidades do tipo maxcompute-table são suportadas.
SetEntityTags	Definir tags para uma entidade	Define as tags para uma entidade. Atualmente, apenas entidades do tipo maxcompute-table são suportadas.
ListEntityTags	Lista de tags da entidade	Lista as tags de uma entidade. Atualmente, apenas entidades do tipo maxcompute-table são suportadas.
SetDataSourceShare	SetDataSourceShare.	Compartilha uma fonte de dados com um espaço de trabalho específico do DataWorks ou com um usuário específico.
CreateConnection	CreateConnection.	Adiciona uma fonte de dados.
CreateDagComplement	Criar um fluxo de trabalho de backfill de dados.	Cria um fluxo de trabalho de backfill de dados chamando CreateDagComplement.
CreateDagTest	Criar um fluxo de trabalho de teste de fumaça.	Cria um fluxo de trabalho de teste de fumaça chamando CreateDagTest.
CreateManualDag	Acionamento da execução do processo de negócios manual.	Aciona a execução de um processo de negócios manual. O processo de negócios manual deve ter sido enviado e publicado no console, e o Operation Center deve conseguir localizar o processo de negócios manual correspondente antes que você possa chamar esta operação.
DeleteConnection	DeleteConnection.	Remove uma fonte de dados.
UpdateConnection	UpdateConnection.	Atualiza uma fonte de dados.
ListConnections	ListConnections.	Consulta uma lista de fontes de dados.
GetProjectDetail	Consulta de informações do workspace.	Consulta as informações sobre um workspace do DataWorks.
ListNodeIO	Consulta de informações de nós upstream e downstream	Consulta as informações sobre nós upstream e downstream. Apenas um nível de nós pode ser consultado.
GetInstanceStatusCount	Contagens de status de instâncias	Obtém o número de instâncias em diferentes status.
ListProgramTypeCount	Distribuição dos tipos de tarefa de nó	Obtém a distribuição dos tipos de tarefa de nó.
GetManualDagInstances	Consulta informações sobre instâncias de um fluxo de trabalho manual.	Consulta informações sobre instâncias de um fluxo de trabalho manual.
SearchNodesByOutput	Consultar nós por saída.	Consulta nós por correspondência exata com base na saída.
GetNodeTypeListInfo	GetNodeTypeListInfo.	Consulta as informações sobre tipos de nó, incluindo o código e o nome de um tipo de nó.
GetNodeOnBaseline	Consulta dos nós em uma linha de base.	Chama a operação GetNodeOnBaseline para consultar os nós em uma linha de base.
GetSuccessInstanceTrend	Obter tendências estatísticas horárias das instâncias para o dia atual.	Obtém as tendências estatísticas horárias das instâncias para o dia atual.
GetInstanceCountTrend	GetInstanceCountTrend.	Consulta a tendência da quantidade de instâncias acionadas automaticamente.
GetInstanceConsumeTimeRank	Consulta a classificação de instâncias por duração de execução.	Consulta a classificação de instâncias por duração de execução.
GetInstanceErrorRank	Obtém o ranking de erros dos nós no último mês.	Chama GetInstanceErrorRank para obter o ranking de erros dos nós no último mês.