Definir quota de utilização por subscrição

  • Artigo

APLICA-SE A: Todas as camadas de gerenciamento de API

A quota política impõe um volume de chamadas renovável ou vitalício e/ou uma quota de largura de banda, por subscrição. Quando a cota é excedida, o chamador recebe um código de 403 Forbidden status de resposta e a resposta inclui um Retry-After cabeçalho cujo valor é o intervalo de repetição recomendado em segundos.

Para entender a diferença entre limites de taxa e cotas, consulte Limites de taxa e cotas.

Nota

Quando os recursos de computação subjacentes são reiniciados na plataforma de serviço, o Gerenciamento de API pode continuar a lidar com solicitações por um curto período após o atingimento de uma cota.

Nota

Defina os elementos da política e os elementos filho na ordem fornecida na declaração de política. Saiba mais sobre como definir ou editar políticas de Gerenciamento de API.

Declaração de política

<quota calls="number" bandwidth="kilobytes" renewal-period="seconds">
    <api name="API name" id="API id" calls="number">
        <operation name="operation name" id="operation id" calls="number" />
    </api>
</quota>

Atributos

Atributo Description Necessário Predefinição
bandwidth O número total máximo de kilobytes permitido durante o intervalo de tempo especificado no renewal-period. Expressões de política não são permitidas. Ou calls, bandwidth, ou ambos juntos devem ser especificados. N/A
Convocatórias O número total máximo de chamadas permitidas durante o intervalo de tempo especificado no renewal-period. Expressões de política não são permitidas. Ou calls, bandwidth, ou ambos juntos devem ser especificados. N/A
período de renovação O comprimento em segundos da janela fixa após a qual a cota é redefinida. O início de cada período é calculado em relação à hora de início da subscrição. Quando renewal-period é definido como 0, o período é definido como infinito. Expressões de política não são permitidas. Sim N/A

Elementos

Elemento Description Obrigatório
api Adicione um ou mais desses elementos para impor cota de chamada às APIs dentro do produto. As cotas de chamada de produto e API são aplicadas de forma independente. A API pode ser referenciada via name ou id. Se ambos os atributos forem fornecidos, id serão usados e name serão ignorados. Não
operation Adicione um ou mais desses elementos para impor cota de chamada em operações dentro de uma API. As cotas de chamada de produto, API e operação são aplicadas de forma independente. A operação pode ser referenciada via name ou id. Se ambos os atributos forem fornecidos, id serão usados e name serão ignorados. Não

Atributos da API

Atributo Description Necessário Predefinição
nome O nome da API para a qual aplicar o limite de cota de chamada. Ou name id deve ser especificado. N/A
id A ID da API para a qual aplicar o limite de cota de chamada. Ou name id deve ser especificado. N/A
bandwidth O número total máximo de kilobytes permitido durante o intervalo de tempo especificado no renewal-period. Expressões de política não são permitidas. Ou calls, bandwidth, ou ambos juntos devem ser especificados. N/A
Convocatórias O número total máximo de chamadas permitidas durante o intervalo de tempo especificado no renewal-period. Expressões de política não são permitidas. Ou calls, bandwidth, ou ambos juntos devem ser especificados. N/A
período de renovação O comprimento em segundos da janela fixa após a qual a cota é redefinida. O início de cada período é calculado em relação à hora de início da subscrição. Quando renewal-period é definido como 0, o período é definido como infinito. Expressões de política não são permitidas. Sim N/A

Atributos da operação

Atributo Description Necessário Predefinição
nome O nome da operação para a qual aplicar o limite de cota de chamada. Ou name id deve ser especificado. N/A
id A ID da operação para a qual aplicar o limite de cota de chamada. Ou name id deve ser especificado. N/A
bandwidth O número total máximo de kilobytes permitido durante o intervalo de tempo especificado no renewal-period. Expressões de política não são permitidas. Ou calls, bandwidth, ou ambos juntos devem ser especificados. N/A
Convocatórias O número total máximo de chamadas permitidas durante o intervalo de tempo especificado no renewal-period. Expressões de política não são permitidas. Ou calls, bandwidth, ou ambos juntos devem ser especificados. N/A
período de renovação O comprimento em segundos da janela fixa após a qual a cota é redefinida. O início de cada período é calculado em relação à hora de início da subscrição. Quando renewal-period é definido como 0, o período é definido como infinito. Expressões de política não são permitidas. Sim N/A

Utilização

Notas de utilização

  • Esta política só pode ser utilizada uma vez por definição de política.
  • Esta política só é aplicada quando uma API é acedida utilizando uma chave de subscrição.

Exemplo

<policies>
    <inbound>
        <base />
        <quota calls="10000" bandwidth="40000" renewal-period="3600" />
    </inbound>
    <outbound>
        <base />
    </outbound>
</policies>

Conteúdos relacionados

Para obter mais informações sobre como trabalhar com políticas, consulte: