返回 Ops Manager 的所有全局API密钥。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /admin/apiKeys所需角色
要求调用此终结点的 API 密钥具有 Global Read Only 角色。
请求参数
请求路径参数
此端点不使用 HTTP 请求路径参数。
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数,用于返回结果的一部分。 |
|
itemsPerPage | 数字 | Optional | 每页要返回的项目数,最多 500 个。 |
|
pretty | 布尔 | Optional |
| |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 对于返回结果列表的端点, |
|
响应
响应文档
响应 JSON 文档包括 result 对象数组、link 对象数组和检索到的 result 对象的总数。
名称 | 类型 | 说明 |
|---|---|---|
| 阵列 | 数组为 |
| 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 |
| 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页,则它可能大于results数组中的对象数。 |
results 嵌入式文档
每个结果都是一个 API 密钥。
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 此全局API密钥的描述。 |
| 字符串 | 此全局API密钥的唯一标识符。 |
| 字符串 | |
| 字符串 | 此全局API密钥的已编辑私钥。 |
| 字符串 | 此全局API密钥的公钥。 |
| 对象数组 | 此全局API密钥具有的角色。 此数组返回用户在 Ops Manager 中拥有的所有全局角色。 |
| 字符串 | 角色名称。 此资源返回用户在 Ops Manager 中拥有的所有角色。可能的值为:
|
请求示例
注意
发出请求的用户可以采用{PUBLIC-KEY}:{PRIVATE-KEY}格式。
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true"响应示例
响应标头
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}响应体
{ "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "desc" : "Test Global API Key 1", "id" : "5d669ce780eef52a42cf0e1e", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e", "rel" : "self" } ], "privateKey" : "********-****-****-54d9792d337d", "publicKey" : "zrefxaep", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_BILLING_ADMIN" } ] }, { "desc" : "Test Global API Key 2", "id" : "5d6fec4180eef54728814b14", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fec4180eef54728814b14", "rel" : "self" } ], "privateKey" : "********-****-****-fe646723a586", "publicKey" : "qlgofmne", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" } ] }, { "desc" : "Test Global API Key 3", "id" : "5d6fecfc80eef547288207f3", "links" : [ { "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fecfc80eef547288207f3", "rel" : "self" } ], "privateKey" : "********-****-****-fe348ed1796f", "publicKey" : "cfswjfck", "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "roleName" : "GLOBAL_BILLING_ADMIN" }, { "roleName" : "GLOBAL_USER_ADMIN" } ] } ], "totalCount" : 3}