Todos os produtos
Search
Central de documentação

DataWorks:Usar a OpenAPI

Última atualização: Jun 27, 2026

Este tópico apresenta uma visão geral da OpenAPI do DataWorks, incluindo informações básicas, limitações de uso, faturamento e instruções de chamada.

Informações básicas

Versão

Portal da OpenAPI

APIs compatíveis

Regiões compatíveis

2024-05-18 (nova versão)

Portal da OpenAPI

Lista de APIs compatíveis

China (Hangzhou), China (Shanghai), China (Shenzhen), China (Beijing), China (Zhangjiakou), China North 2 Ali Gov 1, China East 2 Finance, China (Chengdu), China (Hong Kong), Singapura, Indonésia (Jacarta), EUA (Vale do Silício), EUA (Virgínia), Alemanha (Frankfurt), Reino Unido (Londres), Japão (Tóquio) e Malásia (Kuala Lumpur)

Importante

Observações sobre as APIs relacionadas ao Data Studio:

  • Se você Use the New Data Studio, use a versão 2024-05-18 da OpenAPI.

  • Caso não Use the New Data Studio, use a versão 2020-05-18 da OpenAPI.

Verifique se você está usando o novo Data Studio e selecione a versão correspondente da OpenAPI. Selecionar uma versão incorreta pode causar falhas na consulta ou retornar resultados inesperados.

2020-05-18 (versão legada)

Portal da OpenAPI

Lista de APIs compatíveis

Limitações

  • Os requisitos de edição para a OpenAPI de um módulo correspondem aos do próprio módulo.

  • Para regular as chamadas à OpenAPI do DataWorks e garantir a estabilidade do sistema, as APIs são classificadas como leitura ou escrita. Diferentes edições do DataWorks possuem limites específicos de QPS (consultas por segundo). A Basic Edition também tem um limite diário de chamadas, enquanto a Standard Edition, Professional Edition e Enterprise Edition não possuem essa restrição. Cada edição conta ainda com uma cota mensal gratuita de chamadas e regras de pagamento conforme o uso para chamadas que excedem a cota. A tabela a seguir resume esses detalhes.

    Versão

    Limite de QPS

    Limite diário de chamadas

    Cota mensal gratuita de chamadas

    Pagamento conforme o uso após exceder a cota gratuita

    Basic Edition

    QPS total de todas as APIs ≤ 5

    Total de chamadas diárias de API ≤ 100

    3.100 chamadas/mês

    Aplicam-se limites de chamadas. Não há suporte para faturamento adicional no modelo de pagamento conforme o uso.

    Standard Edition

    Sem limite diário de chamadas

    100.000 chamadas/mês

    USD 0,05 por 10.000 chamadas

    Professional Edition

    Sem limite diário de chamadas

    500.000 chamadas/mês

    USD 0,05 por 10.000 chamadas

    Enterprise Edition

    • QPS total de APIs de leitura ≤ 50

    • QPS total de APIs de escrita ≤ 20

    Sem limite diário de chamadas

    1.000.000 chamadas/mês

    USD 0,05 por 10.000 chamadas

    Importante
    • O QPS da API e as contagens de chamadas são calculados como o valor cumulativo de cada conta Alibaba Cloud (incluindo usuários RAM) em cada região.

    • Se o limite de QPS ou o limite diário de chamadas da Basic Edition for excedido, as chamadas falharão. Controle adequadamente a simultaneidade e a frequência das suas chamadas.

    • Na Basic Edition, tanto as chamadas de API bem-sucedidas quanto as malsucedidas contam para o limite diário. A Standard Edition, Professional Edition e Enterprise Edition não possuem limite diário de chamadas, e as chamadas com falha não são contabilizadas nesse limite. Fique atento à cota mensal gratuita de chamadas e às regras de faturamento de pagamento conforme o uso.

    • É possível determinar o tipo de leitura/escrita de cada API com base em seu nome. Por exemplo, CreateFile é uma API de escrita, e ListFiles é uma API de leitura.

Pré-requisito

Antes de chamar a OpenAPI, certifique-se de que a permissão AliyunDataWorksFullAccess esteja ativada. Caso contrário, as chamadas à OpenAPI podem falhar devido a permissões insuficientes. Para mais informações, consulte Conceder a permissão AliyunDataWorksFullAccess.

Cota gratuita e faturamento

A cota mensal gratuita de chamadas, o preço unitário de pagamento conforme o uso após o esgotamento da cota, os limites de QPS e os limites diários de chamadas para cada edição estão resumidos na tabela da seção Limitações acima. As informações a seguir fornecem detalhes adicionais sobre métricas de faturamento e considerações importantes.

Importante
  • Todo mês civil, cada conta Alibaba Cloud (incluindo usuários RAM) em cada região recebe uma cota gratuita de chamadas à OpenAPI. A cota mensal gratuita varia conforme a edição do DataWorks.

  • A Basic Edition está sujeita tanto ao limite diário de chamadas quanto à cota mensal gratuita (para detalhes, consulte Limitações acima). As chamadas são rejeitadas após o limite ser excedido, e não há suporte para faturamento de pagamento conforme o uso. A Standard Edition e a Professional Edition não possuem limite diário de chamadas e cada uma tem uma cota mensal gratuita (veja a tabela na seção Limitações acima). O faturamento de pagamento conforme o uso é suportado após a cota gratuita ser excedida. Para preços unitários e diferenças específicas de ambiente, consulte Faturamento da OpenAPI em Custos de recursos. A Enterprise Edition não possui limite diário de chamadas, e as mesmas regras de faturamento de pagamento conforme o uso se aplicam após o esgotamento da cota gratuita.

  • A Standard Edition, Professional Edition e Enterprise Edition do DataWorks permitem a continuidade das chamadas de API a preços de pagamento conforme o uso após o esgotamento da cota mensal gratuita. Os sites internacionais utilizam o preço unitário e o faturamento mostrados na documentação. Para mais informações, consulte Custos de recursos. O preço real de faturamento está sujeito ao valor exibido na sua fatura final.

Como chamar a OpenAPI

Nota

Para mais informações sobre a OpenAPI da Alibaba Cloud, consulte OpenAPI da Alibaba Cloud.

Métodos de chamada

Método de chamada

Status de suporte

Descrição

SDK (recomendado)

Compatível

Para as linguagens compatíveis com o SDK do DataWorks e métodos de instalação de dependências, consulte SDK do DataWorks.

Chamada HTTP nativa

Compatível

As chamadas HTTP nativas exigem que você implemente o algoritmo de assinatura e construa solicitações personalizadas para iniciar as chamadas HTTP. Para mais informações sobre o mecanismo de assinatura, consulte Mecanismo de assinatura.

Exemplos de chamada

Estilo da API

Estilo RPC.

Endpoints

Selecione o endpoint correspondente à região onde seu workspace do DataWorks está localizado para obter a menor latência. Por exemplo, o endpoint VPC para China (Zhangjiakou) é dataworks-vpc.cn-zhangjiakou.aliyuncs.com. Para mais informações, consulte Endpoints (2024-05-18) e Endpoints (2020-05-18).

Visualizar o uso da OpenAPI

Use a Open Platform para visualizar o uso da sua OpenAPI, incluindo consumo da cota gratuita, contagem de chamadas e detalhes das chamadas. Para mais informações, consulte Visualizar o uso da OpenAPI.