Definir a cota de uso por assinatura

  • Artigo

APLICA-SE A: todas as camadas do Gerenciamento de API

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

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

Observação

Quando os recursos de computação subjacentes são reiniciados na plataforma de serviço, o Gerenciamento de API pode continuar lidando com solicitações por um curto período depois que uma cota é atingida.

Observação

Defina os elementos da política e os elementos filho na ordem fornecida na declaração da política. Saiba mais sobre como definir e editar as 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 Descrição Obrigatório Padrão
largura de banda O número total máximo de kilobytes permitidos durante o intervalo de tempo especificado no renewal-period. Expressões de política não são permitidas. calls ou bandwidth ou ainda ambos juntos devem ser especificados. N/D
chamadas 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. calls ou bandwidth ou ainda ambos juntos devem ser especificados. N/D
renewal-period 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 assinatura. Quando renewal-period é definido como 0, o período é definido como infinito. Expressões de política não são permitidas. Sim N/D

Elementos

Elemento Descrição Obrigatório
api Adicione um ou mais desses elementos para impor uma cota às APIs dentro do produto. Cotas de API e produto são aplicadas de forma independente. A API pode ser referenciada através de name ou id. Se ambos os atributos são fornecidos, id será usado e name será ignorado. No
operation Adicione um ou mais desses elementos para impor uma cota às operações dentro de uma API. Cotas de operações, APIs e produtos são aplicadas de forma independente. A operação pode ser referenciada através de name ou id. Se ambos os atributos são fornecidos, id será usado e name será ignorado. No

atributos da API

Atributo Descrição Obrigatório Padrão
name O nome da API para a qual aplicar o limite de cota de chamadas. É necessário especificar name ou id. N/D
id A ID da API para a qual aplicar o limite de cota da taxa. É necessário especificar name ou id. N/D
largura de banda O número total máximo de kilobytes permitidos durante o intervalo de tempo especificado no renewal-period. Expressões de política não são permitidas. calls ou bandwidth ou ainda ambos juntos devem ser especificados. N/D
chamadas 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. calls ou bandwidth ou ainda ambos juntos devem ser especificados. N/D
renewal-period 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 assinatura. Quando renewal-period é definido como 0, o período é definido como infinito. Expressões de política não são permitidas. Sim N/D

atributos de operação

Atributo Descrição Obrigatório Padrão
name O nome da operação para a qual aplicar o limite de cota de chamadas. É necessário especificar name ou id. N/D
id O nome da operação para a qual aplicar o limite de taxa. É necessário especificar name ou id. N/D
largura de banda O número total máximo de kilobytes permitidos durante o intervalo de tempo especificado no renewal-period. Expressões de política não são permitidas. calls ou bandwidth ou ainda ambos juntos devem ser especificados. N/D
chamadas 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. calls ou bandwidth ou ainda ambos juntos devem ser especificados. N/D
renewal-period 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 assinatura. Quando renewal-period é definido como 0, o período é definido como infinito. Expressões de política não são permitidas. Sim N/D

Uso

Observações de uso

  • Essa política pode ser usada apenas uma vez por cada definição de política.
  • Essa política só é aplicada quando uma API é acessada usando uma chave de assinatura.

Exemplo

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

Conteúdo relacionado

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