Adição de Interceptor de Rate Limit (ssd api-management add (plan | api)-interceptor rate-limit)

O comando ssd api-management add (plan | api)-interceptor rate-limit permite adicionar um interceptor de "Rate Limit" ao fluxo de uma API ou um plano na Sensedia API Platform.

É possível utilizar o comando ssd api-management add (plan | api)-interceptor rate-limit ou a sua versão abreviada ssd apim add (plan | api)-interceptor rate-limit.

Uso

O comando ssd api-management add (plan | api)-interceptor rate-limit pode ser seguido de flags com seus respectivos argumentos:

ssd api-management add (plan | api)-interceptor rate-limit [flags]

Caso nenhuma flag seja especificada, o modo interativo será ativado.

Veja abaixo exemplos de uso no modo direto:

# Adiciona um interceptor de "Rate Limit" a todos os recursos e métodos da API ou do plano
$ ssd (api-management | apim) add api-interceptor rate-limit --api-name "Open Banking" --api-version "1.0.0" --revision 1 --calls 10 --interval HOUR
$ ssd (api-management | apim) add api-interceptor rate-limit --api-name "Open Banking" --api-version "1.0.0" --revision 1 --calls 10 --interval HOUR

# Seleciona a opção "Soft Limit" e especifica seu valor em porcentagem
$ ssd (api-management | apim) add api-interceptor rate-limit --api-name "Open Banking" --api-version "1.0.0" --revision 1 --calls 10 --interval HOUR --soft --soft-value 40
$ ssd (api-management | apim) add api-interceptor rate-limit --api-name "Open Banking" --api-version "1.0.0" --revision 1 --calls 10 --interval HOUR --soft --soft-value 40

# Seleciona a opção "Quota Header"
$ ssd (api-management | apim) add api-interceptor rate-limit --api-name "Open Banking" --api-version "1.0.0" --revision 1 --calls 10 --quota-header
$ ssd (api-management | apim) add api-interceptor rate-limit --api-name "Open Banking" --api-version "1.0.0" --revision 1 --calls 10 --quota-header

# Adiciona um interceptor "Rate Limit" de forma interativa
$ ssd (api-management | apim) add api-interceptor rate-limit
$ ssd (api-management | apim) add plan-interceptor rate-limit

Flags disponíveis

As flags que podem ser usadas com o comando $ ssd (api-management | apim) add (plan | api)-interceptor rate-limit são as seguintes:

Flag

Tipo

Descrição

Flags para as APIs

-n, --api-name

string

Nome da API à qual o interceptor será adicionado

-s, --revision

string

Revisão da API à qual o interceptor será adicionado

-v, --api-version

string

Versão da API à qual o interceptor será adicionado

Flags para os planos

-n, --plan-name

string

Nome do plano ao qual o interceptor será adicionado

Outras flags

--calls

int

Número total de chamadas aceitas

-f, --flow

string

Fluxo da API ou do plano ao qual o interceptor será adicionado (INBOUND ou OUTBOUND)

-h, --help

Exibe a ajuda para o comando

-i, --interval

string

Intervalo de tempo a ser considerado. Opções disponíveis: "SECOND", "MINUTE", "HOUR", "DAY", "MONTH"

--quota-header

Instrui o gateway a inserir um parâmetro de header informando o número de chamadas restantes

--soft

Seleciona a opção de "Soft Limit"

--soft-value

int

Especifica um percentual adicional de chamadas permitidas

-m, --method

string

Método (operação) ao qual o interceptor será adicionado (Opcional). Ex.: POST

-a, --path

string

Caminho da operação à qual o interceptor será adicionado (Opcional). Ex.: /users

-p, --position

int

Posição do interceptor no fluxo da API ou do plano

-r, --resource

string

Nome do recurso ao qual o interceptor será adicionado (Opcional)

Flags globais

Flag Tipo Descrição

-c, --config

string

Arquivo de configuração (predefinido: $HOME/.sensedia/config.json)

--profile

string

Perfil de configuração que deseja utilizar (predefinido: "default")

--verbose

Lista todas as requisições feitas pelo comando. É possível armazenar essas informações em um arquivo TXT em vez de exibi-las no terminal. Ex.: $ ssd (api-management | apim) list apis --verbose 2> log.txt
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]