모든 글로벌 API 키 가져오기

이 페이지의 내용

Resource

필수 역할
요청 매개변수
요청 경로 매개변수
요청 쿼리 매개변수
응답
응답 문서
results embeddedDocument
요청 예시
응답 예시
응답 헤더
응답 본문

Ops Manager에 대한 모든 글로벌 API 키를 반환합니다.

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

Resource

GET /admin/apiKeys

필수 역할

이 엔드포인트를 호출하는 API 키에 Global Read Only 역할 이 있어야 합니다.

요청 매개변수

요청 경로 매개변수

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

요청 쿼리 매개변수

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

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

응답

응답 문서

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

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

`results` embeddedDocument

각 결과 는 하나의 API 키입니다.

이름

유형

설명

desc

문자열

이 글로벌 API 키에 대한 설명입니다.

id

문자열

이 글로벌 API 키의 고유 식별자입니다.

links

문자열

하나 이상의 하위 리소스 및/또는 관련 리소스(예:목록 페이지 매김 )에 대한 링크 를 나타내는 문서 배열입니다. 자세한 내용은 연결 을 참조하세요.

privateKey

문자열

이 글로벌 API 키에 대한 비공개 키가 수정되었습니다.

publicKey

문자열

이 글로벌 API 키의 공개 키입니다.

roles

객체 배열

이 글로벌 API 키가 갖는 역할입니다. 이 배열은 사용자가 Ops Manager에서 가지고 있는 모든 전역 역할을 반환합니다.

roles.roleName

문자열

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

API의 역할 값	역할
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

요청 예시

참고

요청 하는 사용자는 {PUBLIC-KEY}:{PRIVATE-KEY} 중 하나로 형식을 지정할 수 있습니다.

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/admin/apiKeys?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/admin/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4     "rel" : "self"
5   } ],
6   "results" : [ {
7     "desc" : "Test Global API Key 1",
8     "id" : "5d669ce780eef52a42cf0e1e",
9     "links" : [ {
10       "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e",
11       "rel" : "self"
12     } ],
13     "privateKey" : "********-****-****-54d9792d337d",
14     "publicKey" : "zrefxaep",
15     "roles" : [ {
16       "roleName" : "GLOBAL_READ_ONLY"
17     }, {
18       "roleName" : "GLOBAL_BILLING_ADMIN"
19     } ]
20   }, {
21     "desc" : "Test Global API Key 2",
22     "id" : "5d6fec4180eef54728814b14",
23     "links" : [ {
24       "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fec4180eef54728814b14",
25       "rel" : "self"
26     } ],
27     "privateKey" : "********-****-****-fe646723a586",
28     "publicKey" : "qlgofmne",
29     "roles" : [ {
30       "roleName" : "GLOBAL_READ_ONLY"
31     } ]
32   }, {
33     "desc" : "Test Global API Key 3",
34     "id" : "5d6fecfc80eef547288207f3",
35     "links" : [ {
36       "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fecfc80eef547288207f3",
37       "rel" : "self"
38     } ],
39     "privateKey" : "********-****-****-fe348ed1796f",
40     "publicKey" : "cfswjfck",
41     "roles" : [ {
42       "roleName" : "GLOBAL_READ_ONLY"
43     }, {
44       "roleName" : "GLOBAL_BILLING_ADMIN"
45     }, {
46       "roleName" : "GLOBAL_USER_ADMIN"
47     } ]
48   } ],
49   "totalCount" : 3
50 }

돌아가기

글로벌 프로그래밍 방식 API 키

글로벌 API 키에 대한 모든 역할 가져오기

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/admin/apiKeys?pretty=true"

1	{
2	"links" : [ {
3	"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys?pretty=true&pageNum=1&itemsPerPage=100",
4	"rel" : "self"
5	} ],
6	"results" : [ {
7	"desc" : "Test Global API Key 1",
8	"id" : "5d669ce780eef52a42cf0e1e",
9	"links" : [ {
10	"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d669ce780eef52a42cf0e1e",
11	"rel" : "self"
12	} ],
13	"privateKey" : "******--**-54d9792d337d",
14	"publicKey" : "zrefxaep",
15	"roles" : [ {
16	"roleName" : "GLOBAL_READ_ONLY"
17	}, {
18	"roleName" : "GLOBAL_BILLING_ADMIN"
19	} ]
20	}, {
21	"desc" : "Test Global API Key 2",
22	"id" : "5d6fec4180eef54728814b14",
23	"links" : [ {
24	"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fec4180eef54728814b14",
25	"rel" : "self"
26	} ],
27	"privateKey" : "******--**-fe646723a586",
28	"publicKey" : "qlgofmne",
29	"roles" : [ {
30	"roleName" : "GLOBAL_READ_ONLY"
31	} ]
32	}, {
33	"desc" : "Test Global API Key 3",
34	"id" : "5d6fecfc80eef547288207f3",
35	"links" : [ {
36	"href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/null/apiKeys/5d6fecfc80eef547288207f3",
37	"rel" : "self"
38	} ],
39	"privateKey" : "******--**-fe348ed1796f",
40	"publicKey" : "cfswjfck",
41	"roles" : [ {
42	"roleName" : "GLOBAL_READ_ONLY"
43	}, {
44	"roleName" : "GLOBAL_BILLING_ADMIN"
45	}, {
46	"roleName" : "GLOBAL_USER_ADMIN"
47	} ]
48	} ],
49	"totalCount" : 3
50	}