Versione dell'API Grid Management
Suggerisci modifiche
PDF
L'API Grid Management utilizza il controllo delle versioni per supportare aggiornamenti senza interruzioni.
Ad esempio, questo URL di richiesta specifica la versione 3 dell'API.
https://hostname_or_ip_address/api/v3/authorize
La versione principale dell'API di gestione tenant viene bloccata quando vengono apportate modifiche non compatibili con le versioni precedenti. La versione minore dell'API di gestione tenant viene ridotta 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 di gestione griglia. 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.
|
È possibile utilizzare l'API Grid Management per configurare le versioni supportate. Per ulteriori informazioni, consultare la sezione “config” della documentazione dell'API Swagger. Disattivare il supporto per la versione precedente dopo aver aggiornato tutti i client API Grid Management 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 v1 API at POST "/api/v1/authorize"
Determinazione delle versioni API supportate nella release corrente
Utilizzare la seguente richiesta API per restituire un elenco delle versioni principali dell'API supportate:
GET https://{{IP-Address}}/api/versions
{
"responseTime": "2019-01-10T20:41:00.845Z",
"status": "success",
"apiVersion": "3.0",
"data": [
2,
3
]
}
Specifica di una versione API per una richiesta
È possibile specificare la versione dell'API utilizzando un parametro path (/api/v3) o un'intestazione (Api-Version: 3). Se si forniscono entrambi i valori, il valore dell'intestazione sovrascrive il valore del percorso.
curl https://[IP-Address]/api/v3/grid/accounts curl -H "Api-Version: 3" https://[IP-Address]/api/grid/accounts