Antes de criar um plano de uso, certifique-se de que você configurou as chaves de API desejadas. Para obter mais informações, consulte Configurar chaves da API usando o console do API Gateway.
Esta seção descreve como criar e utilizar um plano de uso com o console do API Gateway.
Tópicos
Migrar a API para planos de uso padrão (se necessário)
Se você começou a usar o API Gateway depois que o recurso de planos de uso foi lançado em 11 de agosto de 2016, terá planos de uso habilitados automaticamente em todas as regiões compatíveis.
Se começou a usar o API Gateway antes dessa data, poderá ser necessário migrar para os planos de uso padrão. Você receberá a opção Enable Usage Plans (Habilitar planos de uso) antes de usar os planos de uso pela primeira vez na região selecionada. Quando você habilita essa opção, você tem planos de uso padrão criados para cada estágio de API exclusivo que está associado a chaves de API existentes. No plano de uso padrão, nenhum limite de controle ou limite de cota é definido inicialmente, e as associações entre chaves de API e estágios de API são copiadas para os planos de uso. A API tem o mesmo comportamento de antes. Contudo, você deve usar a propriedade de UsagePlan
apiStages
para associar valores especificados de estágios de API (apiId
e stage
) com as chaves de API incluídas (via UsagePlanKey
), em vez de usar a propriedade stageKeys
da ApiKey.
Para verificar se você já migrou para os planos de uso padrão, use o comando get-account
da CLI. Na saída do comando, a lista features
inclui uma entrada de "UsagePlans"
quando os planos de uso estão habilitados.
Você também pode migrar as APIs para os planos de uso padrão usando a AWS CLI da seguinte maneira:
Para migrar para os planos de uso padrão usando a AWS CLI
-
Chame este comando da CLI:
update-account
. -
No parâmetro
cli-input-json
, use o seguinte JSON:[ { "op": "add", "path": "/features", "value": "UsagePlans" } ]
Criar um plano de uso
O procedimento a seguir descreve como criar um plano de uso.
Para criar um plano de uso
Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway
. -
No painel de navegação principal do API Gateway, escolha Planos de uso e Criar plano de uso.
-
Em Nome, insira um nome.
-
(Opcional) Em Description (Descrição), insira uma descrição.
-
Por padrão, os planos de uso permitem o controle de utilização. Insira uma Taxa e um Pico para seu plano de uso. Escolha Controle de utilização para desativar o controle de utilização.
-
Por padrão, os planos de uso permitem uma cota por um período. Em Solicitações, insira o número total de solicitações que um usuário pode fazer no período do plano de uso. Escolha Cota para desativar a cota.
-
Escolha Criar plano de uso.
Para adicionar um estágio ao plano de uso
-
Selecione o plano de uso.
-
Na guia Estágios associados, escolha Adicionar estágio.
-
Em API, selecione uma API.
-
Em Estágio, selecione um estágio.
-
(Opcional) Para ativar o controle de utilização no nível do método, faça o seguinte:
-
Escolha Controle de utilização no nível do método e Adicionar método.
-
Em Recurso, selecione um recurso da API.
-
Em Método, selecione um método da API.
-
Insira uma Taxa e um Pico para seu plano de uso.
-
-
Escolha Adicionar ao plano de uso.
Para adicionar uma chave ao plano de uso
-
Na guia Chaves de API associadas, escolha Adicionar chave de API.
-
-
Para associar uma chave existente ao plano de uso, selecione Adicionar chave existente e escolha a respectiva chave no menu suspenso.
-
Para criar uma chave de API, selecione Criar e adicionar nova chave e crie uma chave. Para obter mais informações sobre como criar uma chave, consulte Criar uma chave de API.
-
-
Escolha Adicionar chave de API.
Testar um plano de uso
Para testar o plano de uso, você pode usar um SDK da AWS, a AWS CLI ou um cliente da API REST, como o Postman. Para ver um exemplo de como usar o Postman
Manter um plano de uso
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.
Para monitorar as cotas usadas e restantes
Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway
. -
No painel de navegação principal do API Gateway, escolha Planos de uso.
-
Selecione um plano de uso.
-
Escolha a guia Chaves de API associadas para ver o número de solicitações restantes no período de cada chave.
-
(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.
{ "thisPeriod": { "px1KW6...qBazOJH": [ [ 0, 5000 ], [ 0, 5000 ], [ 0, 10 ] ] }, "startDate": "2016-08-01", "endDate": "2016-08-03" }
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
Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway
. -
No painel de navegação principal do API Gateway, escolha Planos de uso.
-
Selecione um plano de uso.
-
Escolha a guia Chaves de API associadas para ver o número de solicitações restantes no período de cada chave.
-
Selecione uma chave de API e escolha Conceder extensão de uso.
-
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.
Escolha Atualizar cota.