Link Search Menu Expand Document Documentation Menu
文档

升级检查 API

1.0 版引入

升级检查 API 允许您检查您的安全插件配置是否需要任何升级。这在将 OpenSearch 升级到新版本后特别有用，因为它有助于识别任何需要更新以保持兼容性或利用新功能的安全配置组件。

端点

GET /_plugins/_security/api/_upgrade_check

请求示例

GET /_plugins/_security/api/_upgrade_check

示例响应

以下示例响应显示某些组件有可用升级：

{
  "status": "OK",
  "upgradeAvailable": true,
  "upgradeActions": {
    "roles": ["update_required"],
    "rolesmapping": [],
    "actiongroups": ["no_update_required"],
    "config": ["update_required"],
    "internalusers": ["no_update_required"],
    "tenants": []
  }
}

如果没有可用升级，响应将如下所示：

{
  "status": "OK",
  "upgradeAvailable": false,
  "upgradeActions": {}
}

响应正文字段

响应正文是一个包含以下字段的 JSON 对象。

属性 数据类型 描述
status 字符串 请求的状态。成功请求返回“OK”。
upgradeAvailable 布尔型 指示是否有任何配置组件需要升级。
upgradeActions 对象 详细列出哪些配置组件需要升级。该对象包含每种组件类型（roles、rolesmapping、actiongroups、config、internalusers、tenants）的数组，其中包含升级状态指示器。

使用注意事项

在 OpenSearch 升级过程中管理安全配置时，了解如何解释和根据升级检查 API 结果采取行动非常重要。以下说明提供了如何使用此 API 的指导：

  • 运行此 API 不会对您的配置进行任何更改；它只检查潜在的升级。
  • 使用此 API 识别必要的升级后，您可以使用相应的配置 API 来实现所需的更改。
  • 我们建议在每次 OpenSearch 版本升级后运行此检查。
  • 您可能需要管理员权限才能使用此 API。
剩余 350 字符

有问题？。

想贡献力量？ 或 。