站点管理 REST API 参考

您可以使用站点管理 REST API 在“站点管理”中访问和使用 ALM 数据。ALM 站点管理 REST API 参考为站点管理基于 REST 的 API 提供了完整的联机参考。

24.1 中的新增功能

以下 REST API 现在可用于创建和管理 API 密钥:

  • GET /qcbin/v2/sa/api/api-keys/{id}。通过 ID 获取 API 密钥。

  • GET /qcbin/v2/sa/api/api-keys。获取所有 API 密钥。

  • GET /qcbin/v2/sa/api/user-profile/api-keys。获取您自己的 API 密钥。

  • POST /qcbin/v2/sa/api/api-keys。创建 API 密钥。

  • PUT /qcbin/v2/sa/api/api-keys/{ID}。更新 API 密钥。

  • DELETE /qcbin/v2/sa/api/api-keys{id}。删除 API 密钥。

  • DELETE /qcbin/v2/sa/api/api-keys。批量删除 API 密钥。

  • POST /qcbin/v2/sa/api/api-keys/{id}/regenerate。重新生成 API 密钥

  • POST /qcbin/v2/sa/api/api-keys/{id}/revoke。撤销 API 密钥。

  • POST /qcbin/v2/sa/api/api-keys/revoke bulk。批量撤销 API 密钥。

返回页首

访问 SA REST API 文档

站点管理 REST API 文档嵌入在产品中。

要访问站点管理 REST API 文档，请执行以下操作:

  1. 在 ALM qcbin 页面 (http://<ALM 服务器>:<端口号>/qcbin/) 中，单击“工具”链接。

  2. 在 ALM 工具页面的底部，单击“ALM 站点管理 REST API 指南”链接。

    此文档包含 URL 以 qcbin/v2/sa/api 开头的所有 REST API。

返回页首

仅限 SaaS 的 API

具有“仅限 SaaS”标记的 API 仅适用于 ALM SaaS。您不能将这些 API 用于本地环境。

对于本地环境，可以使用所有不带此标记的 API。

返回页首

权限

每个 API 的“权限”部分解释了调用该 API 所需的权限。

我们建议您在调用 API 之前阅读“权限”部分。

返回页首