Link Search Menu Expand Document Documentation Menu
文档

执行升级 API

1.0 版引入

升级执行 API 允许您升级安全插件的配置组件。此 API 通常在通过升级检查 API识别出必要的升级后使用。它会更新您的配置组件，以确保与当前版本的安全插件兼容。

端点

POST /_plugins/_security/api/_upgrade_perform

请求正文字段

请求体是可选的。它是一个包含以下字段的 JSON 对象。

属性 数据类型 描述
config 字符串数组 要升级的特定配置组件列表。如果省略，所有需要升级的组件都将被处理。有效值包括 roles、rolesmapping、actiongroups、config、internalusers 和 tenants。

请求示例

以下示例请求仅对 roles 和 config 组件执行升级。

POST /_plugins/_security/api/_upgrade_perform
{
  "config": ["roles", "config"]
}

要升级所有需要升级的组件，您可以省略请求体。

示例响应

响应包含哪些组件被升级以及所做的具体更改的信息。

{
  "status": "OK",
  "upgrades": {
    "roles": [
      "Added permissions for dashboard features to admin role",
      "Updated cluster monitor permissions"
    ],
    "config": [
      "Updated authentication configuration",
      "Added new security settings"
    ]
  }
}

如果没有组件需要升级，您将收到类似以下的响应。

{
  "status": "OK",
  "upgrades": {}
}

响应正文字段

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

属性 数据类型 描述
status 字符串 升级操作的状态。成功操作返回“OK”。
upgrades 对象 执行升级的详细分类。每个键表示一个已升级的配置组件，并附带一个字符串描述数组，详细说明所做的具体更改。

使用注意事项

使用此 API 时请考虑以下重要事项

  • 在执行升级之前，我们建议首先运行升级检查 API 以识别哪些组件需要升级。
  • 在执行升级之前，请务必备份您的安全配置。
  • 您必须拥有管理员权限才能使用此 API。
  • 此 API 会对您的配置进行实际更改，这与仅识别所需更改的升级检查 API 不同。
  • 对于生产环境中的集群，请考虑首先在预演环境中测试升级过程。
  • 执行升级后，请验证您的安全设置是否仍按预期工作。
剩余 350 字符

有问题？。

想贡献力量？或。