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.

Versione dell'API di gestione tenant

Collaboratori
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 modificata quando vengono apportate modifiche che sono non compatibili con le versioni precedenti. La versione secondaria dell'API viene modificata quando vengono apportate modifiche che sono compatibili con le versioni precedenti. Le modifiche compatibili includono l'aggiunta di nuovi endpoint o di nuove proprietà.

Nell'esempio seguente viene illustrato il modo in cui la versione dell'API viene modificata in base al tipo di modifiche apportate.

Tipo di modifica all'API Versione precedente Nuova versione

Compatibile con le versioni precedenti

2,1

2,2

Non compatibile con versioni precedenti

2,1

3,0

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

Nota È possibile configurare le versioni supportate. Per ulteriori informazioni, vedere la sezione config della documentazione Swagger API"API di Grid Management". È necessario disattivare il supporto per la versione precedente dopo aver aggiornato tutti i client API per utilizzare la versione più recente.

Le richieste obsolete vengono contrassegnate come obsolete nei seguenti modi:

  • L'intestazione della risposta è "Deprecated: True"

  • Il corpo di risposta JSON include "deprecato": Vero

  • Viene aggiunto un avviso obsoleto a nms.log. Ad esempio:

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

Determinare quali versioni API sono supportate nella release corrente

Utilizzare la GET /versions richiesta API per restituire un elenco delle versioni principali dell'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 forniscono 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