Skip to main content
È disponibile una versione più recente di questo prodotto.
La versione in lingua italiana fornita proviene da una traduzione automatica. Per eventuali incoerenze, fare riferimento alla versione in lingua inglese.

Versioning dell'API Grid Management in StorageGRID

PDF

${post_edited_translations.segment}

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 non 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 incrementata in base al tipo di modifiche apportate.

${post_edited_translations.segment} Vecchia versione ${post_edited_translations.segment}

${post_edited_translations.segment}

2,1

2,2

Non compatibile con le versioni precedenti

2,1

3,0

Quando installi il software StorageGRID per la prima volta, viene abilitata solo la versione più recente dell'API. Tuttavia, quando esegui l'upgrade a una nuova release di funzionalità di StorageGRID, continui ad avere accesso alla versione precedente dell'API per almeno una release di funzionalità di StorageGRID.

Nota Puoi configurare le versioni supportate. Consulta la sezione config della documentazione dell'API Swagger per "API di gestione della griglia" ulteriori informazioni. Dovresti disattivare il supporto per la versione precedente dopo aver aggiornato tutti i client API alla versione più recente.

Le richieste obsolete sono contrassegnate come deprecate nei seguenti modi:

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

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

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

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

Determina quali versioni API sono supportate nella release corrente

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

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

Specifica una versione API per una richiesta

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

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

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