Docs Menu
Docs Home
/
MongoDB Cloud Manager
/ / / /

1๊ฐœ์˜ ํ”„๋กœ์ ํŠธ์— ํ• ๋‹น๋œ ๋ชจ๋“  ์กฐ์ง API ํ‚ค ๊ฐ€์ ธ์˜ค๊ธฐ

์ด ํŽ˜์ด์ง€์˜ ๋‚ด์šฉ

  • Resource
  • ์š”์ฒญ ๊ฒฝ๋กœ ๋งค๊ฐœ๋ณ€์ˆ˜
  • ์š”์ฒญ ์ฟผ๋ฆฌ ๋งค๊ฐœ๋ณ€์ˆ˜
  • ์š”์ฒญ ๋ณธ๋ฌธ ๋งค๊ฐœ๋ณ€์ˆ˜
  • ์‘๋‹ต
  • ์‘๋‹ต ๋ฌธ์„œ
  • results embeddedDocument
  • ์š”์ฒญ ์˜ˆ์‹œ
  • ์‘๋‹ต ์˜ˆ์‹œ
  • ์‘๋‹ต ํ—ค๋”
  • ์‘๋‹ต ๋ณธ๋ฌธ

๊ธฐ๋ณธ URL: https://cloud.mongodb.com/api/public/v1.0

GET /groups/{PROJECT-ID}/apiKeys
์ด๋ฆ„
์œ ํ˜•
์„ค๋ช…
PROJECT-ID
๋ฌธ์ž์—ด
ํ• ๋‹น๋œ ์กฐ์ง API ํ‚ค๋ฅผ ๊ฒ€์ƒ‰ํ•˜๋ ค๋Š” ํ”„๋กœ์ ํŠธ์˜ ๊ณ ์œ  ์‹๋ณ„์ž์ž…๋‹ˆ๋‹ค. /groups ์—”๋“œํฌ์ธํŠธ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์ธ์ฆ๋œ ์‚ฌ์šฉ์ž๊ฐ€ ์•ก์„ธ์Šคํ•  ์ˆ˜ ์žˆ๋Š” ๋ชจ๋“  ํ”„๋กœ์ ํŠธ๋ฅผ ๊ฒ€์ƒ‰ํ•ฉ๋‹ˆ๋‹ค.

๋‹ค์Œ ์ฟผ๋ฆฌ ๋งค๊ฐœ๋ณ€์ˆ˜๋Š” ์„ ํƒ ์‚ฌํ•ญ์ž…๋‹ˆ๋‹ค.

์ด๋ฆ„
์œ ํ˜•
์„ค๋ช…
๊ธฐ๋ณธ๊ฐ’
pageNum
integer
ํŽ˜์ด์ง€ ๋ฒˆํ˜ธ(1-์ธ๋ฑ์Šค ๊ธฐ์ค€)์ž…๋‹ˆ๋‹ค.
1
itemsPerPage
integer
ํŽ˜์ด์ง€๋‹น ๋ฐ˜ํ™˜ํ•  ํ•ญ๋ชฉ ์ˆ˜. ์ตœ๋Œ€ 500๊ฐœ๊นŒ์ง€ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.
100
pretty
๋ถ€์šธ
์‘๋‹ต ๋ณธ๋ฌธ์ด ํ”„๋ฆฌํ‹ฐํ”„๋ฆฐํŠธ ์— ์žˆ์–ด์•ผ ํ•˜๋Š”์ง€ ์—ฌ๋ถ€๋ฅผ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค. ํ˜•์‹.
false
envelope
๋ถ€์šธ

์‘๋‹ต์„ ์—”๋ฒจ๋กœํ”„์— ๋ž˜ํ•‘ํ• ์ง€ ์—ฌ๋ถ€๋ฅผ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค.

