현재 사용자에 대한 모든 프로젝트 가져오기

이 페이지의 내용

Resource

요청 매개변수
요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
응답 문서
results embeddedDocument
요청 예시
응답 예시

참고

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

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

Resource

GET /groups

요청 매개변수

요청 경로 매개변수

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

요청 쿼리 매개변수

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

이름	유형	필요성	설명	기본값
pageNum	숫자	옵션	결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.	`1`
itemsPerPage	숫자	옵션	페이지당 반환할 항목 수. 최대 500개까지 가능합니다.	`100`
pretty	부울	옵션	응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타내는 플래그입니다. 형식.	`false`
envelope	부울	옵션	응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 `envelope : true`를 설정합니다. 결과 목록을 반환하는 엔드포인트의 경우 `content` 객체는 엔벨로프입니다. Ops Manager가 응답 본문에 `status` 필드를 추가합니다.	`false`

요청 본문 매개변수

이 엔드포인트는 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지원 MongoDB Ops Manager 의 경우 LDAP 그룹 을 MongoDB Ops Manager 프로젝트 역할에 매핑합니다. LDAP 지원 MongoDB 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

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

요청 예시

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2  --header "Accept: application/json" \
3  --include \
4  --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups?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://<OpsManagerHost>:<Port>/api/public/v1.0/groups?pretty=true&pageNum=1&itemsPerPage=100",
4     "rel": "self"
5   }, {
6     "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups?pretty=true&itemsPerPage=100&pageNum=2",
7     "rel": "next"
8   }],
9   "results": [{
10     "activeAgentCount": 0,
11     "hostCounts": {
12       "arbiter": 0,
13       "config": 0,
14       "mongos": 0,
15       "primary": 0,
16       "secondary": 0
17     },
18     "id": "56a10a80e4b0fd3b9a9bb0c2",
19     "lastActiveAgent": "2016-03-09T18:19:37Z",
20     "links": [{
21       "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
22       "rel": "self"
23     }],
24     "name": "012i3091203jioawjioej",
25     "orgId": "5980cfdf0b6d97029d82f86e",
26     "publicApiEnabled": true,
27     "replicaSetCount": 0,
28     "shardCount": 0,
29     "tags": []
30   }, {
31     "activeAgentCount": 0,
32     "hostCounts": {
33       "arbiter": 0,
34       "config": 0,
35       "mongos": 0,
36       "primary": 0,
37       "secondary": 0
38     },
39     "id": "56aa691ce4b0a0e8c4be51f7",
40     "lastActiveAgent": "2016-01-29T19:02:56Z",
41     "links": [{
42       "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
43       "rel": "self"
44     }],
45     "name": "1454008603036",
46     "orgId": "5980d0040b6d97029d831798",
47     "publicApiEnabled": true,
48     "replicaSetCount": 0,
49     "shardCount": 0,
50     "tags": []
51   }, {
52     "activeAgentCount": 0,
53     "hostCounts": {
54       "arbiter": 0,
55       "config": 0,
56       "mongos": 0,
57       "primary": 0,
58       "secondary": 0
59     },
60     "id": "56aa6dfde4b0fe328eee82ad",
61     "lastActiveAgent": "2016-01-29T20:34:28Z",
62     "links": [{
63       "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
64       "rel": "self"
65     }],
66     "name": "1454009852809",
67     "orgId": "5980d0040b6d97029d831799",
68     "publicApiEnabled": true,
69     "replicaSetCount": 0,
70     "shardCount": 0,
71     "tags": []
72   }, {
73     "activeAgentCount": 0,
74     "hostCounts": {
75       "arbiter": 0,
76       "config": 0,
77       "mongos": 0,
78       "primary": 0,
79       "secondary": 0
80     },
81     "id": "56aa8421e4b0d04c1c54df99",
82     "lastActiveAgent": "2016-01-29T21:36:10Z",
83     "links": [{
84       "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
85       "rel": "self"
86     }],
87     "name": "1454015520776",
88     "orgId": "5980d0040b6d97029d83179a",
89     "publicApiEnabled": true,
90     "replicaSetCount": 0,
91     "shardCount": 0,
92     "tags": []
93   }, {
94     "activeAgentCount": 0,
95     "hostCounts": {
96       "arbiter": 0,
97       "config": 0,
98       "mongos": 0,
99       "primary": 0,
100       "secondary": 0
101     },
102     "id": "56aa85f9e4b0d04c1c54e347",
103     "lastActiveAgent": "2016-01-29T21:36:10Z",
104     "links": [{
105       "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
106       "rel": "self"
107     }],
108     "name": "1454015992252",
109     "orgId": "5980d0040b6d97029d83179b",
110     "publicApiEnabled": true,
111     "replicaSetCount": 0,
112     "shardCount": 0,
113     "tags": []
114   }],
115   "totalCount": 5
116 }

