Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (MaxCompute/2022-01-04) utiliza o estilo de assinatura ROA. 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.
Gerenciamento de cotas
|
API |
Título |
Descrição |
| CreateQuota | Cria uma cota | Cria uma cota. Ao ativar o MaxCompute pela primeira vez, você deve primeiro criar uma cota pós-paga. Se você criar uma cota por assinatura, um pagamento automático será deduzido. |
| ListQuotas | Obtém uma lista de cotas | Obtém uma lista de cotas. |
| QueryQuota | QueryQuota. | Consulta as informações de um grupo de cotas de nível 1 especificado. |
| GetQuota | GetQuota. | Obtém informações do grupo de cotas de nível 1 especificado. Aviso: esta operação será descontinuada em 31 de julho de 2024. Ela será substituída pela operação QueryQuota. Os parâmetros de solicitação, os parâmetros de resposta e os recursos das duas operações são os mesmos. |
| Configuração de cota de computação | Configuração de cota de computação | |
| CreateComputeQuotaPlan | Criar um plano de cota de computação | Cria um plano de cota de computação. |
| UpdateComputeSubQuota | UpdateComputeSubQuota. | Atualiza a configuração básica de uma cota do MaxCompute, incluindo a adição ou exclusão de cotas de nível 2, a definição dos atributos básicos de uma cota de nível 2 e a configuração de unidades de computação (CUs) para um plano de cota em vigor. |
| GetComputeQuotaPlan | Detalhes do plano de cota de computação | Obtém os detalhes de um único plano de cota de computação. |
| ListComputeQuotaPlan | Listar planos de cota de computação | Lista os planos de cota de computação. |
| UpdateComputeQuotaPlan | Atualizar um plano de cotas | Atualiza um plano de cotas. |
| DeleteComputeQuotaPlan | Excluir um plano de cota de computação | Exclui um plano de cota de computação do MaxCompute. |
| ApplyComputeQuotaPlan | Ativar imediatamente um plano de cota | Ativa imediatamente um plano de cota. |
| GetComputeQuotaSchedule | GetComputeQuotaSchedule. | Consulta a configuração da cota de computação específica por horário. |
| UpdateComputeQuotaSchedule | Atualização do plano baseado em tempo para uma cota de computação | Atualiza o plano baseado em tempo para uma cota de computação. |
| GetComputeEffectivePlan | Plano de cota de computação atualmente ativo | Obtém o plano de cota de computação atualmente ativo. |
| Configuração de cota de computação (legado, não recomendado) | Configuração de cota de computação (legado, não recomendado) | |
| CreateQuotaPlan | Criar um plano de cota | Cria um plano de cota. |
| GetQuotaPlan | GetQuotaPlan. | Obtém as informações de um plano de quota. |
| UpdateQuotaPlan | Atualizar um plano de cota | Atualiza um plano de cota. |
| ListQuotasPlans | ListQuotasPlans. | Obtém planos de cota. |
| DeleteQuotaPlan | Excluir um plano de cota | Exclui um plano de cota. |
| UpdateQuotaSchedule | UpdateQuotaSchedule. | Atualiza o plano de agendamento de um plano de cota. |
| GetQuotaSchedule | GetQuotaSchedule. | Obtém o plano de agendamento para um plano de cota. |
Gerenciamento de projetos
|
API |
Título |
Descrição |
| Gerenciamento básico (projeto) | Gerenciamento básico (projeto) | |
| UpdateProjectBasicMeta | UpdateProjectBasicMeta | Modifies the basic information of a project. |
| UpdateProjectDefaultQuota | UpdateProjectDefaultQuota. | Atualiza a cota de computação padrão de um projeto. |
| UpdateProjectIpWhiteList | Atualizar a lista de permissões de endereços IP do projeto | Atualiza a lista de permissões de endereços IP de um projeto do MaxCompute. |
| UpdateProjectModelTier | UpdateProjectModelTier. | Atualiza o modelo de Camada 2 de um projeto para um modelo de Camada 3. |
| GetTrustedProjects | GetTrustedProjects. | Obtém os projetos confiáveis do projeto atual. |
| Funções e permissões (função, usuário) | Funções e permissões (função, usuário) | |
| DeleteRole | DeleteRole. | Exclui uma função no nível do projeto no MaxCompute. |
| ListProjectUsers | Obter a lista de usuários em um projeto | Obtém a lista de usuários em um projeto. |
| CreateRole | Criar uma função no nível do projeto | Cria uma função no nível do projeto no MaxCompute. |
| GetRoleAcl | GetRoleAcl. | Obtém as permissões baseadas em ACL concedidas a uma função no nível do projeto. |
| GetRoleAclOnObject | GetRoleAclOnObject. | Obtém as permissões baseadas em ACL em um objeto que são concedidas a uma função no nível do projeto. |
| GetRolePolicy | GetRolePolicy. | Obtém a política associada a uma função em nível de projeto. |
| ListUsersByRole | Usuários vinculados a uma função de nível de projeto | Obtém a lista de usuários vinculados a uma função de nível de projeto. |
| UpdateUsersToRole | Adiciona ou remove usuários de uma função de projeto | Adiciona ou remove usuários de uma função de projeto. |
| Pacote | Pacote | |
| ListPackages | Obter a lista de pacotes | Obtém a lista de pacotes em um projeto MaxCompute. |
| UpdatePackage | UpdatePackage. | Atualiza os objetos em um pacote e os projetos nos quais o pacote pode ser instalado. |
| CreatePackage | Criar um pacote | Cria um pacote. |
| GetPackage | GetPackage. | Obtém as informações sobre um pacote. |
| Tabelas | Tabelas | |
| GetTableInfo | Recuperar informações da tabela | Consulta as informações sobre tabelas internas, visualizações, tabelas externas, tabelas clusterizadas ou tabelas transacionais do MaxCompute. |
Observabilidade de recursos
|
API |
Título |
Descrição |
| QueryQuotaMetric | Consulta de informações de consumo de recursos de computação | Consulta informações de séries temporais sobre o consumo de recursos de cota. |
| QueryTunnelMetricDetail | Consulta de detalhes de observabilidade de recursos do Tunnel | Consulta os dados detalhados do serviço de transferência de dados do Tunnel dentro de um intervalo de tempo especificado. |
| QueryTunnelMetric | Recuperação de dados de série temporal de observação de recursos do Tunnel | Consulta os dados de métrica do serviço de transferência de dados do Tunnel dentro de um intervalo de tempo especificado. |
| GetQuotaUsage | GetQuotaUsage. | Consulta as informações de consumo de recursos de cota. |
| ListJobMetric | Métricas de desempenho de jobs | Obtém as métricas de desempenho de jobs concluídos. |
| QueryStorageMetric | QueryStorageMetric. | Consulta as métricas de séries temporais do armazenamento de dados. |
| ListStorageTablesInfo | Detalhes de armazenamento de tabelas | Obtém os detalhes de armazenamento das tabelas em um projeto do MaxCompute. |
| ListStoragePartitionsInfo | Detalhes de armazenamento de partições | Obtém os detalhes de armazenamento de cada partição em uma tabela particionada dentro de um projeto MaxCompute especificado. |
| GetStorageSizeSummary | GetStorageSizeSummary. | Obtém um resumo do uso de armazenamento. |
| GetStorageAmountSummary | Obtém as informações de armazenamento total | Obtém as informações de armazenamento total. |
| GetStorageSummaryCompared | GetStorageSummaryCompared. | Obtém a variação ano a ano (YoY) no uso de armazenamento. |
| ListStorageProjectsInfo | Obtém os detalhes de armazenamento dos projetos do MaxCompute | Obtém os detalhes de armazenamento dos projetos do MaxCompute. |
Operações de jobs
|
API |
Título |
Descrição |
| ListJobInfos | Lista os jobs | Lista os jobs. |
| ListJobSnapshotInfos | Obtém a lista de snapshots de jobs | Obtém os dados de snapshot de jobs em um ponto específico no tempo. |
| GetJobInfo | GetJobInfo. | Consulta as informações básicas de um job. |
| GetRunningJobs | GetRunningJobs. | Obtém os dados do estado de execução de jobs que estão em execução em um período de tempo especificado. |
| KillJobs | Encerrar um job | Encerra um job em execução. |
| GetJobResourceUsage | GetJobResourceUsage. | Calcula estatísticas sobre todos os jobs concluídos em um dia especificado e obtém o uso total de recursos de cada executor de jobs diariamente. |
Migração de dados
|
API |
Título |
Descrição |
| RetryMmsTask | Tentar novamente uma tarefa de migração de dados | Tenta novamente uma tarefa de migração de dados. |
| CreateMmsDataSource | Criação de uma fonte de dados | Cria uma fonte de dados para realizar a migração de dados da fonte de dados para o MaxCompute por meio do Migration Service. |
| GetMmsDataSource | GetMmsDataSource | Obtém os detalhes de uma única fonte de dados do MaxCompute Migration Assist (MMA). |
| ListMmsDataSources | Listar fontes de dados | Lista as fontes de dados do MMA. |
| UpdateMmsDataSource | Atualiza a configuração da fonte de dados e ativa ou desativa a instância da fonte de dados | Atualiza os metadados de uma fonte de dados do MaxCompute Migration Assist (MMA). |
| DeleteMmsDataSource | Excluir uma fonte de dados | Exclui uma fonte de dados MMA, incluindo os planos de migração e os metadados da fonte de dados. |
| CreateMmsFetchMetadataJob | Cria uma tarefa para sincronizar metadados da fonte de dados | Cria uma tarefa para buscar metadados da fonte de dados. |
| GetMmsFetchMetadataJob | Obtém os detalhes de um job de busca de metadados | Obtém os detalhes de um job do MaxCompute Migration Assist (MMA) que busca metadados. |
| ListMmsDbs | Listar bancos de dados em uma fonte de dados | Lista os bancos de dados em uma fonte de dados MMA. |
| GetMmsDb | GetMmsDb | Obtém um banco de dados de uma fonte de dados do MaxCompute Migration Assist (MMA). |
| ListMmsTables | ListMmsTables | Lista as tabelas em uma fonte de dados do MaxCompute Migration Assist (MMA). |
| GetMmsTable | GetMmsTable | Obtém uma tabela de uma fonte de dados do MaxCompute Migration Assist (MMA). |
| ListMmsPartitions | ListMmsPartitions | Lista as partições em uma fonte de dados do MaxCompute Migration Assist (MMA). |
| GetMmsPartition | GetMmsPartition | Obtém uma partição de uma fonte de dados do MaxCompute Migration Assist (MMA). |
| CreateMmsJob | Criar uma tarefa de migração de dados | Cria uma tarefa de migração de dados. |
| ListMmsJobs | ListMmsJobs. | Lista os trabalhos de migração. |
| GetMmsJob | Obter os detalhes de um único trabalho de migração | Obtém os detalhes de um único plano de migração MMA. |
| GetMmsAsyncTask | Detalhes de uma única tarefa assíncrona relacionada à migração de dados | Obtém uma única tarefa assíncrona no MMA. |
| DeleteMmsJob | Excluir um trabalho de migração de dados | Exclui um plano de migração de dados do MMA. |
| StartMmsJob | Iniciar um trabalho de migração de dados | Inicia um trabalho de migração de dados. |
| StopMmsJob | StopMmsJob. | Para um job de migração de dados. |
| RetryMmsJob | Tentar novamente uma tarefa de migração de dados | Tenta novamente uma tarefa de migração de dados. |
| ListMmsTasks | Consulta a lista de tarefas de migração de dados | Consulta a lista de tarefas de migração. |
| GetMmsTask | GetMmsTask | Obtém os detalhes de uma tarefa de migração específica. |
| ListMmsTaskLogs | Lista os logs de execução de uma única tarefa de migração | Lista os logs de execução de uma única tarefa de migração. |
| CreateMmsTimer | Criação de uma tarefa de migração de dados agendada | CreateMmsTimer. |
| UpdateMmsTimer | Atualiza uma tarefa agendada | UpdateMmsTimer. |
| UpdateMmsTables | UpdateMmsTables. | Atualiza metadados de tabela. |
| UpdateMmsTable | UpdateMmsTable. | Atualiza os metadados da tabela. |
| UpdateMmsDb | UpdateMmsDb. | Atualiza os metadados de um banco de dados especificado. |
| ListMmsTimers | Lista tarefas agendadas para migração de dados | Lista os temporizadores MMS. |
| ListMmsTimerLogs | Lista logs de tarefas agendadas | ListMmsTimerLogs. |
| ListMmsDataSourceConfigItems | ListMmsDataSourceConfigItems. | Lista os itens de configuração de um tipo de fonte de dados especificado. |
| GetMmsTimer | GetMmsTimer. | Obtém o temporizador MMS. |
| DeleteMmsTimer | Excluir uma tarefa agendada | Exclui uma tarefa agendada. |
Análise de custos
|
API |
Título |
Descrição |
| ListInstances | ListInstances. | Obtém uma lista de projetos para análise de custos em um período especificado. |
| SumStorageMetricsByType | Consulta as estatísticas de uso de armazenamento por tipo de armazenamento | Consulta as estatísticas de uso de armazenamento por tipo de armazenamento. |
| ListComputeMetricsBySignature | ListComputeMetricsBySignature. | Visualiza o uso detalhado de computação para jobs por Signature. |
| SumComputeMetricsByUsage | SumComputeMetricsByUsage. | Agrega o uso de computação por volume de dados escaneados ou uso de CU. |
| SumComputeMetricsByRecord | Conta o número de registros de uso | Conta o número de registros de uso. |
| SumDailyBillsByItem | Agregação de detalhes de faturamento diário por instância ou item de faturamento | Agrega os detalhes de faturamento diário por instância ou item de faturamento. |
| SumBills | SumBills. | Resume informações de custo por instância ou item faturável. |
| SumBillsByDate | SumBillsByDate. | Obtém um resumo diário de custos, agrupado por instância ou item faturável. |
| SumStorageMetricsByDate | SumStorageMetricsByDate. | Obtém métricas de armazenamento agregadas em um intervalo de datas especificado, agrupadas por projeto ou classe de armazenamento. |
| ListComputeMetricsByInstance | Listar o uso de computação de jobs no nível da instância | Lista o uso de computação de jobs no nível da instância. |
Outros
|
API |
Título |
Descrição |
| TriggerMmsTimer | TriggerMmsTimer. | Aciona um timer para uma fonte de dados específica. |
| CreateProject | Criar um projeto. | Cria um projeto do MaxCompute. |
| DeleteProject | Excluir um projeto | Exclui um projeto do MaxCompute. Esta operação é irreversível. Tenha cuidado ao chamar esta API. |
| GetLogviewDownloadUrl | Obtém o link de download do Logview offline | Obtém o link de download do arquivo Logview offline de uma instância em um projeto MaxCompute especificado. O link é válido por 10 minutos a partir do momento em que é gerado. |
| GetProject | Recupera as informações do projeto | Consulta as informações básicas de um projeto MaxCompute. |
| ListFunctions | ListFunctions. | Obtém funções em um projeto do MaxCompute. |
| ListProjects | Listar projetos | Lista os projetos do MaxCompute. |
| ListResources | Listar recursos | Obtém uma lista de recursos em um projeto MaxCompute. |
| ListRoles | Obter funções no nível do projeto | Obtém a lista de funções no nível do projeto em um projeto do MaxCompute. |
| ListTables | Listar tabelas | Obtém uma lista de tabelas em um projeto do MaxCompute. |
| ListUsers | Listar usuários | Obtém todos os usuários sob um tenant. |