1개의 조직 API 키에 대해 1개의 액세스 목록 항목 가져오기

이 페이지의 내용

Resource

요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
응답 예시
응답 헤더
응답 본문

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

API 키의 고유 식별자와 원하는 IP 주소 를 사용하여 단일 API 키 액세스 목록 항목에대한 정보를 조회합니다.

Resource

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/{ACCESS-LIST-ENTRY}

요청 경로 매개변수

이름	유형	설명
`ORG-ID`	문자열	대상 API 키가 속한 조직 의 고유 식별자입니다. 인증된 사용자가 액세스할 수 있는 모든 조직을 조회하도록 /orgs 엔드포인트를 요청합니다.
`API-KEY-ID`	문자열	액세스 목록 항목을 검색하려는 API 키의 고유 식별자입니다. 인증된 사용자가 액세스할 수 있는 지정된 조직의 모든 API 키를 검색하도록 /orgs/{ORG-ID}/apiKeys 엔드포인트를 요청합니다.
`ACCESS-LIST-ENTRY`	문자열	IP 또는 CIDR 주소입니다. 항목에 서브넷 마스크(예: `192.0.2.0/24`)가 포함된 경우 슬래시 `/` 에 URL 인코딩 값 `%2F` 을 사용합니다.

요청 쿼리 매개변수

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

이름

유형

설명

기본값

pageNum

integer

페이지 번호(1-인덱스 기준)입니다.

1

itemsPerPage

integer

페이지당 반환할 항목 수. 최대 500개까지 가능합니다.

100

pretty

부울

응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타냅니다. 형식.

false

envelope

부울

응답을 엔벨로프에 래핑할지 여부를 나타냅니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 "envelope" : true 을(를) 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

결과 목록을 반환하는 엔드포인트의 경우 results 객체는 엔벨로프입니다. Ops Manager가 응답 본문에 status 필드를 추가합니다.

none

요청 본문 매개변수

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

응답

이름	유형	설명
`cidrBlock`	문자열	액세스 목록에 있는 CIDR로 표기된 IP 주소 범위입니다.
`count`	숫자	이 IP 주소에서 발생한 총 요청 수입니다.
`created`	날짜	이 IP 주소가 액세스 목록에 추가된 날짜입니다.
`ipAddress`	문자열	액세스 목록에 있는 IP 주소입니다.
`lastUsed`	날짜	이 IP 주소에서 시작된 가장 최근 요청의 날짜입니다. 이 필드는 이 IP 주소에서 하나 이상의 요청이 발생한 경우에만 표시되며 액세스 목록에서 리소스가 검색될 때만 업데이트됩니다.
`lastUsedAddress`	문자열	API에 대한 마지막 호출이 실행된 IP 주소입니다. 이 필드는 이 IP 주소에서 요청이 하나 이상 발생한 경우에만 표시됩니다.
`links`	배열	하나 이상의 하위 리소스 및/또는 관련 리소스(예:목록 페이지 매김 )에 대한 링크 를 나타내는 문서 배열입니다. 자세한 내용은 연결 을 참조하세요.

요청 예시

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2   --header "Accept: application/json" \
3   --header "Content-Type: application/json" \
4   --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24?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     "cidrBlock": "192.0.2.0/24",
3     "count": 0,
4     "created": "2019-11-01T14:32:57Z",
5     "links": [
6         {
7             "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24",
8             "rel": "self"
9         },
10         {
11             "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
12             "rel": "http://mms.mongodb.com/apiKeys"
13         }
14     ]
15 }

돌아가기

모든 항목 가져오기

항목 만들기

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24?pretty=true"

1	{
2	"cidrBlock": "192.0.2.0/24",
3	"count": 0,
4	"created": "2019-11-01T14:32:57Z",
5	"links": [
6	{
7	"href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24",
8	"rel": "self"
9	},
10	{
11	"href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
12	"rel": "http://mms.mongodb.com/apiKeys"
13	}
14	]
15	}