了解租户管理API
建议更改
PDF
您可以使用租户管理 REST API 执行系统管理任务，而不是使用租户管理器用户界面。例如，您可能希望使用 API 来自动执行操作或更快地创建多个实体，例如用户。
租户管理API使用Swagger开源API平台。Swagger 提供了一个直观的用户界面，支持开发人员和非开发人员与 API 进行交互。Swagger 用户界面提供了每个 API 操作的完整详细信息和文档。
要访问租户管理 API 的 Swagger 文档，请执行以下操作：
-
登录到租户管理器。
-
从租户管理器标题中选择*帮助*>* API文档*。
API 操作
租户管理 API 将可用的 API 操作组织到以下部分中：
-
* 帐户 * - 对当前租户帐户执行的操作，包括获取存储使用情况信息。
-
* 身份验证 * —执行用户会话身份验证的操作。
租户管理 API 支持不承载令牌身份验证方案。对于租户登录、您可以在身份验证请求的JSON正文中提供用户名、密码和帐户ID (即、
POST /api/v3/authorize）。如果用户已成功通过身份验证，则会返回一个安全令牌。此令牌必须在后续 API 请求的标题中提供（ " 授权：承载令牌 " ）。有关提高身份验证安全性的信息，请参见 "`防止跨站点请求伪造` " 。
如果为 StorageGRID 系统启用了单点登录（ SSO ），则必须执行不同的步骤进行身份验证。请参见管理StorageGRID 的说明中的"如果启用了单点登录、请参见`对API进行身份验证`"。 -
config —与租户管理 API 的产品版本和版本相关的操作。您可以列出该版本支持的产品版本和主要 API 版本。
-
* 容器 * —对 S3 存储分段或 Swift 容器执行的操作如下：
协议 权限允许 S3
-
创建合规和不合规的存储分段
-
修改原有合规性设置
-
为对对象执行的操作设置一致性控制
-
创建、更新和删除存储分段的CORS配置
-
启用和禁用对象的上次访问时间更新
-
管理平台服务的配置设置、包括CloudMirror复制、通知和搜索集成(元数据通知)
-
正在删除空存储分段
Swift
设置用于容器的一致性级别
-
-
"*deactived-features * - 用于查看可能已停用的功能的操作 " 。
-
* 端点 * —用于管理端点的操作。通过端点， S3 存储分段可以使用外部服务进行 StorageGRID CloudMirror 复制，通知或搜索集成。
-
* 组 * —用于管理本地租户组和从外部身份源检索联合租户组的操作。
-
identity-source —用于配置外部身份源以及手动同步联合组和用户信息的操作。
-
* 区域 * - 用于确定已为 StorageGRID 系统配置哪些区域的操作。
-
* S3 * —用于管理租户用户 S3 访问密钥的操作。
-
* s3-object-lock*—用于确定如何为StorageGRID 系统配置全局S3对象锁定(合规性)的操作。
-
* 用户 * —用于查看和管理租户用户的操作。
操作详细信息
展开每个 API 操作时，您可以看到其 HTTP 操作，端点 URL ，任何必需或可选参数的列表，请求正文示例（如果需要）以及可能的响应。
发出API请求
|
使用 API 文档网页执行的任何 API 操作均为实时操作。请注意，不要错误地创建，更新或删除配置数据或其他数据。 |
-
单击HTTP操作可查看请求详细信息。
-
确定此请求是否需要其他参数，例如组或用户 ID 。然后，获取这些值。您可能需要先对其他 API 请求进行问题描述 处理，以获取所需的信息。
-
确定是否需要修改示例请求正文。如果是、您可以单击*型号*来了解每个字段的要求。
-
单击 * 试用 * 。
-
提供所需的任何参数，或根据需要修改请求正文。
-
单击 * 执行 * 。
-
查看响应代码以确定请求是否成功。