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.
Tenant
|
API |
Título |
Descrição |
| CreateDataSource | CreateDataSource. | Adiciona uma fonte de dados ao DataWorks. |
| ListDataSources | ListDataSources. | Consulta as fontes de dados adicionadas a um workspace do DataWorks. |
| UpdateDataSource | UpdateDataSource. | Atualiza uma fonte de dados. |
| DeleteDataSource | DeleteDataSource. | Remove uma fonte de dados. |
| ListResourceGroups | ListResourceGroups. | Consulta uma lista de grupos de recursos de um tipo específico. |
| GetProject | GetProject | Consulta as informações sobre um workspace do DataWorks. |
| AddProjectMemberToRole | AddProjectMemberToRole. | Atribui uma função a um membro de um workspace do DataWorks. Antes de chamar esta operação, você deve adicionar sua conta a um workspace do DataWorks como membro. |
| CreateProjectMember | CreateProjectMember. | Adiciona um usuário a um workspace do DataWorks. |
| DeleteProjectMember | DeleteProjectMember. | Remove um usuário de um workspace do DataWorks. |
| ListProjectRoles | ListProjectRoles. | Consulta uma lista de funções em um workspace do DataWorks. |
| RemoveProjectMemberFromRole | RemoveProjectMemberFromRole. | Remove uma função de um usuário em um workspace do DataWorks. |
| ListProjectMembers | ListProjectMembers. | Consulta uma lista de membros existentes em um workspace do DataWorks. |
| ListProjects | ListProjects | Consulta uma lista de workspaces do DataWorks do tenant ao qual um usuário pertence. |
| ListProjectIds | ListProjectIds. | 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 | CreateProject | Cria um workspace do DataWorks. |
| ChangeResourceManagerResourceGroup | ChangeResourceManagerResourceGroup. | Altera o grupo de recursos de um recurso. |
| ListMeasureData | ListMeasureData. | Consulta as estatísticas sobre o número de alertas baseados em chamadas telefônicas ou alertas baseados em mensagens de texto reportados dentro do tenant ao qual sua conta pertence durante os ú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 | GetMetaDBInfo. | Consulta as informações básicas de metadados de uma instância de mecanismo de computação. |
| GetMetaDBTableList | GetMetaDBTableList. | Obtém todas as tabelas na instância de engine especificada. |
| CheckMetaTable | CheckMetaTable. | Verifica se uma metatabela 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 de campo de uma metatabela. |
| GetMetaTablePartition | GetMetaTablePartition. | Obtém uma lista de partições de uma tabela. |
| GetMetaTableOutput | GetMetaTableOutput. | Consulta as informações de saída de uma metatabela. |
| GetMetaTableChangeLog | GetMetaTableChangeLog. | Consulta os logs de alterações de uma metatabela. |
| GetMetaTableIntroWiki | GetMetaTableIntroWiki. | Consulta as instruções de uso de uma tabela. |
| CreateMetaCategory | CreateMetaCategory. | Cria uma categoria. |
| DeleteMetaCategory | DeleteMetaCategory. | Exclui uma categoria. |
| UpdateMetaCategory | UpdateMetaCategory. | Atualiza uma categoria. |
| GetMetaCategory | GetMetaCategory. | Consulta as informações sobre uma árvore de categorias. |
| GetMetaTableListByCategory | GetMetaTableListByCategory. | Consulta metatables 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 | UpdateMetaTableIntroWiki. | Atualiza as instruções sobre como usar uma tabela. Se não houver instruções sobre como usar a tabela disponíveis, as instruções configuradas ao chamar esta operação serão adicionadas. |
| ListMetaDB | ListMetaDB | Consulta uma lista de metabancos de dados. |
| UpdateTableModelInfo | UpdateTableModelInfo. | Modifica as informações sobre uma tabela, como a pasta da tabela, o nível e a categoria. |
| 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 temas de tabela. Esta operação será substituída em breve. Recomendamos que você não chame esta operação. |
| GetMetaTableThemeLevel | GetMetaTableThemeLevel. | Obtém temas e metadados de hierarquia para tabelas. |
| CreateTableLevel | CreateTableLevel. | Cria um nível de hierarquia. Esta operação será substituída em breve. Recomendamos que você não invoque 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 | UpdateMetaCollection. | Atualiza o nome e o comentário de uma coleção. |
| ListMetaCollections | ListMetaCollections. | Obtém uma lista de coleções. As coleções incluem álbuns de dados exibidos na página Mapa de Dados e categorias criadas em álbuns de dados. Você pode filtrar as coleções por tipo. |
| DeleteMetaCollection | DeleteMetaCollection. | Exclui uma coleção. |
| GetMetaCollectionDetail | GetMetaCollectionDetail. | Consulta as informações de uma coleção. |
| RegisterLineageRelation | RegisterLineageRelation. | Registra a linhagem entre entidades autogerenciadas no DataWorks. |
Desenvolvimento de dados
|
API |
Título |
Descrição |
| CreateFile | CreateFile. | Cria um arquivo no DataStudio. Você não pode chamar esta operação para criar arquivos para nós do Data Integration. |
| CreateUdfFile | CreateUdfFile. | Cria um arquivo para uma função no DataStudio. |
| CreateBusiness | CreateBusiness. | Cria um fluxo de trabalho no DataStudio. |
| DeleteBusiness | DeleteBusiness. | Exclui um fluxo de trabalho. |
| CreateFolder | CreateFolder. | A operação que você deseja executar. Defina o valor como **CreateFolder**. |
| UpdateBusiness | UpdateBusiness. | Atualiza um fluxo de trabalho. |
| EstablishRelationTableToBusiness | EstablishRelationTableToBusiness. | Importa uma tabela para um workflow. A chamada a esta operação de API é equivalente a realizar as seguintes operações: Acesse a página DataStudio, localize o workflow desejado e clique no nome do workflow. Clique com o botão direito em Table na pasta desejada e selecione Import Table. |
| SubmitFile | SubmitFile. | Submete um arquivo ao ambiente de desenvolvimento para criar uma tarefa correspondente. |
| ListBusiness | ListBusiness. | Consulta uma lista de fluxos de trabalho. |
| GetFileVersion | GetFileVersion. | Consulta as informações sobre uma versão de arquivo. |
| DeleteFolder | DeleteFolder. | Exclui uma pasta da página Desenvolvimento de Dados. |
| DeleteFile | DeleteFile. | Exclui um arquivo do DataStudio. 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. |
| GetDeployment | GetDeployment. | Consulta as informações sobre um pacote de implantação. |
| GetFolder | GetFolder. | Obtém os detalhes de uma pasta. |
| ListFileVersions | ListFileVersions. | Consulta uma lista de versões de arquivo. |
| ListFolders | ListFolders. | Chama a operação ListFolders para consultar pastas. |
| DeployFile | DeployFile. | Implanta um arquivo no ambiente de produção. |
| UpdateUdfFile | UpdateUdfFile. | Atualiza as informações de arquivo de uma função. |
| GetBusiness | GetBusiness. | Consulta as informações de um fluxo de trabalho. |
| 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. |
| CreateResourceFile | CreateResourceFile. | Cria ou faz upload de um arquivo de recurso no DataStudio. A funcionalidade implementada ao chamar esta operação é a mesma funcionalidade de criação de recursos fornecida no ambiente de desenvolvimento integrado (IDE). |
Integração de dados
|
API |
Título |
Descrição |
| CreateDISyncTask | CreateDISyncTask. | Cria uma tarefa de sincronização de dados. |
| DeleteDISyncTask | DeleteDISyncTask. | Exclui uma tarefa de sincronização em tempo real. |
| UpdateDISyncTask | UpdateDISyncTask. | Atualiza uma tarefa de sincronização de dados. |
| TestNetworkConnection | TestNetworkConnection. | Testa a conectividade de rede entre uma origem de dados e um grupo de recursos. |
| GetDISyncTask | GetDISyncTask. | Obtém os detalhes de uma tarefa de sincronização ou de uma solução de sincronização de dados. |
| DeployDISyncTask | DeployDISyncTask. | Implanta uma tarefa de sincronização em tempo real. |
| GetDISyncInstanceInfo | GetDISyncInstanceInfo. | Consulta o status de uma tarefa de sincronização em tempo real ou de uma solução de sincronização de dados. |
| GenerateDISyncTaskConfigForUpdating | GenerateDISyncTaskConfigForUpdating. | Gera a configuração para atualizar uma tarefa de sincronização em tempo real no Data Integration. |
| QueryDISyncTaskConfigProcessResult | QueryDISyncTaskConfigProcessResult. | Consulta o resultado de uma tarefa assíncrona para geração de configurações de tarefas de sincronização. |
| CreateDIJob | Criar uma tarefa de sincronização. | Cria uma tarefa de sincronização de nova versão. 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 Hologres e sincronização em lote de todos os dados em um banco de dados MySQL para Hive. |
| 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. | Obtém uma lista de tarefas de sincronização. |
| UpdateDIJob | UpdateDIJob. | Atualiza uma tarefa de sincronização de nova versão. O seguinte tipo de tarefa é suportado: 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 de sincronização. |
| GetDIAlarmRule | GetDIAlarmRule. | Obtém os detalhes de uma regra de alerta configurada para uma tarefa de sincronização. |
| ListDIAlarmRules | ListDIAlarmRules. | Obtém uma lista de regras de alerta configuradas para uma tarefa de sincronização. |
| UpdateDIAlarmRule | UpdateDIAlarmRule. | Atualiza uma regra de alerta para uma tarefa de sincronização. |
Modelagem de dados
|
API |
Título |
Descrição |
| QueryPublicModelEngine | QueryPublicModelEngine. | Obtém informações sobre objetos de Modelagem de Dados criados usando instruções da linguagem de modelagem rápida (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 | GetBaselineConfig. | Consulta as configurações de uma linha de base. |
| ListNodesByBaseline | ListNodesByBaseline. | Consulta os nós em uma linha de base. |
| ListBaselineConfigs | ListBaselineConfigs. | Consulta uma lista de baselines. |
| GetBaselineKeyPath | GetBaselineKeyPath. | As informações sobre os eventos associados à instância. |
| GetBaselineStatus | GetBaselineStatus. | Obtém o status de uma instância de linha de base. |
| ListBaselineStatuses | ListBaselineStatuses. | Consulta uma lista de instâncias de linha de base. |
| DeleteRemind | DeleteRemind. | Exclui uma regra de alerta de monitoramento personalizado. |
| CreateRemind | CreateRemind. | Cria uma regra de alerta personalizada. |
| GetRemind | GetRemind. | Consulta as informações sobre uma regra de alerta personalizada. |
| ListReminds | ListReminds. | Consulta uma lista de regras de alerta personalizadas. |
| ListTopics | ListTopics. | Consulta eventos. |
| GetTopic | GetTopic. | Consulta as informações sobre um evento. |
| GetTopicInfluence | GetTopicInfluence. | Consulta as instâncias de linha de base afetadas por um evento. |
| GetNode | GetNode. | Consulta os detalhes de um nó. |
| ListNodeInputOrOutput | ListNodeInputOrOutput. | Consulta as informações de entrada e saída de um nó. Apenas os nós ancestrais ou descendentes no nível mais próximo podem ser consultados por vez. |
| ListNodes | ListNodes. | O ID do espaço de trabalho. |
| RestartInstance | RestartInstance. | Reinicia uma instância. |
| SuspendInstance | SuspendInstance. | Suspende uma instância. |
| TopTenElapsedTimeInstance | TopTenElapsedTimeInstance. | Consulta a classificação das durações de execução das instâncias. |
| TopTenErrorTimesInstance | TopTenErrorTimesInstance. | Consulta a classificação dos nós nos quais ocorreram erros no mês anterior. |
| GetInstanceStatusStatistic | Consulta de estatísticas de status de instâncias. | Consulta o número de instâncias que estão em cada estado. |
| RunManualDagNodes | RunManualDagNodes. | Executa nós em um workflow de acionamento manual. Antes de chamar esta operação, certifique-se de que o workflow de acionamento manual esteja confirmado e implantado. Você pode encontrar um workflow de acionamento manual no Operation Center somente após o workflow de acionamento manual ser confirmado e implantado. |
| GetDag | GetDag. | Consulta as informações sobre um grafo acíclico dirigido (DAG). Você pode chamar a operação GetDag para consultar as informações sobre o DAG de um fluxo de trabalho acionado manualmente, um nó acionado manualmente ou uma instância de backfill de dados. No entanto, você não pode consultar as informações sobre o DAG de um nó acionado automaticamente ou um fluxo de trabalho acionado automaticamente. |
| ListDags | ListDags. | Obtém uma lista de grafos acíclicos dirigidos (DAGs) para uma instância de backfill de dados pelo número de sequência da operação (OpSeq). |
| ListNodesByOutput | ListNodesByOutput. | Consulta nós com base na saída dos nós. |
| GetNodeParents | GetNodeParents. | Consulta uma lista de nós ancestrais de um nó. |
| GetNodeChildren | GetNodeChildren. | Consulta uma lista de instâncias. |
| UpdateWorkbenchEventResult | UpdateWorkbenchEventResult. | Retorna o resultado do processamento enviado por uma extensão após um processo no Operation Center ser bloqueado pela extensão. |
| ListShiftPersonnels | ListShiftPersonnels. | Consulta uma lista de engenheiros de plantão em uma escala de turnos. |
| ListShiftSchedules | ListShiftSchedules. | Consulta uma lista de escalas de plantão no Centro de Operações. |
| ListInstanceHistory | ListInstanceHistory. | Obtém o histórico de execução de uma instância. Cada reexecução gera um novo registro histórico. |
| 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. |
| GetBaseline | GetBaseline. | Consulta as informações sobre uma baseline com base no seu ID. |
| ListBaselines | ListBaselines. | Obtém uma lista de baselines. |
| CreateBaseline | CreateBaseline. | Cria uma baseline. |
| UpdateBaseline | UpdateBaseline. | Atualiza uma baseline. |
Qualidade de dados
|
API |
Título |
Descrição |
| UpdateQualityFollower | UpdateQualityFollower. | Atualiza uma assinatura. |
| UpdateQualityRule | UpdateQualityRule. | Atualiza uma regra de qualidade especificada. |
| GetQualityRule | GetQualityRule. | Obtém informações sobre uma regra de qualidade. |
| ListQualityRules | ListQualityRules. | Obtém as regras de qualidade que correspondem a uma expressão de partição. |
| CreateQualityRule | CreateQualityRule. | Chama CreateQualityRule para criar uma regra de qualidade. |
| DeleteQualityFollower | DeleteQualityFollower. | Exclui um seguidor de uma expressão de partição. |
| DeleteQualityRule | DeleteQualityRule. | Exclui uma regra de qualidade de dados. |
| GetQualityFollower | GetQualityFollower. | Obtém os seguidores de uma expressão de partição. |
| CreateQualityFollower | CreateQualityFollower. | Adiciona um seguidor a uma expressão de partição para receber alertas de qualidade de dados. |
| DeleteQualityEntity | DeleteQualityEntity. | Exclui uma expressão de partição. |
| GetQualityEntity | GetQualityEntity. | Chama GetQualityEntity para obter a 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 | CreateDataServiceApi. | Cria uma API. |
| GetDataServiceApi | GetDataServiceApi. | Obtém os detalhes de uma API do DataService Studio no estado de desenvolvimento. |
| UpdateDataServiceApi | UpdateDataServiceApi. | Atualiza as informações sobre uma API no estado de desenvolvimento no DataService Studio. |
| GetDataServicePublishedApi | GetDataServicePublishedApi. | Obtém os detalhes de uma API publicada do DataService Studio. |
| ListDataServicePublishedApis | ListDataServicePublishedApis. | Obtém uma lista de APIs publicadas. |
| ListDataServiceApiAuthorities | ListDataServiceApiAuthorities. | Obtém uma lista de APIs para as quais outros usuários receberam permissões de acesso. |
| ListDataServiceAuthorizedApis | ListDataServiceAuthorizedApis. | Obtém uma lista de APIs que você está autorizado a acessar. |
| GetDataServiceApplication | GetDataServiceApplication. | Obtém os detalhes de uma aplicação. |
| ListDataServiceApplications | ListDataServiceApplications. | Obtém uma lista de aplicativos. |
| ListDataServiceFolders | ListDataServiceFolders. | Obtém uma lista de pastas. |
| CreateDataServiceGroup | CreateDataServiceGroup. | Cria um processo de negócios. |
| GetDataServiceGroup | GetDataServiceGroup. | Obtém os detalhes de um processo de negócios. |
| ListDataServiceGroups | ListDataServiceGroups. | Obtém uma lista de processos de negócios. |
Proteção de dados
|
API |
Título |
Descrição |
| 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. |
| GetSensitiveData | GetSensitiveData. | Consulta os dados confidenciais mais recentes em todos os workspaces do DataWorks de um locatário. |
| DsgQuerySensResult | DsgQuerySensResult. | Obtém os resultados de identificação de dados sensíveis do Data Security Guard. |
| QueryRecognizeRuleDetail | QueryRecognizeRuleDetail. | Obtém os detalhes de um campo sensível especificado no Data Security Guard. |
| DsgDesensPlanAddOrUpdate | DsgDesensPlanAddOrUpdate. | Chama a API DsgDesensPlanAddOrUpdate para criar ou editar uma regra de desensibilização de dados. |
| DsgSceneQuerySceneListByName | DsgSceneQuerySceneListByName. | Chama a API DsgSceneQuerySceneListByName para obter uma lista de cenários de mascaramento de dados. |
| DsgUserGroupAddOrUpdate | DsgUserGroupAddOrUpdate. | Cria ou atualiza um grupo de usuários no Data Security Guard. |
| DsgUserGroupQueryList | DsgUserGroupQueryList. | Chama DsgUserGroupQueryList para consultar grupos de usuários no Data Security Guard (DSG). |
| DsgDesensPlanQueryList | DsgDesensPlanQueryList. | Chama a API DsgDesensPlanQueryList para consultar as regras de mascaramento de dados do Data Security Guard (DSG). |
| DsgQueryDefaultTemplates | DsgQueryDefaultTemplates. | Obtém os modelos de tipo de dados sensíveis disponíveis e as regras de desensibilização compatíveis. Use a resposta desta API para configurar suas regras de desensibilização. |
Assistente de migração
|
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 edição de 2020 do OpenAPI será descontinuada em breve. Migre para a edição de 2024 do OpenAPI o mais rápido possível — ApplyResourceAccessPermission. |
| GetPermissionApplyOrderDetail | Query the details of a permission request order | Queries the details of a permission request order. Note: The 2020 version of OpenAPI will be discontinued. Please migrate to the 2024 version of OpenAPI as soon as possible — GetApplicationContents/GetProcessInstance. |
| ListPermissionApplyOrders | Query the list of permission application orders | Queries a list of permission application orders. Note: The 2020 version of OpenAPI will be discontinued at a scheduled time. Please migrate to the 2024 version of OpenAPI as soon as possible — ListMyApplications/ListPendingApprovals/ListMyRelatedApprovals. |
Centro de segurança
|
API |
Título |
Descrição |
| GetExtension | GetExtension. | Obtém os detalhes de uma extensão. |
Plataforma aberta
|
API |
Título |
Descrição |
| GetMetaTableFullInfo | GetMetaTableFullInfo | Obtém metadados completos de uma tabela, incluindo detalhes dos campos. |
| DeleteTable | DeleteTable. | Exclui uma tabela do MaxCompute. |
| UpdateTable | UpdateTable. | Atualiza uma tabela MaxCompute. |
| CreateTable | CreateTable. | Cria uma tabela MaxCompute. |
| CheckFileDeployment | CheckFileDeployment. | Retorna os eventos de verificação de um arquivo com implantação pendente no DataStudio. Após um arquivo ser submetido, o DataWorks verifica o arquivo e gera eventos antes da implantação. Use os eventos retornados para determinar se o arquivo pode prosseguir com a validação de implantação. |
| UpdateClusterConfigs | UpdateClusterConfigs. | Atualiza as configurações dos submódulos de um cluster em um espaço de trabalho. Atualmente, apenas os parâmetros do Spark são suportados. |
Outros
|
API |
Título |
Descrição |
| CreateDagComplement | CreateDagComplement. | Cria um workflow de backfill de dados. |
| CreateDagTest | Criar um fluxo de trabalho de teste de fumaça | Cria um fluxo de trabalho de teste de fumaça ao chamar CreateDagTest. |
| CreateManualDag | Acionar a execução de um fluxo de trabalho manual. | O fluxo de trabalho manual já deve ter sido enviado e implantado na interface, e o Centro de Operações deve ser capaz de encontrar o fluxo de trabalho manual correspondente. Somente então esta API pode ser utilizada. |
| 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. |
| 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. |
APIs obsoletas
|
API |
Título |
Descrição |
| AbolishDataServiceApi | AbolishDataServiceApi. | Despublica uma API do DataService Studio. |
| AddMetaCollectionEntity | AddMetaCollectionEntity. | Adiciona uma entidade a uma coleção. |
| AddRecognizeRule | AddRecognizeRule. | Adiciona um campo sensível definido com base na categoria e no nível de sensibilidade dos dados no Data Security Guard. |
| ApprovePermissionApplyOrder | Approve a permission request order | Approves a permission request order. Note: The 2020 edition of OpenAPI will be discontinued. Migrate to the 2024 edition OpenAPI ApproveProcessInstance as soon as possible. |
| CallbackExtension | CallbackExtension. | Envia o resultado do processamento de um evento de ponto de extensão por uma extensão ao DataWorks. |
| CreateConnection | CreateConnection. | Adiciona uma origem de dados. |
| CreateDataServiceApiAuthority | CreateDataServiceApiAuthority. | Concede as permissões de acesso a uma API no DataService Studio. |
| CreateDataServiceFolder | CreateDataServiceFolder. | Cria uma pasta no DataService Studio. |
| CreateExportMigration | CreateExportMigration. | Cria uma tarefa de exportação. Você pode usar esta operação para criar uma tarefa de exportação, mas não pode usá-la para iniciar a tarefa criada. |
| CreateImportMigration | CreateImportMigration. | Cria uma tarefa de importação. A tarefa de importação contém os pacotes de importação de fontes de dados, nós e tabelas. |
| CreateMetaCollection | CreateMetaCollection. | Cria uma coleção. |
| DeleteBaseline | DeleteBaseline. | Exclui uma linha de base com base em seu ID. Você só pode excluir uma linha de base se os nós na linha de base não tiverem nós ancestrais. Você pode chamar a operação UpdateBaseline para excluir as relações entre os nós e seus nós ancestrais. |
| DeleteConnection | DeleteConnection. | Remove uma fonte de dados. |
| DeleteDIAlarmRule | DeleteDIAlarmRule. | Exclui uma regra de alerta para uma tarefa da nova versão do Data Integration. Somente o seguinte tipo de tarefa é suportado: sincronização de dados em tempo real de um banco de dados MySQL para o Hologres. |
| DeleteDIJob | DeleteDIJob. | Exclui uma tarefa de nova versão do Data Integration. Somente o seguinte tipo de tarefa é compatível: sincronização de dados em tempo real de um banco de dados MySQL para o Hologres. |
| DeleteDataServiceApi | Exclusão de uma API do DataService Studio. | Exclui uma API no DataService Studio. |
| DeleteDataServiceApiAuthority | DeleteDataServiceApiAuthority. | Revoga as permissões de acesso em uma API. |
| DeleteLineageRelation | DeleteLineageRelation. | Exclui linhagens e oferece suporte à exclusão de relações de linhagem definidas pelo usuário. |
| DeleteMetaCollectionEntity | DeleteMetaCollectionEntity. | Exclui uma entidade de uma coleção. |
| DeleteRecognizeRule | DeleteRecognizeRule. | Exclui tipos de campos sensíveis. |
| DesensitizeData | DesensitizeData. | Mascara dados. |
| 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. |
| DsgPlatformQueryProjectsAndSchemaFromMeta | DsgPlatformQueryProjectsAndSchemaFromMeta. | Consulta uma lista de mecanismos de computação de diferentes tipos no tenant atual. |
| DsgRunSensIdentify | DsgRunSensIdentify. | Inicia uma tarefa de identificação de dados sensíveis no Data Security Guard. |
| DsgSceneAddOrUpdateScene | DsgSceneAddOrUpdateScene. | Adiciona ou modifica um cenário de mascaramento de dados de nível 2. |
| DsgScenedDeleteScene | DsgScenedDeleteScene. | Exclui um cenário de mascaramento de dados de nível 2 criado no Data Security Guard. |
| DsgStopSensIdentify | DsgStopSensIdentify. | Interrompe uma tarefa de identificação de dados sensíveis. |
| DsgUserGroupDelete | DsgUserGroupDelete. | Exclui um grupo de usuários configurado no Data Security Guard. |
| DsgUserGroupGetOdpsRoleGroups | DsgUserGroupGetOdpsRoleGroups. | Consulta uma lista de funções do MaxCompute que podem ser selecionadas pelos membros de um grupo de usuários quando o grupo de usuários é criado ou modificado pelo tenant no Data Security Guard. |
| DsgUserGroupQueryUserList | DsgUserGroupQueryUserList. | Consulta uma lista de usuários ou funções do tenant atual. |
| DsgWhiteListAddOrUpdate | Adicionar ou atualizar uma lista de permissões de mascaramento de dados. | Adiciona ou modifica uma lista de permissões de mascaramento de dados. |
| DsgWhiteListDeleteList | DsgWhiteListDeleteList. | Exclui uma lista de permissões de mascaramento de dados configurada no Data Security Guard. |
| DsgWhiteListQueryList | DsgWhiteListQueryList. | Consulta uma whitelist de mascaramento de dados. |
| EditRecognizeRule | EditRecognizeRule. | Edita um campo sensível definido com base na categoria e no nível de sensibilidade dos dados no Data Security Guard. |
| ExportDataSources | ExportDataSources. | Exporta uma lista de fontes de dados. |
| GenerateDISyncTaskConfigForCreating | GenerateDISyncTaskConfigForCreating. | Gera um ID para uma thread assíncrona que é usada para criar uma tarefa de sincronização no Data Integration. |
| GetDDLJobStatus | GetDDLJobStatus. | Consulta o status de uma tarefa de criação, atualização ou exclusão de tabela. |
| GetDataServiceApiTest | GetDataServiceApiTest. | Consulta os resultados de teste de uma API no DataService Studio. |
| GetDataServiceFolder | GetDataServiceFolder. | Consulta uma pasta. |
| GetDataSourceMeta | GetDataSourceMeta. | Consulta os metadados de uma origem de dados especificada. |
| GetFile | GetFile. | Consulta as informações sobre um arquivo. |
| GetFileTypeStatistic | GetFileTypeStatistic. | Consulta a distribuição dos tipos de nós. |
| GetInstance | GetInstance. | Consulta as informações sobre uma instância. |
| GetInstanceCountTrend | GetInstanceCountTrend. | Consulta a tendência da quantidade de instâncias acionadas automaticamente. |
| GetInstanceLog | GetInstanceLog. | Consulta os logs de uma instância. |
| GetInstanceStatusCount | GetInstanceStatusCount. | Consulta as estatísticas de instâncias em diferentes estados. |
| GetManualDagInstances | GetManualDagInstances. | Consulta as informações sobre instâncias em um workflow acionado manualmente. |
| GetMetaColumnLineage | GetMetaColumnLineage. | Consulta a linhagem de um campo em uma metatabela. |
| GetMetaTableLineage | GetMetaTableLineage. | Consulta a linhagem de uma metatabela. |
| GetMigrationProcess | GetMigrationProcess. | Consulta o progresso de uma tarefa de migração. |
| GetMigrationSummary | GetMigrationSummary. | Consulta as informações sobre uma tarefa de migração. |
| GetNodeCode | GetNodeCode. | Consulta o código de um nó. |
| GetNodeTypeListInfo | GetNodeTypeListInfo. | Consulta as informações sobre os tipos de nó, incluindo o código e o nome de um tipo de nó. |
| GetOpRiskData | GetOpRiskData. | Consulta os registros gerados em uma data especificada para acesso aos dados confidenciais de alto risco em todos os workspaces do DataWorks de um locatário. |
| GetOpSensitiveData | GetOpSensitiveData. | Consulta os registros gerados em uma data especificada para acesso a dados sensíveis em todos os workspaces do DataWorks de um locatário. |
| GetOptionValueForProject | GetOptionValueForProject. | Consulta as configurações de opções de uma extensão em um espaço de trabalho. |
| GetProjectDetail | GetProjectDetail. | Consulta as informações de um workspace do DataWorks. |
| GetSuccessInstanceTrend | GetSuccessInstanceTrend. | Consulta as estatísticas de instâncias em diferentes períodos do dia. |
| ImportDataSources | ImportDataSources. | Importa fontes de dados da sua máquina local para um espaço de trabalho específico do DataWorks. |
| ListCalcEngines | ListCalcEngines | Queries a list of compute engines that are associated with a DataWorks workspace. |
| ListCheckProcesses | ListCheckProcesses. | Consulta os resultados de verificação de eventos de ponto de extensão. |
| ListClusterConfigs | ListClusterConfigs. | Consulta as configurações de submódulos em um workspace. Você pode consultar informações sobre parâmetros SPARK. |
| ListClusters | ListClusters. | Consulta os clusters registrados no DataWorks. Há suporte para clusters E-MapReduce (EMR) e Cloudera's Distribution Including Apache Hadoop (CDH). |
| ListConnections | ListConnections. | Consulta uma lista de fontes de dados. |
| ListDIProjectConfig | ListDIProjectConfig. | Consulta as configurações globais padrão das soluções de sincronização em um workspace do DataWorks especificado. |
| ListDataServiceApiTest | ListDataServiceApiTest. | Consulta os registros de teste de uma API do DataService Studio. Esta operação de API permite consultar apenas os registros de teste gerados no mês anterior. |
| ListDataServiceApis | ListDataServiceApis. | Consulta uma lista de APIs no estado de desenvolvimento. |
| ListDeployments | ListDeployments. | Consulta uma lista de pacotes de implantação. Esta operação é equivalente a visualizar uma lista de pacotes de implantação na página Deployment Packages do console do DataWorks. |
| ListEnabledExtensionsForProject | ListEnabledExtensionsForProject. | Consulta uma lista de extensões integradas e personalizadas ativadas em um workspace. |
| ListEntitiesByTags | ListEntitiesByTags. | Consulta uma lista de entidades por tag. Apenas entidades do tipo maxcompute-table são suportadas. |
| ListEntityTags | ListEntityTags. | Consulta uma lista de tags de uma entidade. Apenas entidades do tipo maxcompute-table são suportadas. |
| ListExtensions | ListExtensions. | Consulta uma lista de extensões. |
| ListFileType | ListFileType. | Consulta as informações sobre tipos de nó, como o código e o nome. |
| ListFiles | ListFiles. | Consulta uma lista de arquivos. |
| ListInstanceAmount | ListInstanceAmount. | Consulta a tendência do número de instâncias de nó acionadas automaticamente em um período de tempo especificado. |
| ListInstances | ListInstances. | Consulta uma lista de instâncias. |
| ListLineage | ListLineage. | Consulta a linhagem ascendente ou descendente de uma entidade. |
| ListManualDagInstances | ListManualDagInstances. | Consulta as informações sobre as instâncias em um fluxo de trabalho acionado manualmente. |
| ListMetaCollectionEntities | ListMetaCollectionEntities. | Consulta as entidades em uma coleção. |
| ListMigrations | ListMigrations. | Consulta uma lista de tarefas de migração. |
| ListNodeIO | ListNodeIO. | Consulta as informações sobre um nível de nós ancestrais ou descendentes de um nó. |
| ListProgramTypeCount | ListProgramTypeCount. | Consulta a distribuição de diferentes tipos de nós. |
| ListRefDISyncTasks | ListRefDISyncTasks. | Consulta as tarefas de sincronização no Data Integration que usam uma fonte de dados específica. |
| ListSuccessInstanceAmount | ListSuccessInstanceAmount. | Consulta a tendência do número de instâncias de nós acionadas automaticamente que são executadas com sucesso a cada hora exata do dia atual. |
| OfflineNode | OfflineNode. | Cancela a implantação de um nó. |
| PublishDataServiceApi | PublishDataServiceApi. | Publica uma API. |
| QueryDefaultTemplate | QueryDefaultTemplate. | Consulta o modelo padrão de categoria de dados e nível de sensibilidade de dados definido pelo Data Security Guard. |
| QueryRecognizeDataByRuleType | QueryRecognizeDataByRuleType. | Consulta o tipo de uma regra de identificação de dados sensíveis. |
| QueryRecognizeRulesType | QueryRecognizeRulesType. | Consulta a regra integrada de identificação de dados sensíveis usada para configurar um campo sensível. |
| QuerySensClassification | QuerySensClassification. | Consulta categorias de dados. |
| QuerySensLevel | QuerySensLevel. | Consulta os níveis de sensibilidade de dados no Data Security Guard. |
| QuerySensNodeInfo | QuerySensNodeInfo. | Consulta as regras de identificação de dados sensíveis. |
| RemoveEntityTags | RemoveEntityTags. | Remove tags de uma entidade. Somente entidades do tipo maxcompute-table são suportadas. |
| ResumeInstance | ResumeInstance. | Retoma uma instância suspensa. |
| RevokeTablePermission | RevokeTablePermission. | Revoga as permissões de um usuário em uma tabela. |
| RunCycleDagNodes | RunCycleDagNodes. | Cria um fluxo de trabalho para retroalimentar dados. |
| RunSmokeTest | RunSmokeTest. | Cria um fluxo de trabalho para realizar testes de fumaça. |
| RunTriggerNode | RunTriggerNode. | Executa um nó acionado manualmente. |
| SaveDataServiceApiTestResult | SaveDataServiceApiTestResult. | Salva os resultados de teste de uma API. |
| ScanSensitiveData | ScanSensitiveData. | Verifica se os dados de entrada contêm dados sensíveis. |
| SearchNodesByOutput | SearchNodesByOutput. | Consulta um nó com base na saída. |
| SetDataSourceShare | SetDataSourceShare. | Compartilha uma fonte de dados com um workspace DataWorks específico ou um usuário específico. |
| SetEntityTags | SetEntityTags. | Configura tags para uma entidade. Somente entidades do tipo maxcompute-table são suportadas. |
| SetSuccessInstance | SetSuccessInstance. | Define o estado de uma instância com falha como bem-sucedido. |
| StartDIJob | StartDIJob. | Inicia uma tarefa de sincronização de uma nova versão. Somente o seguinte tipo de tarefa é suportado: sincronização de dados em tempo real de um banco de dados MySQL para o Hologres. |
| StartDISyncInstance | StartDISyncInstance. | Inicia uma tarefa de sincronização em tempo real ou uma solução de sincronização. |
| StartMigration | StartMigration. | Inicia uma tarefa de migração. |
| 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. |
| StopDISyncInstance | StopDISyncInstance. | Interrompe uma tarefa de sincronização em tempo real. |
| StopInstance | StopInstance. | Encerra uma instância. |
| SubmitDataServiceApi | SubmitDataServiceApi. | Submete uma API no DataService Studio. |
| TerminateDISyncInstance | TerminateDISyncInstance. | Cancela a implantação de uma tarefa de sincronização em tempo real. |
| TestDataServiceApi | TestDataServiceApi. | Testa uma API do DataService Studio em modo assíncrono. Você pode chamar a operação GetDataServiceApiTest para consultar o resultado do teste. |
| UpdateConnection | UpdateConnection. | Atualiza uma fonte de dados. |
| UpdateDIProjectConfig | UpdateDIProjectConfig. | Modifica a configuração global padrão das soluções de sincronização em um workspace do DataWorks. |
| UpdateFile | UpdateFile. | Atualiza um arquivo. |
| UpdateFolder | UpdateFolder. | Atualiza uma pasta. |
| UpdateIDEEventResult | UpdateIDEEventResult. | Retorna o resultado da verificação de um evento de ponto de extensão para o DataStudio após o evento de ponto de extensão ser acionado durante o desenvolvimento de dados e verificado por uma extensão. |
| UpdateNodeOwner | UpdateNodeOwner | Changes the owner of a node. |
| UpdateNodeRunMode | UpdateNodeRunMode. | Congela ou descongela um nó. |
| UpdateRemind | UpdateRemind. | Modifica uma regra de alerta personalizada. |
| UpdateTableAddColumn | UpdateTableAddColumn. | Atualiza os campos em uma tabela MaxCompute. |