Mobile Platform as a Service:Limite de tráfego de API

O limite de tráfego de API permite definir limites para APIs individuais, limites de taxa padrão para todas as APIs e um limite total de taxa para um aplicativo. Esse recurso evita a sobrecarga dos servidores de backend durante picos de tráfego. Se você definir um limite de taxa padrão de API e um limite total de taxa do aplicativo, o menor valor prevalece.

Este tópico descreve como configurar limites de taxa padrão de API e limites totais de taxa do aplicativo. Para definir um limite de taxa para uma API específica, configure-o na página de detalhes da API. Para mais informações, consulte Configurar uma API.

Pré-requisitos

Para usar as configurações de limite de tráfego, ative primeiro o recurso correspondente. Faça login no console mPaaS. No painel de navegação à esquerda, escolha Mobile Gateway > Gateway Management. Em seguida, ative a chave Limit API traffic.

Limite de taxa padrão de API

Defina um limite de taxa padrão para todas as APIs no aplicativo atual. O sistema aplica o limite de taxa padrão conforme as regras abaixo:

• Um limite configurado para uma API específica substitui o limite de taxa padrão.

• A configuração de limitação por API sobrescreve a configuração padrão.

• Alterações na configuração do limite de taxa padrão afetam todas as APIs que utilizam essa configuração.

Etapas:

1. Ative a chave API default traffic limit.

2. Na caixa de configuração de limite de taxa padrão, clique em Edit e defina as informações do limite.

   • Default rate limit: Defina um limiar adequado às necessidades do seu negócio. Solicitações acima desse valor sofrem limitação.

     Nota

     O limiar de limite de taxa corresponde ao número máximo de solicitações por segundo.

   • Traffic limit response: A resposta padrão para solicitações limitadas é: {"resultStatus":1002,"tips":"The server is busy. Please try again later."} Para personalizar a resposta de limitação, use o formato a seguir:

       {
           "result": "==Enter your custom response content here==",
           "tips": "ok",
           "resultStatus": 1000,
       }

     Em que:

     • result: dados de resposta personalizados em formato JSON. O cliente processa esse campo apenas quando resultStatus for 1000.

     • tips: mensagem personalizada de limitação. Se resultStatus for 1002, o sistema usa esse campo para notificar o usuário.

     • resultStatus: código de resultado retornado para uma solicitação limitada. Para mais informações sobre as definições dos códigos de resultado, consulte Códigos de resultado do gateway.

Limite total de taxa do aplicativo

Estabeleça um limite total de taxa para todas as APIs no aplicativo atual. Quando o número total de solicitações ultrapassar esse limite, o sistema limita todas as solicitações subsequentes para qualquer API do aplicativo.

Etapas:

1. Ative a chave Total traffic limit of the App.

2. Na caixa de configuração de limite total de taxa do aplicativo, clique em Edit e defina as informações do limite.

   • Total rate limit: Especifique um limiar razoável em solicitações por segundo, considerando as demandas do seu negócio. Solicitações acima desse valor sofrem limitação.

   • Traffic limit response: A resposta padrão para solicitações limitadas é: {"resultStatus":1002,"tips":"The server is busy. Please try again later."} Para personalizar a resposta de limitação, use o formato a seguir:

       {
           "result": "==Enter your custom response content here==",
           "tips": "ok",
           "resultStatus": 1000,
       }

     Em que:

     • result: dados de resposta personalizados em formato JSON. O cliente processa esse campo somente quando resultStatus for 1000.

     • resultStatus: código de resultado retornado para uma solicitação limitada. Para obter mais detalhes sobre as definições dos códigos de resultado, consulte Códigos de resultado do gateway.

     • tips: mensagem personalizada de limitação. Caso resultStatus seja 1002, o sistema usa esse campo para notificar o usuário.