1개의 프로젝트에 대해 모든 에이전트 API 키 가져오기
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/agentapikeys
이 엔드포인트는 Project Read Only 역할 이 있는 사용자로 제한됩니다.
요청 경로 매개변수
이름 | 유형 | 설명 |
|---|---|---|
프로젝트 ID | 문자열 | 에이전트 API 키를 소유한 프로젝트 의 고유 식별자입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
이름 | 유형 | 설명 |
|---|---|---|
id | 문자열 | 이 에이전트 API 키의 고유 식별자입니다. |
키 | 문자열 | 에이전트 API 키. 이 에이전트 API 키를 생성한 후 후속 요청은 에이전트 API 키의 마지막 4자를 반환합니다. |
desc | 문자열 | 이 에이전트 API 키의 레이블입니다. 1,000자로 제한됩니다. |
createdTime | 문자열 | ISO 8601 의 타임스탬프 에이전트 API 키가 생성된 시점의 UTC 날짜 및 시간 형식입니다. |
createdUserId | 문자열 | 이 에이전트 API 키를 생성한 사용자의 고유 식별자입니다. |
createdIpAddr | 문자열 | 이 에이전트 API 키를 생성한 IP 주소입니다. |
createdBy | 문자열 | 이 에이전트 API 키의 소스입니다. 허용되는 값은 다음과 같습니다.
|
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?pretty=true"
응답 예시
응답 헤더
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}
응답 본문
[ { "_id" : "{AGENT-API-KEY-ID-1}", "createdBy" : "PUBLIC_API", "createdIpAddr" : "{IP-ADDRESS-1}", "createdTime" : 1520458807291, "createdUserId" : "{USER-ID-1}", "desc" : "Agent API Key for this project", "key" : "****************************8b87" }, { "_id" : "{AGENT-API-KEY-ID-2}", "createdBy" : "PROVISIONING", "createdTime" : 1508871142864, "desc" : "Generated by Provisioning", "key" : "****************************39fe" }, { "_id" : "{AGENT-API-KEY-ID-3}", "createdBy" : "USER", "createdIpAddr" : "{IP-ADDRESS-2}", "createdTime" : 1507067499083, "createdUserId" : "{USER-ID-2}", "desc" : "Initial API Key", "key" : "****************************70d7" } ]