돌아가기

프로젝트

ID로 1개의 프로젝트 가져오기

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups?pretty=true"

1	{
2	"links": [{
3	"href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups?pretty=true&pageNum=1&itemsPerPage=100",
4	"rel": "self"
5	}, {
6	"href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups?pretty=true&itemsPerPage=100&pageNum=2",
7	"rel": "next"
8	}],
9	"results": [{
10	"activeAgentCount": 0,
11	"hostCounts": {
12	"arbiter": 0,
13	"config": 0,
14	"mongos": 0,
15	"primary": 0,
16	"secondary": 0
17	},
18	"id": "56a10a80e4b0fd3b9a9bb0c2",
19	"lastActiveAgent": "2016-03-09T18:19:37Z",
20	"links": [{
21	"href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
22	"rel": "self"
23	}],
24	"name": "012i3091203jioawjioej",
25	"orgId": "5980cfdf0b6d97029d82f86e",
26	"publicApiEnabled": true,
27	"replicaSetCount": 0,
28	"shardCount": 0,
29	"tags": []
30	}, {
31	"activeAgentCount": 0,
32	"hostCounts": {
33	"arbiter": 0,
34	"config": 0,
35	"mongos": 0,
36	"primary": 0,
37	"secondary": 0
38	},
39	"id": "56aa691ce4b0a0e8c4be51f7",
40	"lastActiveAgent": "2016-01-29T19:02:56Z",
41	"links": [{
42	"href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
43	"rel": "self"
44	}],
45	"name": "1454008603036",
46	"orgId": "5980d0040b6d97029d831798",
47	"publicApiEnabled": true,
48	"replicaSetCount": 0,
49	"shardCount": 0,
50	"tags": []
51	}, {
52	"activeAgentCount": 0,
53	"hostCounts": {
54	"arbiter": 0,
55	"config": 0,
56	"mongos": 0,
57	"primary": 0,
58	"secondary": 0
59	},
60	"id": "56aa6dfde4b0fe328eee82ad",
61	"lastActiveAgent": "2016-01-29T20:34:28Z",
62	"links": [{
63	"href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
64	"rel": "self"
65	}],
66	"name": "1454009852809",
67	"orgId": "5980d0040b6d97029d831799",
68	"publicApiEnabled": true,
69	"replicaSetCount": 0,
70	"shardCount": 0,
71	"tags": []
72	}, {
73	"activeAgentCount": 0,
74	"hostCounts": {
75	"arbiter": 0,
76	"config": 0,
77	"mongos": 0,
78	"primary": 0,
79	"secondary": 0
80	},
81	"id": "56aa8421e4b0d04c1c54df99",
82	"lastActiveAgent": "2016-01-29T21:36:10Z",
83	"links": [{
84	"href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
85	"rel": "self"
86	}],
87	"name": "1454015520776",
88	"orgId": "5980d0040b6d97029d83179a",
89	"publicApiEnabled": true,
90	"replicaSetCount": 0,
91	"shardCount": 0,
92	"tags": []
93	}, {
94	"activeAgentCount": 0,
95	"hostCounts": {
96	"arbiter": 0,
97	"config": 0,
98	"mongos": 0,
99	"primary": 0,
100	"secondary": 0
101	},
102	"id": "56aa85f9e4b0d04c1c54e347",
103	"lastActiveAgent": "2016-01-29T21:36:10Z",
104	"links": [{
105	"href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}",
106	"rel": "self"
107	}],
108	"name": "1454015992252",
109	"orgId": "5980d0040b6d97029d83179b",
110	"publicApiEnabled": true,
111	"replicaSetCount": 0,
112	"shardCount": 0,
113	"tags": []
114	}],
115	"totalCount": 5
116	}

참고

Resource

요청 매개변수

요청 경로 매개변수

요청 쿼리 매개변수

요청 본문 매개변수

응답

응답 문서

results embeddedDocument

요청 예시

응답 예시

응답 헤더

응답 본문

`results` embeddedDocument