删除一个全局 API 密钥
MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。 尽快升级到更高的MongoDB Ops Manager版本。
使用密钥的唯一标识符从 Ops Manager 中删除一个全球 API密钥。
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
DELETE /admin/apiKeys/{API-KEY-ID}
所需角色
要求调用此端点的API密钥具有 Global Owner角色。
请求参数
请求路径参数
所有请求路径参数均为必填项。
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 要删除的API密钥的唯一标识符。 使用/admin/apiKeys端点检索经过身份验证的用户有权访问的所有API密钥。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 |
| ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
|
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
此端点没有响应元素。
请求示例
1 curl --user "{USERNAME}:{APIKEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request DELETE "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true"
响应示例
响应标头
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
204 No Content 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}
响应体
此端点不返回响应正文。