Skip to main content
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

StorageGRID におけるグリッド管理 API のバージョン管理

PDF

グリッド管理APIは、バージョン管理を利用して、システムへの影響を最小限に抑えたアップグレードをサポートします。

例えば、このリクエスト URL は API のバージョン 4 を指定しています。

https://hostname_or_ip_address/api/v4/authorize

APIのメジャーバージョンは、古いバージョンと互換性のない変更が行われた場合、更新されます。APIのマイナーバージョンは、古いバージョンと互換性のある変更が行われた場合、更新されます。互換性のある変更には、新しいエンドポイントまたは新しいプロパティの追加が含まれます。

以下の例は、行われた変更の種類に基づいてAPIバージョンがどのように更新されるかを示しています。

APIに対する変更の種類 旧バージョン 新バージョン

旧バージョンとの互換性あり

2.1

2.2

旧バージョンとの互換性はありません

2.1

3.0

StorageGRID ソフトウェアを初めてインストールする場合、最新バージョンの API のみが有効になります。ただし、StorageGRID の新しい機能リリースにアップグレードした場合でも、少なくとも 1 つの StorageGRID 機能リリースの間は、古い API バージョンに引き続きアクセスできます。

メモ 対応バージョンを設定できます。詳細については、"グリッド管理API" の Swagger API ドキュメントの config セクションを参照してください。すべての API クライアントを新しいバージョンに更新した後、古いバージョンのサポートを無効にする必要があります。

古いリクエストは、以下の方法で非推奨としてマークされます。

  • レスポンスヘッダーは「Deprecated: true」です。

  • JSON レスポンスボディには「deprecated」：true が含まれています

  • 非推奨の警告がnms.logに追加されます。例：

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

現在のリリースでサポートされているAPIバージョンを確認する

`GET /versions`API リクエストを使用して、サポートされている API のメジャーバージョンのリストを返します。このリクエストは、Swagger API ドキュメントの *config* セクションに記載されています。
GET https://{{IP-Address}}/api/versions
{
  "responseTime": "2023-06-27T22:13:50.750Z",
  "status": "success",
  "apiVersion": "4.0",
  "data": [
    2,
    3,
    4
  ]
}

リクエストのAPIバージョンを指定します

パスパラメータ（(/api/v4）またはヘッダー（(Api-Version: 4）を使用して API バージョンを指定できます。両方の値を指定した場合、ヘッダーの値がパスの値を上書きします。

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

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