모든 조직 가져오기
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /orgs
요청 매개변수
요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 설명 | 기본값 |
|---|---|---|---|
pageNum | integer | 페이지 번호(1 기준). | 1 |
itemsPerPage | integer | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. | 100 |
pretty | 부울 | false | |
envelope | 부울 | false | |
name | 문자열 | 지정된 조직 이름을 기준으로 결과를 필터링합니다. 지정된 예를 예시 | none |
includeDeletedOrgs | 부울 | 응답 본문에 삭제된 조직이 포함되어 있는지 여부를 나타내는 플래그입니다. Ops Manager는 요청한 사용자에게 전역 역할이 있는 경우에만 이 매개변수의 값을 따릅니다.
| true |
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열 및 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
|---|---|---|
results | 배열 | 배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다. |
links | 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
totalCount | 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results embeddedDocument
각 결과 는 하나의 조직입니다.
이름 | 유형 | 설명 |
|---|---|---|
id | 문자열 | 조직의 고유 식별자입니다. |
isDeleted | 부울 | 조직이 삭제되었는지 여부를 나타내는 플래그입니다. |
이름 | 문자열 | 조직의 이름입니다. |
링크 | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
요청 예시
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://{OPSMANAGER-HOST}/api/public/v1.0/orgs/"
응답 예시
응답 헤더
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
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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs", "rel" : "self" }], "results" : [{ "id" : "5a2add1cfd9f3cfb17053317", "isDeleted": false, "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/5a2add1cfd9f3cfb17053317", "rel": "self" }], "name" : "Internal Application Support" }, { "id" : "5a2add1cfd9f3cfb17053318", "isDeleted": false, "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/5a2add1cfd9f3cfb17053318", "rel": "self" }], "name" : "Customer Application Support" }, { "id" : "5a2add1cfd9f3cfb17053319", "isDeleted": false, "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/5a2add1cfd9f3cfb17053319", "rel": "self" }], "name" : "Research and Development" } ], "totalCount" : 3 }