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

하나의 API 키 가져오기

이 페이지의 내용

  • Resource
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 응답 요소
  • 요청 예시
  • 응답 예시
  • 응답 헤더
  • 응답 본문

기본 URL: https://cloud.mongodb.com/api/public/v1.0

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}
이름
유형
설명
ORG-ID
문자열
API 키를 조회하려는 조직 의 고유 식별자입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 조회합니다.
API-KEY-ID
문자열
조회하려는 API 키 의 고유 식별자입니다. 인증된 사용자가 액세스할 수 있는 지정된 조직의 모든API 키를 검색하도록 /orgs/{ORG-ID}/apiKeys 엔드포인트를 요청합니다.

다음 쿼리 매개변수는 선택 사항입니다.

이름
유형
설명
기본값
pageNum
integer
페이지 번호(1-인덱스 기준)입니다.
1
itemsPerPage
integer
페이지당 반환할 항목 수. 최대 500개까지 가능합니다.
100
pretty
부울
응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타냅니다. 형식.
false
envelope
부울

응답을 엔벨로프에 래핑할지 여부를 나타냅니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 "envelope" : true 을(를) 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름
설명
status
HTTP 응답 코드
content
예상되는 응답 본문

결과 목록을 반환하는 엔드포인트의 경우 results 객체는 엔벨로프입니다. Cloud Manager가 status 필드를 응답 본문에 추가합니다.

none

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

쿼리 요소 envelopetrue 로 설정하면 응답이 content 객체에 의해 래핑됩니다.

HTTP 응답은 다음 객체를 포함하는 JSON document를 반환합니다.

이름
유형
설명
id
문자열
API 키의 고유 식별자
links
문자열
하나 이상의 하위 리소스 및/또는 관련 리소스(예:목록 페이지 매김 )에 대한 링크 를 나타내는 문서 배열입니다. 자세한 내용은 연결 을 참조하세요.
desc
문자열
API 키에 대한 설명
privateKey
문자열
API 키에 대해 수정된 비공개 키
publicKey
문자열
API 키의 공개 키
roles
객체 배열
API 키의 역할
roles.{ENTITY-ID}
문자열
{ENTITY-ID} 는 이 역할이 적용되는 조직 또는 프로젝트를 나타냅니다. 가능한 값은 orgId 또는 groupId 입니다.
roles.roleName
문자열

역할의 이름입니다. users 리소스는 사용자가 MongoDB Atlas 또는 Cloud Manager에서 가지고 있는 모든 역할을 반환합니다. 가능한 값은 다음과 같습니다.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--include \
--request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?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}
{
"desc" : "Test Docs Service User",
"id" : "5c47503880eef5662e1cce8d",
"links" : [ {
"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d98229d82e3f6/apiKeys/5c47503880eef5662e1cce8d",
"rel" : "self"
} ],
"privateKey" : "********-****-****-db2c132ca78d",
"publicKey" : "ewmaqvdo",
"roles" : [ {
"orgId" : "5980cfc70b6d97029d82e3f6",
"roleName" : "ORG_MEMBER"
}, {
"groupId" : "{PROJECT-ID}",
"roleName" : "GROUP_READ_ONLY"
}, {
"groupId" : "{PROJECT-ID}",
"roleName" : "GROUP_OWNER"
} ]
}

돌아가기

모든 API 키 가져오기