Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

1개의 조직 가져오기

이 페이지의 내용

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

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{ORG-ID}
경로 요소
유형
설명
ORG-ID
문자열
(필수 사항) 정보를 조회 하려는 조직 의 고유 식별자입니다.

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

이름
유형
설명
기본값
pretty
부울
응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타내는 플래그입니다. 형식.
false
envelope
부울

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

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

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

이름
설명
status
HTTP 응답 코드
envelope
예상되는 응답 본문
false
includeDeletedOrgs
부울

응답 본문에 삭제된 조직이 포함되어 있는지 여부를 나타내는 플래그입니다.

Ops Manager는 요청한 사용자에게 전역 역할이 있는 경우에만 이 매개변수의 값을 따릅니다.

true 로 설정하거나 생략하면 전역 역할 이 할당된 사용자는 응답에서 삭제된 프로젝트를 수신합니다. false 로 설정하거나 사용자에게 전역 소유자 역할이 없는 경우 응답에 삭제된 조직이 포함되지 않습니다.

true

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

이름
유형
설명
id
문자열
조직의 고유 식별자입니다.
isDeleted
부울
조직이 삭제되었는지 여부를 나타내는 플래그입니다.
이름
문자열
조직의 이름입니다.
링크
객체 배열

하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 links 배열에는 self 이라는 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/"
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}
{
"id" : "{ORG-ID}",
"isDeleted": false,
"links": [{
}],
"name" : "Customer Application Support"
}

돌아가기

모든 조직 가져오기