网格管理 API 版本控制

网格管理 API 使用版本控制来支持无中断升级。

例如,此请求 URL 指定 API 版本 3 。

https://hostname_or_ip_address/api/v3/authorize

网格管理 API 向后不兼容的更改会影响 API 的主要版本。例如,不兼容的 API 更改会将版本从 2.1 更改为 3.0 。网格管理 API 而在中进行的向后兼容更改会影响次要版本。向后兼容的更改包括添加新端点或新属性。例如,兼容的 API 更改会将版本从 3.0 更改为 3.1 。

StorageGRID 首次安装 StorageGRID 软件时,仅 网格管理 API 会启用的最新版本。但是,在升级到 StorageGRIDStorageGRID 时,您仍可以访问至少一个 StorageGRID 功能版本的旧版 API 。

注: 您可以使用 网格管理 API 配置受支持的版本。有关详细信息,请参见 Swagger API 文档中的 "config" 一节。在更新所有 网格管理 API 客户端以使用较新版本后,您应停用对较旧版本的支持。
已过时的请求将通过以下方式标记为已弃用:

确定当前版本支持哪些 API 版本

请使用以下 API 请求返回受支持的 API 主要版本列表:
获取 https://{{IP-Address}}/api/versions
{
  "ResponseTime" : "2019-01-1020 : 41 : 00.845Z" ,
  "status": "success",
  "apiVersion" : "3.0" ,
  " 数据 " :
    2,
    3
  ]
}

为请求指定 API 版本

您可以使用路径参数(/api/v3)或标题(Api-Version: 3)指定 API 版本。如果同时提供这两个值,则标头值将覆盖路径值。

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

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