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 | Criar uma cota. | Cria uma cota. Ao ativar o MaxCompute pela primeira vez, é necessário criar primeiro uma cota pay-as-you-go. Se você criar uma cota por assinatura, o pagamento será deduzido automaticamente. |
| ListQuotas | ListQuotas. | 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 | CreateComputeQuotaPlan. | Cria um plano de quota. |
| 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 | GetComputeQuotaPlan. | Obtém informações detalhadas de um único plano de cota de computação. |
| ListComputeQuotaPlan | ListComputeQuotaPlan. | Lista os planos de cota de computação. |
| UpdateComputeQuotaPlan | UpdateComputeQuotaPlan. | Atualiza o ComputeQuotaPlan. |
| DeleteComputeQuotaPlan | DeleteComputeQuotaPlan. | Exclui um plano de cotas do MaxCompute. |
| ApplyComputeQuotaPlan | ApplyComputeQuotaPlan. | Ativa um Plano de Quota imediatamente. |
| GetComputeQuotaSchedule | GetComputeQuotaSchedule. | Consulta a configuração da cota de computação específica por horário. |
| UpdateComputeQuotaSchedule | UpdateComputeQuotaSchedule. | Atualiza o agendamento baseado em tempo para uma cota de computação. |
| GetComputeEffectivePlan | GetComputeEffectivePlan. | Obtém o plano de computação efetivo. |
| Configuração de cota de túnel baseada em tempo | Configuração de cota de túnel baseada em tempo | |
| ListTunnelQuotaTimer | ListTunnelQuotaTimer. | Exibe a configuração específica por horário de um grupo de recursos exclusivo para Tunnel (referido como cota do Tunnel). |
| Configuração de cota de computação (legada, não recomendada) | Configuração de cota de computação (legada, não recomendada) | |
| CreateQuotaPlan | CreateQuotaPlan. | Cria um plano de cota. |
| GetQuotaPlan | GetQuotaPlan. | Obtém as informações de um plano de quota. |
| UpdateQuotaPlan | UpdateQuotaPlan. | Atualiza um plano de cota. |
| ListQuotasPlans | ListQuotasPlans. | Obtém planos de cota. |
| DeleteQuotaPlan | DeleteQuotaPlan. | 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 | UpdateProjectIpWhiteList. | Modifica a lista de permissões de IP de um projeto 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. |
| Permissões de função e usuário (Função, usuário) | Permissões de função e usuário (Função, usuário) | |
| DeleteRole | DeleteRole. | Exclui uma função no nível do projeto no MaxCompute. |
| ListProjectUsers | ListProjectUsers. | Consulta uma lista de usuários em um projeto. |
| CreateRole | CreateRole. | Cria uma role no nível do projeto 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 | ListUsersByRole. | Obtém informações sobre os usuários aos quais uma função no nível do projeto foi atribuída. |
| UpdateUsersToRole | UpdateUsersToRole. | Adiciona ou remove usuários de uma role de projeto. |
| Pacote | Pacote | |
| ListPackages | ListPackages. | Consulta os pacotes em um projeto do MaxCompute. |
| UpdatePackage | UpdatePackage. | Atualiza os objetos em um pacote e os projetos nos quais o pacote pode ser instalado. |
| CreatePackage | CreatePackage. | Cria um pacote. |
| GetPackage | GetPackage. | Obtém as informações sobre um pacote. |
| Tabelas (Tabela) | Tabelas (Tabela) | |
| GetTableInfo | GetTableInfo. | Consulta as informações sobre tabelas internas, visualizações, tabelas externas, tabelas clusterizadas ou tabelas transacionais do MaxCompute. |
Monitoramento de recursos
|
API |
Título |
Descrição |
| QueryQuotaMetric | QueryQuotaMetric. | Consulta os dados de série temporal de consumo de recursos para uma cota. |
| QueryTunnelMetricDetail | QueryTunnelMetricDetail. | Consulta os detalhes do serviço de transmissão de dados do Tunnel para um intervalo de tempo especificado. |
| QueryTunnelMetric | QueryTunnelMetric. | Consulta dados de métricas do Tunnel Data Transmission Service dentro de um intervalo de tempo especificado. |
| GetQuotaUsage | GetQuotaUsage. | Consulta as informações de consumo de recursos de cota. |
| ListJobMetric | ListJobMetric. | Consulta uma métrica de desempenho do job concluído. |
| QueryStorageMetric | QueryStorageMetric. | Consulta as métricas de séries temporais do armazenamento de dados. |
| ListStorageTablesInfo | ListStorageTablesInfo. | Consulta os detalhes de armazenamento de tabelas de um projeto MaxCompute. |
| ListStoragePartitionsInfo | ListStoragePartitionsInfo | Obtém os detalhes de armazenamento das partições de uma tabela particionada em um projeto do MaxCompute. |
| GetStorageSizeSummary | GetStorageSizeSummary. | Obtém um resumo do uso de armazenamento. |
| GetStorageAmountSummary | GetStorageAmountSummary. | Obtém um resumo da quantidade total de armazenamento. |
| GetStorageSummaryCompared | GetStorageSummaryCompared. | Obtém a variação ano a ano (YoY) no uso de armazenamento. |
| ListStorageProjectsInfo | ListStorageProjectsInfo. | Obtém os detalhes de armazenamento dos projetos. |
O&M de jobs
|
API |
Título |
Descrição |
| ListJobInfos | ListJobInfos. | Obtém uma lista de jobs. |
| ListJobSnapshotInfos | ListJobSnapshotInfos. | Obtém 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 | KillJobs. | 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 | RetryMmsTask. | Tenta novamente uma tarefa de migração. |
| CreateMmsDataSource | CreateMmsDataSource. | Cria uma fonte de dados para migrar dados para o MaxCompute usando o MaxCompute Migration Assist (MMA). |
| GetMmsDataSource | GetMmsDataSource | Obtém os detalhes de uma única fonte de dados do MaxCompute Migration Assist (MMA). |
| ListMmsDataSources | ListMmsDataSources | Lista as fontes de dados do MaxCompute Migration Assist (MMA). |
| UpdateMmsDataSource | UpdateMmsDataSource. | Atualiza os metadados de uma fonte de dados do MaxCompute Migration Assist (MMA). |
| DeleteMmsDataSource | DeleteMmsDataSource. | Exclui uma fonte de dados do MaxCompute Migration Assist (MMA) e seus planos de migração e metadados associados. |
| CreateMmsFetchMetadataJob | CreateMmsFetchMetadataJob. | Cria uma tarefa para extrair metadados de uma fonte de dados. |
| GetMmsFetchMetadataJob | GetMmsFetchMetadataJob. | Obtém os detalhes de um job do MaxCompute Migration Assist (MMA) que busca metadados. |
| ListMmsDbs | ListMmsDbs | Lista os bancos de dados na fonte de dados do 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 | CreateMmsJob. | Cria uma tarefa de migração de dados. |
| ListMmsJobs | ListMmsJobs. | Lista os trabalhos de migração. |
| GetMmsJob | GetMmsJob. | Obtém os detalhes de um único plano de migração do MaxCompute Migration Assist (MMA). |
| GetMmsAsyncTask | GetMmsAsyncTask | Obtém uma única tarefa assíncrona do MaxCompute Migration Assist (MMA). |
| DeleteMmsJob | DeleteMmsJob. | Exclui um plano de migração de dados do MaxCompute Migration Assist (MMA). |
| StartMmsJob | StartMmsJob. | Inicia uma tarefa de migração de dados. |
| StopMmsJob | StopMmsJob. | Para um job de migração de dados. |
| RetryMmsJob | RetryMmsJob. | Tenta novamente um trabalho de migração de dados. |
| ListMmsTasks | Lista de tarefas de migração de dados. | Obtém uma lista de tarefas de migração de dados. |
| GetMmsTask | GetMmsTask | Obtém os detalhes de uma tarefa de migração específica. |
| ListMmsTaskLogs | ListMmsTaskLogs | Lista os logs de execução de uma tarefa de migração específica. |
| CreateMmsTimer | CreateMmsTimer. | Cria um timer MMS. |
| UpdateMmsTimer | UpdateMmsTimer. | Atualiza as configurações de uma tarefa agendada. |
| 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 | ListMmsTimers. | Lista os timers de uma fonte de dados especificada. |
| ListMmsTimerLogs | ListMmsTimerLogs. | Lista os logs de uma tarefa agendada para uma fonte de dados específica. |
| ListMmsDataSourceConfigItems | ListMmsDataSourceConfigItems. | Lista os itens de configuração de um tipo de fonte de dados especificado. |
| GetMmsTimer | GetMmsTimer. | Obtém o temporizador MMS. |
| DeleteMmsTimer | DeleteMmsTimer. | Exclui um timer de uma fonte de dados especificada. |
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 | SumStorageMetricsByType. | Agrega o 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 | SumComputeMetricsByRecord. | Calcula o número total de registros de uso. |
| SumDailyBillsByItem | SumDailyBillsByItem. | Consulta um detalhamento diário de custos por instância ou item faturável. |
| 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 | ListComputeMetricsByInstance. | Lista o uso de computação para jobs por 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 | DeleteProject. | Exclui um projeto do MaxCompute. Esta operação é irreversível. Use esta API com cautela. |
| GetProject | GetProject | Queries the basic information of a MaxCompute project. |
| ListFunctions | ListFunctions. | Obtém funções em um projeto do MaxCompute. |
| ListProjects | ListProjects. | Obtém uma lista de projetos do MaxCompute. |
| ListResources | ListResources. | Obtém recursos em um projeto MaxCompute. |
| ListRoles | ListRoles. | Obtém as funções no nível do projeto do MaxCompute. |
| ListTables | ListTables | Obtém tabelas em um projeto MaxCompute. |
| ListUsers | ListUsers. | Obtém os usuários em um projeto do MaxCompute. |