/ /

/ /

获取所有密钥保管库配置

检索所有密钥保管库的配置。

所需角色

您可以使用以下任何分配的角色成功调用此端点：

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin

Resource

GET /keyVault

请求路径参数

此端点不使用 HTTP 请求路径参数。

请求查询参数

名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用美观打印格式的标志。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点， `content`对象是一个信封。 Ops Manager 将`status`字段添加到响应正文。	`false`

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

响应文档

响应JSON文档包括一个 result对象数组、一个link对象数组以及检索到的result对象总数。

名称	类型	说明
`results`	阵列	数组为`results` 嵌入式文档部分中详细介绍的每一项包含一个对象。
`links`	阵列	数组包含一个或多个指向子资源和/或相关资源的链接。URL之间的关系在Web 链接规范中进行了解释。
`totalCount`	数字	结果集中项目总数的整数计数。如果对整个结果集进行分页，则它可能大于results数组中的对象数。

`results` 嵌入式文档

每个结果都是一个密钥保管库配置。

名称	类型	说明
id	字符串	Ops Manager为此 Key Vault 配置生成的唯一标识符。当您配置 S3 兼容存储快照存储以使用此密钥保管库时，请将此值用作 `vaultId`。
FriendlyName	字符串	标识此密钥保管库配置的人类可读标签。
类型	字符串	密钥保管库提供商类型。 Ops Manager返回 `HASHI_CORP`，它代表 HashiCorp Vault。
url	字符串	Ops Manager连接到的 HashiCorp Vault服务器的地址。
auth	对象	Ops Manager用于连接到 HashiCorp Vault 的身份验证详细信息。
auth. Mechanism	字符串	Ops Manager用于连接到 HashiCorp Vault 的身份验证方法。 Ops Manager返回以下值之一： `TOKEN` `JWT`
auth.secret	字符串	Ops Manager用于向 HashiCorp Vault 进行身份验证的档案。 Ops Manager会对该值进行静态加密并返回 `[REDACTED]` 而不是存储的值。
auth.jwtClaims	对象	Ops Manager从 HashiCorp Vault 请求 JWT 登录时发送的声明。 Ops Manager仅当`auth.mechanism` 为`JWT` 时才返回此对象。
customCertificates	阵列	Ops Manager在连接到 HashiCorp Vault服务器时用于 TLS 验证的自定义证书颁发机构证书列表。
customCertificates[n].filename	字符串	标识证书颁发机构PEM文件的名称。
customCertificates[n].certString	字符串	证书颁发机构 PEM文件的内容。 Ops Manager返回`[REDACTED]` 而不是存储的值。
链接	对象数组	指向子资源或相关资源的一个或多个链接。响应中的所有 `links` 数组至少包含一个名为 `self` 的链接。URL之间的关系在 Web 链接规范中进行了解释。

请求示例

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true'

响应示例

响应标头

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

{
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true&pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "id": "{KEY-VAULT-ID}",
      "friendlyName": "myVault",
      "type": "HASHI_CORP",
      "url": "https://localhost:8200/",
      "auth": {
        "mechanism": "TOKEN",
        "secret": "[REDACTED]"
      },
      "links": [
        {
          "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault/{KEY-VAULT-ID}",
          "rel": "self"
        }
      ]
    }
  ],
  "totalCount": 1
}

后退

通过ID获取

来年

创建

所需角色

Resource

请求路径参数

请求查询参数

请求正文参数

响应

响应文档

results 嵌入式文档

请求示例

响应示例

响应标头

响应体

`results` 嵌入式文档