Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API 资源
/
编程 API 密钥。
/
全局编程 API 密钥

获取所有全局 API 密钥

在此页面上

  • 资源
  • 所需角色
  • 请求参数
  • 请求路径参数
  • 请求查询参数
  • 响应
  • 响应文档
  • results 嵌入式文档
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

返回 Ops Manager 的所有全局 API密钥。

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

资源

GET /admin/apiKeys

所需角色

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

请求参数

请求路径参数

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

请求查询参数

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

名称
类型
必要性
说明
默认
pageNum
数字
Optional
从一开始的整数，用于返回结果的一部分。
1
itemsPerPage
数字
Optional
每页要返回的项目数，最多 500 个。
100
pretty
布尔
Optional
指示响应正文是否应采用 prettyprint 格式 的标志 格式。
false
envelope
布尔
Optional

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

某些API客户端无法访问HTTP响应标头或状态代码。 要修复此问题，请在查询中设置envelope : true 。

对于返回结果列表的端点， results对象是一个信封。 Ops Manager 将status字段添加到响应正文。

false
backupJobsEnabledOnly
布尔
Optional
指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为false以包含将backupJobsEnabled标志设置为false的守护进程配置。
true

响应

响应文档

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

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

results 嵌入式文档

每个结果都是一个 API 密钥。

名称
类型
说明
desc
字符串
此全局API密钥的描述。
id
字符串
此全局API密钥的唯一标识符。
links
字符串
文档数组，表示一个或多个子资源和/或相关资源（例如 列表分页 ）的 链接 。有关详细信息，请参阅链接。
privateKey
字符串
此全局API密钥的已编辑私钥。
publicKey
字符串
此全局API密钥的公钥。
roles
对象数组
此全局API密钥具有的角色。 此数组返回用户在 Ops Manager 中拥有的所有全局角色。
roles.roleName
字符串

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

API 中的角色价值
角色
GLOBAL_AUTOMATION_ADMIN
GLOBAL_BACKUP_ADMIN
GLOBAL_MONITORING_ADMIN
GLOBAL_OWNER
GLOBAL_READ_ONLY
GLOBAL_USER_ADMIN

请求示例

注意

发出请求的用户可以采用 {USERNAME}:{APIKEY} 或 {PUBLIC-KEY}:{PRIVATE-KEY} 格式。

1curl --user "{USERNAME}:{APIKEY}" --digest \
2     --header "Accept: application/json" \
3     --include \
4     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?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  "links" : [ {
3    "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4    "rel" : "self"
5  } ],
6  "results" : [ {
7    "desc" : "Test Global API Key 1",
8    "id" : "5d669ce780eef52a42cf0e1e",
9    "links" : [ {
10      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e",
11      "rel" : "self"
12    } ],
13    "privateKey" : "********-****-****-54d9792d337d",
14    "publicKey" : "zrefxaep",
15    "roles" : [ {
16      "roleName" : "GLOBAL_READ_ONLY"
17    }, {
18      "roleName" : "GLOBAL_BILLING_ADMIN"
19    } ]
20  }, {
21    "desc" : "Test Global API Key 2",
22    "id" : "5d6fec4180eef54728814b14",
23    "links" : [ {
24      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fec4180eef54728814b14",
25      "rel" : "self"
26    } ],
27    "privateKey" : "********-****-****-fe646723a586",
28    "publicKey" : "qlgofmne",
29    "roles" : [ {
30      "roleName" : "GLOBAL_READ_ONLY"
31    } ]
32  }, {
33    "desc" : "Test Global API Key 3",
34    "id" : "5d6fecfc80eef547288207f3",
35    "links" : [ {
36      "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fecfc80eef547288207f3",
37      "rel" : "self"
38    } ],
39    "privateKey" : "********-****-****-fe348ed1796f",
40    "publicKey" : "cfswjfck",
41    "roles" : [ {
42      "roleName" : "GLOBAL_READ_ONLY"
43    }, {
44      "roleName" : "GLOBAL_BILLING_ADMIN"
45    }, {
46      "roleName" : "GLOBAL_USER_ADMIN"
47    } ]
48  } ],
49  "totalCount" : 3
50}

后退

全局编程 API 密钥