์ผ๋ถ€ API ํด๋ผ์ด์–ธํŠธ๋Š” HTTP ์‘๋‹ต ํ—ค๋” ๋˜๋Š” ์ƒํƒœ ์ฝ”๋“œ์— ์•ก์„ธ์Šคํ•  ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค. ์ด ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•˜๋ ค๋ฉด ์ฟผ๋ฆฌ์—์„œ "envelope" : true ์„(๋ฅผ) ์„ค์ •ํ•ฉ๋‹ˆ๋‹ค.

ํ•˜๋‚˜์˜ ๊ฒฐ๊ณผ๋ฅผ ๋ฐ˜ํ™˜ํ•˜๋Š” ์—”๋“œํฌ์ธํŠธ์˜ ๊ฒฝ์šฐ ์‘๋‹ต ๋ณธ๋ฌธ์—๋Š” ๋‹ค์Œ์ด ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.

์ด๋ฆ„
์„ค๋ช…
status
HTTP ์‘๋‹ต ์ฝ”๋“œ
content
์˜ˆ์ƒ๋˜๋Š” ์‘๋‹ต ๋ณธ๋ฌธ

๊ฒฐ๊ณผ ๋ชฉ๋ก์„ ๋ฐ˜ํ™˜ํ•˜๋Š” ์—”๋“œํฌ์ธํŠธ์˜ ๊ฒฝ์šฐ results ๊ฐ์ฒด๋Š” ์—”๋ฒจ๋กœํ”„์ž…๋‹ˆ๋‹ค. Cloud Manager๊ฐ€ status ํ•„๋“œ๋ฅผ ์‘๋‹ต ๋ณธ๋ฌธ์— ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.

none

์ด ์—”๋“œํฌ์ธํŠธ๋Š” HTTP ์š”์ฒญ ๋ณธ๋ฌธ ๋งค๊ฐœ๋ณ€์ˆ˜๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค.

์‘๋‹ต JSON ๋ฌธ์„œ์—๋Š” result ๊ฐ์ฒด ๋ฐฐ์—ด, link ๊ฐ์ฒด ๋ฐฐ์—ด, ์กฐํšŒ๋œ result ๊ฐ์ฒด์˜ ์ด ๊ฐœ์ˆ˜๊ฐ€ ํฌํ•จ๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค.

์ด๋ฆ„
์œ ํ˜•
์„ค๋ช…
results
๋ฐฐ์—ด
๋ฐฐ์—ด์—๋Š” results ๋‚ด์žฅ๋œ ๋ฌธ์„œ ์„น์…˜์— ์ž์„ธํžˆ ์„ค๋ช…๋œ ๊ฐ ํ•ญ๋ชฉ์— ๋Œ€ํ•ด ํ•˜๋‚˜์˜ ๊ฐ์ฒด๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.
links
๋ฐฐ์—ด
๋ฐฐ์—ด์— ํ•˜์œ„ ๋ฆฌ์†Œ์Šค ๋ฐ/๋˜๋Š” ๊ด€๋ จ ๋ฆฌ์†Œ์Šค์— ๋Œ€ํ•œ ๋งํฌ๊ฐ€ ํ•˜๋‚˜ ์ด์ƒ ํฌํ•จ๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค. URL๊ฐ„์˜ ๊ด€๊ณ„๋Š” ์›น ๋งํฌ ์‚ฌ์–‘์—์„ค๋ช…๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค.
totalCount
์ˆซ์ž
๊ฒฐ๊ณผ ์ง‘ํ•ฉ์— ์žˆ๋Š” ์ด ํ•ญ๋ชฉ ์ˆ˜์˜ ์ •์ˆ˜ ๊ฐœ์ˆ˜์ž…๋‹ˆ๋‹ค. ์ „์ฒด ๊ฒฐ๊ณผ ์ง‘ํ•ฉ์ด ํŽ˜์ด์ง€๋กœ ๋งค๊ฒจ์ง„ ๊ฒฝ์šฐ 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

ํ”„๋กœ์ ํŠธ ์—ญํ• 

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 ํ‚ค