Skip to main content
本产品推出了新版本。
简体中文版经机器翻译而成，仅供参考。如与英语版出现任何冲突，应以英语版为准。

网格管理 API 版本控制

贡献者
PDF

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

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

https://hostname_or_ip_address/api/v3/authorize

如果对旧版本进行了 * 不兼容 _* 的更改，则租户管理 API 的主要版本将发生递增。如果对 * 与旧版本兼容 _* 进行了更改，则租户管理 API 的次要版本将发生递增。兼容的更改包括添加新端点或新属性。以下示例说明了如何根据所做更改的类型对 API 版本进行递增。

API 的更改类型 旧版本 新版本

与旧版本兼容

2.1

2.2

与旧版本不兼容

2.1

3.0

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

备注 您可以使用网格管理 API 配置受支持的版本。有关详细信息，请参见 Swagger API 文档中的 "`config` " 一节。在更新所有网格管理 API 客户端以使用较新版本后，您应停用对较旧版本的支持。

已过时的请求将通过以下方式标记为已弃用：

  • 响应标头为 "depression: true"

  • JSON 响应正文包含 "depressioned" ： true

  • NMS.log 中会添加一个已弃用的警告。例如：

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

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

请使用以下 API 请求返回受支持的 API 主要版本列表：

GET https://{{IP-Address}}/api/versions
{
  "responseTime": "2019-01-10T20:41:00.845Z",
  "status": "success",
  "apiVersion": "3.0",
  "data": [
    2,
    3
  ]
}

为请求指定API版本

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

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

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