Manter um plano de uso para APIs REST no API Gateway

A manutenção de um plano de uso requer o monitoramento das cotas usadas e restantes durante determinado período e, se necessário, a extensão das cotas restantes de acordo com uma quantidade especificada. Os procedimentos a seguir descrevem como monitorar cotas.

AWS Management Console

Para monitorar as cotas usadas e restantes

1. Faça login no console do API Gateway em https://console.aws.amazon.com/apigateway.

2. No painel de navegação principal do API Gateway, escolha Planos de uso.

3. Selecione um plano de uso.

4. Escolha a guia Chaves de API associadas para ver o número de solicitações restantes no período de cada chave.

5. (Opcional) Escolha Exportar dados de uso e escolha uma data para De e uma data para Até. Depois, escolha JSON ou CSV para o formato de dados exportados e selecione Exportar.

   O exemplo a seguir mostra um arquivo exportado.

   {
       "px1KW6...qBazOJH": [
         [
           0,
           5000
         ],
         [
           0,
           5000
         ],
         [
           0,
           10
         ]
       ]
     }

   Os dados de uso no exemplo mostram os dados de uso diários para um cliente de API, conforme identificado pela chave de API (px1KW6...qBazOJH), entre 1º de agosto de 2016 e 3 de agosto de 2016. Cada dado de uso diário mostra as cotas usadas e restantes. Nesse exemplo, o assinante não utilizou as cotas alocadas ainda, e o proprietário ou o administrador da API reduziu a cota restante de 5000 para 10 no terceiro dia.

Os procedimentos a seguir descrevem como modificar cotas.

Para estender as cotas restantes

1. Faça login no console do API Gateway em https://console.aws.amazon.com/apigateway.

2. No painel de navegação principal do API Gateway, escolha Planos de uso.

3. Selecione um plano de uso.

4. Escolha a guia Chaves de API associadas para ver o número de solicitações restantes no período de cada chave.

5. Selecione uma chave de API e escolha Conceder extensão de uso.

6. Insira um número para a cota de Solicitações restantes. Você pode aumentar as solicitações de renomeação ou diminuir as solicitações restantes durante o período do plano de uso.

7. Escolha Atualizar cota.

AWS CLI

Os exemplos de código update-usage-plan a seguir adicionam, removem ou modificam as configurações de controle de utilização em nível de método em um plano de uso.

nota

Altere o us-east-1 para o valor de região apropriado para sua API.

Para adicionar ou substituir um limite de taxa para limitação de uso de um recurso e método específico:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/rateLimit",value="0.1"

Para adicionar ou substituir um limite de intermitência para limitação de uso de um recurso e método específico:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/burstLimit",value="1"

Para remover as configurações de limitação de uso de um recurso e método específico:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod",value=""

Para remover todas as configurações de limitação de uso em nível de método para uma API:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle ",value=""

Veja um exemplo que usa a API de exemplo PetStore:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle",value='"{\"/pets/GET\":{\"rateLimit\":1.0,\"burstLimit\":1},\"//GET\":{\"rateLimit\":1.0,\"burstLimit\":1}}"'

REST API

Chame usageplan:update para manter um plano de uso.