Docs 菜单
Docs 主页
/
MongoDB Cloud Manager
/
API
/
Cloud Manager Administration API 资源
/
编程 API 密钥。
/
项目上的组织 API 密钥

获取分配给一个项目的所有组织 API 密钥

在此页面上

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

基本 URL： https://cloud.mongodb.com/api/public/v 1.0

Resource

GET /groups/{PROJECT-ID}/apiKeys

请求路径参数

名称
类型
说明
PROJECT-ID
字符串
您要从中检索分配的组织 API密钥的项目的唯一标识符。 使用/groups端点检索经过身份验证的用户有权访问的所有项目。

请求查询参数

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

名称
类型
说明
默认
pageNum
整型
页码（从 1 开始）。
1
itemsPerPage
整型
每页要返回的项目数，最多 500 个。
100
pretty
布尔
false
envelope
布尔

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

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

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

名称
说明
status
HTTP 响应代码
content
预期响应正文

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

无

请求正文参数

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

响应

响应文档

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

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

results 嵌入式文档

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

名称
类型
说明
desc
字符串
分配给该项目的组织API密钥的描述。
id
字符串
分配给此项目的此组织API密钥的唯一标识符。
privateKey
字符串

分配给此项目的此组织API密钥的已编辑私钥。

该密钥在首次创建时显示为未编辑。

publicKey
字符串
分配给此项目的此组织API密钥的公钥。
roles
对象数组
此组织API密钥分配给此项目的角色。 此数组返回用户在 Cloud Manager 中拥有的所有组织和项目角色。
roles.groupId
字符串
此角色所属项目的唯一标识符。
roles.orgId
字符串
此角色所属组织的唯一标识符。
roles.roleName
字符串

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

组织角色

如果这是一个roles.orgId （组织），则值包括：

API 中的角色价值
角色
ORG_OWNER
ORG_MEMBER
ORG_GROUP_CREATOR
ORG_BILLING_ADMIN
ORG_READ_ONLY
ORG_BILLING_READ_ONLY

项目角色

如果这是一个roles.groupId （项目），则值包括：

API 中的角色价值
角色
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_BILLING_ADMIN
项目计费管理员
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE
GROUP_MONITORING_ADMIN
GROUP_OWNER
GROUP_READ_ONLY
GROUP_USER_ADMIN

请求示例

注意

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

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --include \
4     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-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}

响应体

1{
2  "links" : [ {
3    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4    "rel" : "self"
5  } ],
6  "results" : [ {
7    "desc" : "Updated API Key description for DOCSP-6042",
8    "id" : "5d1cf1f980eef570c9fc87e5",
9    "links" : [ {
10      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1cf1f980eef570c9fc87e5",
11      "rel" : "self"
12    } ],
13    "privateKey" : "********-****-****-9d4ae38e4ddd",
14    "publicKey" : "{PUBLIC-KEY}",
15    "roles" : [ {
16      "groupId" : "{PROJECT-ID}",
17      "roleName" : "GROUP_AUTOMATION_ADMIN"
18    }, {
19      "groupId" : "{PROJECT-ID}",
20      "roleName" : "GROUP_MONITORING_ADMIN"
21    }, {
22      "orgId" : "5980cfe20b6d97029d82fa63",
23      "roleName" : "ORG_MEMBER"
24    }, {
25      "orgId" : "5980cfe20b6d97029d82fa63",
26      "roleName" : "ORG_BILLING_ADMIN"
27    }, {
28      "groupId" : "{PROJECT-ID}",
29      "roleName" : "GROUP_DATA_ACCESS_ADMIN"
30    }, {
31      "groupId" : "{PROJECT-ID}",
32      "roleName" : "GROUP_USER_ADMIN"
33    }, {
34      "groupId" : "{PROJECT-ID}",
35      "roleName" : "GROUP_READ_ONLY"
36    }, {
37      "groupId" : "{PROJECT-ID}",
38      "roleName" : "GROUP_OWNER"
39    }, {
40      "orgId" : "5980cfe20b6d97029d82fa63",
41      "roleName" : "ORG_OWNER"
42    }, {
43      "groupId" : "{PROJECT-ID}",
44      "roleName" : "GROUP_DATA_ACCESS_READ_WRITE"
45    }, {
46      "orgId" : "5980cfe20b6d97029d82fa63",
47      "roleName" : "ORG_GROUP_CREATOR"
48    }, {
49      "orgId" : "5980cfe20b6d97029d82fa63",
50      "roleName" : "ORG_READ_ONLY"
51    }, {
52      "groupId" : "{PROJECT-ID}",
53      "roleName" : "GROUP_DATA_ACCESS_READ_ONLY"
54    }, {
55      "groupId" : "{PROJECT-ID}",
56      "roleName" : "GROUP_BACKUP_ADMIN"
57    }, {
58      "groupId" : "{PROJECT-ID}",
59      "roleName" : "GROUP_CLUSTER_MANAGER"
60    } ]
61  }, {
62    "desc" : "New API key for test purposes",
63    "id" : "5d1d12c087d9d63e6d682438",
64    "links" : [ {
65      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfe20b6d97029d82fa63/apiKeys/5d1d12c087d9d63e6d682438",
66      "rel" : "self"
67    } ],
68    "privateKey" : "********-****-****-cb34f12aafdb",
69    "publicKey" : "oxhzytwb",
70    "roles" : [ {
71      "groupId" : "{PROJECT-ID}",
72      "roleName" : "GROUP_READ_ONLY"
73    }, {
74      "orgId" : "5980cfe20b6d97029d82fa63",
75      "roleName" : "ORG_MEMBER"
76    }, {
77      "orgId" : "5980cfe20b6d97029d82fa63",
78      "roleName" : "ORG_BILLING_ADMIN"
79    } ]
80  } ],
81  "totalCount" : 2
82}

后退

项目上的组织 API 密钥

来年

创建一个组织 API 密钥并将其分配给一个项目