获取一个全局 API 密钥

在此页面上

Resource

所需角色
请求参数
请求路径参数
请求查询参数
请求正文参数
响应
响应元素
请求示例
响应示例
响应标头
响应体

MongoDB Ops Manager v6.0 将于 2025 1 月 EOL。尽快升级到更高的MongoDB Ops Manager版本。

使用该密钥的唯一标识符返回 Ops Manager 的一个全局 API密钥。

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

Resource

GET /admin/apiKeys/{API-KEY-ID}

所需角色

要求调用此端点的API密钥具有 Global Read Only角色。

请求参数

请求路径参数

名称	类型	说明
`API-KEY-ID`	字符串	要检索的全局API密钥的唯一标识符。

请求查询参数

以下查询参数为可选参数：

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用 Prettyprint 的标志格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
状态	HTTP 响应代码
envelope	预期响应正文

false

请求正文参数

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

响应

响应元素

名称

类型

说明

desc

字符串

此全局API密钥的描述。

id

字符串

此全局API密钥的唯一标识符。

links

字符串

文档数组，表示一个或多个子资源和/或相关资源（例如列表分页）的链接。有关详细信息，请参阅链接。

privateKey

字符串

此全局API密钥的已编辑私钥。

publicKey

字符串

此全局API密钥的公钥。

roles

对象数组

此全局API密钥具有的角色。此数组返回用户在 Ops Manager 中拥有的所有全局角色。

roles.roleName

字符串

角色名称。此资源返回用户在 Ops Manager 中拥有的所有角色。可能的值为：

API 中的角色价值	角色
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

请求示例

1 curl --user "{USERNAME}:{APIKEY}" --digest \
2      --header "Accept: application/json" \
3      --include \
4      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?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}

响应体

1 {
2   "desc" : "Test Global API Key 1",
3   "id" : "{API-KEY-ID}",
4   "links" : [ {
5     "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY-ID}",
6     "rel" : "self"
7   } ],
8   "privateKey" : "********-****-****-54d9792d337d",
9   "publicKey" : "zrefxaep",
10   "roles" : [ {
11     "roleName" : "GLOBAL_READ_ONLY"
12   }, {
13     "roleName" : "GLOBAL_BILLING_ADMIN"
14   } ]
15 }

后退

获取所有角色

来年

创建

1	curl --user "{USERNAME}:{APIKEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true"

1	{
2	"desc" : "Test Global API Key 1",
3	"id" : "{API-KEY-ID}",
4	"links" : [ {
5	"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/{API-KEY-ID}",
6	"rel" : "self"
7	} ],
8	"privateKey" : "******--**-54d9792d337d",
9	"publicKey" : "zrefxaep",
10	"roles" : [ {
11	"roleName" : "GLOBAL_READ_ONLY"
12	}, {
13	"roleName" : "GLOBAL_BILLING_ADMIN"
14	} ]
15	}