/ /

/ /

현재 사용자에 대한 특정 태그가 있는 모든 프로젝트 가져오기

참고

그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

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

Resource

GET /groups

요청 매개변수

요청 경로 매개변수

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

요청 쿼리 매개변수

이름	유형	설명
tag	문자열	프로그래밍 방식으로 프로젝트를 식별하는 데 사용하기 위해 프로젝트에 할당된 태그입니다. 태그를 보려면 `Project Read Only` 역할 이 있어야 합니다. 태그를 생성 하거나 편집 하려면 `Project Automation Admin` 역할이 있어야 합니다.

요청 본문 매개변수

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

응답

응답 문서

응답 JSON 문서에는 result 객체 배열, link 객체 배열 및 조회된 result 객체의 총 개수가 포함되어 있습니다.

이름	유형	설명
`results`	배열	배열에는 내장된 `results` 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체 포함됩니다.
`links`	배열	배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에 설명되어 있습니다.
`totalCount`	숫자	결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

`results` embeddedDocument

각 결과 는 하나의 프로젝트입니다.

이름

유형

설명

activeAgentCount

integer

Ops Manager에 정기적으로 핑을 전송하는 활성 에이전트의 수입니다.

이 값은 약 24 시간마다 새로 고쳐지고 캐시됩니다. 새 에이전트를 시작하거나 기존 에이전트를 중지하는 경우 activeAgentCount 필드에 변경 사항이 표시되는 데 최대 30 분이 걸릴 수 있습니다.

hostCounts

객체

유형별 총 호스트 수입니다. 포함된 필드는 설명이 필요 없습니다.

문자열

프로젝트의 고유 식별자입니다.

lastActiveAgent

문자열

Ops Manager가 프로젝트의 총 activeAgentCount 를 마지막으로 업데이트한 시간입니다. Ops Manager는 24시간마다 이 값을 새로 고치고 캐시하여 활성 MongoDB 에이전트 수를 기록합니다.

ldapGroupMappings

객체 배열

LDAP 지원 Ops Manager의 경우 LDAP 그룹 을 Ops Manager 프로젝트 역할에 매핑합니다. LDAP 지원 Ops Manager에만 존재합니다.

ldapGroupMappings

.roleName

문자열

Ops Manager 사용자 역할입니다. roleName 에 대한 프로젝트 역할 의 매핑은 다음과 같습니다.

사용자 역할	`roleName` 값
`Project Owner` (필수)	`GROUP_OWNER`
`Project Automation Admin`	`GROUP_AUTOMATION_ADMIN`
`Project Backup Admin`	`GROUP_BACKUP_ADMIN`
`Project Monitoring Admin`	`GROUP_MONITORING_ADMIN`
`Project Data Access Admin`	`GROUP_DATA_ACCESS_ADMIN`
`Project Data Access Read/Write`	`GROUP_DATA_ACCESS_READ_WRITE`
`Project Data Access Read Only`	`GROUP_DATA_ACCESS_READ_ONLY`
`Project Read Only`	`GROUP_READ_ONLY`

ldapGroupMappings

.ldapGroups

문자열 배열

Ops Manager 역할에 매핑되는 LDAP 프로젝트입니다.

링크

객체 배열

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

이름

문자열

프로젝트의 표시 이름입니다.

orgId

문자열

프로젝트가 속한 조직의 고유 식별자입니다.

publicApiEnabled

부울

이 프로젝트에 대해 API 가 활성화되어 있음을 나타내는 플래그입니다. 이 필드는 항상 true 인 읽기 전용 필드입니다.

replicaSetCount

integer

이 프로젝트의 총 복제본 세트 수입니다.

shardCount

integer

이 프로젝트의 총 샤드 수입니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups?tag=ABC&tag=DEF&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   "results": [{
4       "id": "xxx",
5       "name": "My Project",
6       "orgId": "111111111cccccf38dc78bdf",
7       "hostCounts": {
8         "arbiter": 2,
9         "config": 1,
10         "primary": 4,
11         "secondary": 8,
12         "mongos": 2
13           },
14       "lastActiveAgent": "2016-08-05T07:23:34Z",
15       "activeAgentCount": 1,
16       "replicaSetCount": 3,
17       "shardCount": 2,
18       "publicApiEnabled": true,
19       "agentApiKey": "cbd728abd6a6d6c6b6d7826345dbcff0e",
20       "tags": ["ABC", "DEF"],
21       "ldapGroupMappings": [{
22         "roleName": "GROUP_OWNER",
23         "ldapGroups": [ "project-owner"]
24       }],
25       "links": []
26     }
27   ],
28   "totalCount": 1
29 }

돌아가기

팀 제거

사용자

1	{
2	"links": [],
3	"results": [{
4	"id": "xxx",
5	"name": "My Project",
6	"orgId": "111111111cccccf38dc78bdf",
7	"hostCounts": {
8	"arbiter": 2,
9	"config": 1,
10	"primary": 4,
11	"secondary": 8,
12	"mongos": 2
13	},
14	"lastActiveAgent": "2016-08-05T07:23:34Z",
15	"activeAgentCount": 1,
16	"replicaSetCount": 3,
17	"shardCount": 2,
18	"publicApiEnabled": true,
19	"agentApiKey": "cbd728abd6a6d6c6b6d7826345dbcff0e",
20	"tags": ["ABC", "DEF"],
21	"ldapGroupMappings": [{
22	"roleName": "GROUP_OWNER",
23	"ldapGroups": [ "project-owner"]
24	}],
25	"links": []
26	}
27	],
28	"totalCount": 1
29	}

참고

Resource

요청 매개변수

요청 경로 매개변수

요청 쿼리 매개변수

요청 본문 매개변수

응답

응답 문서

results embeddedDocument

요청 예시

응답 예시

응답 헤더

응답 본문

`results` embeddedDocument