Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/ / / /

获取所有 API 密钥

在此页面上

  • Resource
  • 请求路径参数
  • 请求查询参数
  • 响应
  • 响应文档
  • results 嵌入式文档
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

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

GET /orgs/{ORG-ID}/apiKeys
名称
类型
说明
ORG-ID
字符串
要检索其API密钥的组织的唯一标识符。 使用/orgs端点检索经过身份验证的用户有权访问权限的所有组织。

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

名称
类型
说明
默认
pageNum
整型
页码(从 1 开始)。
1
itemsPerPage
整型
每页要返回的项目数,最多 500 个。
100
pretty
布尔
指示响应正文是否应采用 prettyprint 格式。
false
envelope
布尔

指示是否要将响应封装在信封中。

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

对于返回一个结果的终结点,响应体包括:

状态
HTTP 响应代码
envelope
预期响应正文

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

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

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

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

名称
类型
说明
id
字符串
API 密钥的唯一标识符
desc
字符串
API 密钥的描述
privateKey
字符串
已编辑 API 密钥的私钥
publicKey
字符串
API 密钥的公钥
roles
对象数组
API 密钥具有的角色
roles.{ENTITY-ID}
字符串
{ENTITY-ID}代表此角色适用的组织或项目。 可能的值为: orgIdgroupId
roles.roleName
字符串

角色的名称。 users资源返回用户在 MongoDB Atlas 或 Ops Manager 中拥有的所有角色。 可能的值为:

  • 组织角色

    API 中的角色价值
    角色
    ORG_OWNER
    ORG_MEMBER
    ORG_GROUP_CREATOR
    ORG_READ_ONLY
  • 项目角色

    注意:群组和项目是同义词。

    • GROUP_OWNER

    • GROUP_READ_ONLY

    • GROUP_DATA_ACCESS_ADMIN

    • GROUP_DATA_ACCESS_READ_WRITE

    • GROUP_DATA_ACCESS_READ_ONLY

    • GROUP_AUTOMATION_ADMIN

    • GROUP_BACKUP_ADMIN

    • GROUP_MONITORING_ADMIN

    • GROUP_OWNER

    • GROUP_USER_ADMIN

注意

发出请求的用户可以采用 {USERNAME}:{APIKEY}{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/orgs/{ORG-ID}/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}
{
"links" : [ {
"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d97029d82e3f6/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
"rel" : "self"
} ],
"results" : [ {
"desc" : "Test Docs Service User",
"id" : "5c47503320eef5699e1cce8d",
"links" : [ {
"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/5980cfc70b6d98829d82e3f6/apiKeys/5c47503ae0eef5699e1cce8d",
"rel" : "self"
} ],
"privateKey" : "********-****-****-db2c132ca78d",
"publicKey" : "ewmaqvdo",
"roles" : [ {
"groupId" : "{PROJECT-ID}",
"roleName" : "GROUP_OWNER"
}, {
"groupId" : "{PROJECT-ID}",
"roleName" : "GROUP_READ_ONLY"
}, {
"orgId" : "5980cfc70b6d97029d82e3f6",
"roleName" : "ORG_MEMBER"
} ]
} ],
"totalCount" : 1
}

后退

组织程序化 API 密钥