Como posso identificar o uso associado a uma chave de API para o API Gateway?

Data da última atualização: 12/08/2022

Como posso obter o uso associado a uma chave de API para o Amazon API Gateway?

Resolução

Siga estas instruções para obter o uso da chave de API usando o Console de Gerenciamento da AWS ou a AWS Command Line Interface (AWS CLI).

Observação: se você receber erros ao executar comandos da AWS CLI, utilize a versão mais recente da AWS CLI.

Use o Console de Gerenciamento da AWS

  1. Abra o console do API Gateway.
  2. No painel de navegação, escolha APIs.
  3. Escolha a API e, em seguida, escolha Usage Plans (Planos de uso).
  4. Escolha seu plano de uso.
  5. EscolhaActions (Ações) e, em seguida, escolha Export Usage Data (Exportar dados de uso).
  6. Escolha o intervalo de datas de exportação From (De) e To (Até).
  7. Em Export as (Exportar como), escolha JSON ou CSV e, em seguida, selecione Export (Exportar).

Para obter mais informações, consulte Create, configure, and test usage plans with the API Gateway console (Criar, configurar e testar planos de uso com o console do API Gateway).

Use a AWS CLI

Você pode usar o comando da AWS CLI get-usage para obter os dados de uso de um plano de uso em um intervalo de datas semelhante ao seguinte:

aws apigateway get-usage --usage-plan-id <usage-plan-id> --start-date "20xx-xx-xx" --end-date "20xx-xx-xx" --key-id <api-key-id>

Observação: o intervalo de datas de uso não pode exceder 90 dias.

Para obter mais informações, consulte Create, configure, and test usage plans using the API Gateway CLI and REST API (Criar, configurar e testar planos de uso usando a CLI do API Gateway e a API REST).


Este artigo ajudou?


Precisa de ajuda com faturamento ou suporte técnico?