In questa pagina viene descritto come configurare le quote per l'API. A un livello generale, i passaggi necessari sono:
- Aggiungere le informazioni relative alla quota al file di configurazione dell'API gRPC.
- Distribuire il file di configurazione dell'API gRPC.
- Esegui il deployment di Extensible Service Proxy (ESP).
Per una panoramica delle funzionalità fornite dalle quote, consulta Informazioni sulle quote.
Prerequisiti
Per iniziare, questa pagina presuppone che tu abbia:
- Cloud Endpoints configurato.
- Esegui il deployment della configurazione di Endpoints.
- Esegui il deployment del backend dell'API.
- Hai configurato l'API in modo che utilizzi una chiave API. Questo è necessario per consentire a Endpoints di identificare il progetto Google Cloud a cui è associata l'applicazione chiamante. Per ulteriori informazioni, consulta Condivisione di API protette da chiave API.
Aggiunta di una quota al file di configurazione dell'API gRPC
La seguente procedura descrive l'aggiunta delle impostazioni richieste al file di configurazione dell'API gRPC per configurare le quote. Per semplicità, questa pagina fa riferimento al file di configurazione dell'API gRPC come file api_config.yaml
.
Aggiungi le seguenti tre sezioni al file api_config.yaml
:
metrics
: una metrica denominata che conteggia le richieste alla tua API. Fornisci un nome che descriva il contatore. Il nome potrebbe essere una categoria, ad esempioread-requests
owrite-requests
. In alternativa, se stai definendo una quota per un metodo specifico, potresti includere il nome del metodo, ad esempioecho-api/echo_requests
.quota.limits
: rappresenta un singolo limite applicabile a una metrica denominata. Qui puoi configurare il numero consentito di richieste per una metrica che hai definito. Al momento sono supportati solo i limiti al minuto e per progetto.quota.metric_rules
: un metodo di mappaturametric_rule
alle metriche (molti a molti). Una richiesta a un metodo alloca un contatore per ciascuna delle metriche mappate. Quando associ un metodo a una metrica, devi sempre specificare un costo per la richiesta. Puoi configurare il costo di ogni metodo in modo indipendente. Ciò consente di utilizzare metodi diversi per il consumo a tariffe diverse dalla stessa metrica denominata. Se non hai un requisito di quota complesso, puoi configurare il costo di ogni metrica su 1.
Per configurare le quote nell'API:
- Apri il file
api_config.yaml
del progetto in un editor di testo. Aggiungi il campo
metrics
al livello superiore del file (non rientrato o nidificato), dopo il campoapis
.`metrics: - name: "YOUR_METRIC_NAME" display_name: "YOUR_METRIC_DISPLAY_NAME" value_type: INT64 metric_kind: DELTA`
- Sostituisci
YOUR_METRIC_NAME
con un nome che descriva il contatore delle richieste API. - Sostituisci
YOUR_METRIC_DISPLAY_NAME
con il testo visualizzato nella pagina Endpoint > Servizi > Quote per identificare la metrica. - Il campo
value_type
deve essereINT64
. - Il campo
metric_kind
deve essereDELTA
.
- Sostituisci
Aggiungi un campo
quota
allo stesso livello dimetrics
e un campolimits
nidificato nella sezionequota
.quota: limits: - name: "YOUR_LIMIT_NAME" metric: "YOUR_METRIC_NAME" unit: "1/min/{project}" values: STANDARD: VALUE_FOR_THE_LIMIT
- Sostituisci
YOUR_LIMIT_NAME
con un nome che descriva il limite. - Sostituisci
YOUR_METRIC_NAME
con unmetric.name
definito in precedenza. - Il campo
unit
deve essere"1/min/{project}"
. Questo è l'identificatore per il limite al minuto per progetto. - Il campo
values
deve contenereSTANDARD
. - Sostituisci
VALUE_FOR_THE_LIMIT
con un valore intero. Numero di richieste che un'applicazione associata a un progetto Google Cloud di un consumer può effettuare in un minuto.
- Sostituisci
Facoltativamente, definisci metriche e limiti aggiuntivi per ogni metrica.
Aggiungi una riga
metric_rules
rientrata sottoquota
, dopo la sezionelimits
. Nella sezionemetric_rules
, associa una metrica definita in precedenza a un metodo, nel seguente modo:metric_rules: - metric_costs: YOUR_METRIC_NAME: YOUR_METRIC_COST selector: [METHODS]
- Sostituisci
YOUR_METRIC_NAME
con unmetric.name
definito in precedenza. - Sostituisci
YOUR_METRIC_COST
con un numero intero. Per ogni richiesta, il contatore delle richieste per la metrica viene incrementato del numero specificato per il costo. Per il campo
selector
, puoi specificare una delle seguenti opzioni:- Per associare tutti i metodi in tutte le API all'utilizzo di
metric_cost
, utilizzaselector: "*"
- Per associare tutti i metodi all'interno di un'API all'utilizzo di
metric_cost
, utilizzaselector: YOUR_API_NAME.*
- Per associare un metodo specifico all'interno di un'API a
metric_cost
utilizzaselector: YOUR_API_NAME.YOUR_METHOD_NAME
- Per associare tutti i metodi in tutte le API all'utilizzo di
- Sostituisci
Salva il file
api_config.yaml
.
Esempi di configurazione delle quote
I tre esempi seguenti mostrano come configurare le quote per l'API.
Il seguente esempio mostra come configurare il campo metric
:
metrics: # Define a metric for read requests. - name: "read-requests" display_name: "Read requests" value_type: INT64 metric_kind: DELTA`
L'esempio seguente mostra come configurare i campi quota
e limits
all'interno della sezione quota
:
metrics: # Define a metric for read requests. - name: "read-requests" display_name: "Read requests" value_type: INT64 metric_kind: DELTA quota: limits: # Define the limit or the read-requests metric. - name: "read-limit" metric: "read-requests" unit: "1/min/{project}" values: STANDARD: 1000
Il seguente esempio mostra come configurare la riga metrics
dopo la sezione
limits
:
metrics:
# Define a metric for read requests.
- name: "read-requests"
display_name: "Read requests"
value_type: INT64
metric_kind: DELTA
quota:
limits:
# Define the limit or the read-requests metric.
- name: "read-limit"
metric: "read-requests"
unit: "1/min/{project}"
values:
STANDARD: 1000
metric_rules:
- metric_costs:
"read-requests": 1
selector: *
Deployment del file api_config.yaml
e di ESP
Affinché la quota abbia effetto, dovrai:
- Esegui il deployment del file
api_config.yaml
in Service Management, che aggiorna la configurazione in Endpoints. Per la procedura dettagliata, vedi Eseguire il deployment della configurazione di Endpoints. - Esegui il deployment di ESP. Per la procedura dettagliata, vedi Deployment del backend API.