DataWorks:Usar a OpenAPI

Informações básicas

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 possui um limite diário de chamadas, enquanto a Standard Edition, Professional Edition e Enterprise Edition não possuem esse limite. 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 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

  As tarefas de agendamento subjacentes do DataWorks não são executadas por meio de operações da OpenAPI. Esgotar a cota de chamadas da OpenAPI não afeta a execução normal de tarefas de agendamento cronometrado ou tarefas em lote. Apenas as tarefas que chamam operações da OpenAPI, como nós Python ou nós PyODPS, podem ser afetadas. As instâncias agendadas no ambiente de produção são geradas antecipadamente e não estão sujeitas à cota de chamadas de API.

  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 for excedido ou se o limite diário de chamadas da Basic Edition for ultrapassado, 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 de chamadas. A Standard Edition, Professional Edition e Enterprise Edition não possuem limite diário de chamadas, e as chamadas malsucedidas 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 Grant the AliyunDataWorksFullAccess permission.

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 Limitations acima. As informações a seguir fornecem detalhes adicionais sobre métricas de faturamento e considerações importantes.

• A cada mês civil, uma cota gratuita de chamadas à OpenAPI é concedida a cada conta Alibaba Cloud (incluindo usuários RAM) em cada região. 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 de chamadas (para detalhes, consulte Limitations 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 de chamadas (consulte a tabela na seção Limitações acima). Há suporte para faturamento de pagamento conforme o uso após a cota gratuita ser excedida. Para preços unitários e diferenças específicas de ambiente, consulte OpenAPI billing in Resource costs. 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 a cota gratuita ser esgotada.

• 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 a cota mensal gratuita de chamadas ser esgotada. Os sites internacionais utilizam o preço unitário e o faturamento mostrados na documentação. Para mais informações, consulte Resource costs. O preço real de faturamento está sujeito ao valor exibido na sua fatura final.

Como chamar a OpenAPI

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

Visualizar o uso da OpenAPI

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