Skip to main content
La versione in lingua italiana fornita proviene da una traduzione automatica. Per eventuali incoerenze, fare riferimento alla versione in lingua inglese.

Versionamento dell'API di gestione degli inquilini

PDF

L'API di gestione tenant utilizza il controllo delle versioni per supportare aggiornamenti senza interruzioni.

Ad esempio, questo URL di richiesta specifica la versione 4 dell'API.

https://hostname_or_ip_address/api/v4/authorize

La versione principale dell'API viene aggiornata quando vengono apportate modifiche che non sono compatibili con le versioni precedenti. La versione secondaria dell'API viene aggiornata quando vengono apportate modifiche compatibili con le versioni precedenti. Le modifiche compatibili includono l'aggiunta di nuovi endpoint o nuove proprietà.

L'esempio seguente illustra come la versione dell'API viene aumentata in base al tipo di modifiche apportate.

Tipo di modifica all'API Vecchia versione Nuova versione

Compatibile con le versioni precedenti

2,1

2,2

Non compatibile con le versioni precedenti

2,1

3,0

Quando si installa il software StorageGRID per la prima volta, viene abilitata solo la versione più recente dell'API. Tuttavia, quando si esegue l'aggiornamento a una nuova versione delle funzionalità di StorageGRID, si continua ad avere accesso alla versione API precedente per almeno una versione delle funzionalità StorageGRID .

Nota È possibile configurare le versioni supportate. Consultare la sezione config della documentazione dell'API Swagger per"API di gestione della griglia" per maggiori informazioni. Dopo aver aggiornato tutti i client API per utilizzare la versione più recente, è necessario disattivare il supporto per la versione precedente.

Le richieste obsolete vengono contrassegnate come obsolete nei seguenti modi:

  • L'intestazione della risposta è "Obsoleto: vero"

  • Il corpo della risposta JSON include "deprecated": true

  • Un avviso obsoleto è stato aggiunto a nms.log. Per esempio:

    Received call to deprecated v2 API at POST "/api/v2/authorize"

Determina quali versioni API sono supportate nella versione corrente

Utilizzare il GET /versions Richiesta API per restituire un elenco delle principali versioni API supportate. Questa richiesta si trova nella sezione config della documentazione dell'API Swagger.

GET https://{{IP-Address}}/api/versions
{
  "responseTime": "2023-06-27T22:13:50.750Z",
  "status": "success",
  "apiVersion": "4.0",
  "data": [
    2,
    3,
    4
  ]
}

Specificare una versione API per una richiesta

È possibile specificare la versione API utilizzando un parametro di percorso(/api/v4 ) o un'intestazione(Api-Version: 4 ). Se si specificano entrambi i valori, il valore dell'intestazione sovrascrive il valore del percorso.

curl https://[IP-Address]/api/v4/grid/accounts

curl -H "Api-Version: 4" https://[IP-Address]/api/grid/accounts