액세스 목록에 항목 추가
MongoDB Ops Manager v6.0 는 2025 1월에 EOL됩니다. 가능한 한 빨리 상위 MongoDB Ops Manager 버전으로 업그레이드하세요.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /users/{USER-ID}/accessList
요청 경로 매개변수
Parameter | 유형 | 설명 |
---|---|---|
USER-ID | 문자열 | (필수 사항) 현재 사용자의 고유 식별자입니다. 현재 사용자의 ID 를 조회 하려면 하나의 프로젝트에서 모든 사용자 가져오기를 참조하세요. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 |
---|---|---|---|---|
pageNum | 숫자 | 옵션 | 결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다. | 1 |
itemsPerPage | 숫자 | 옵션 | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. | 100 |
pretty | 부울 | 옵션 | false | |
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 결과 목록을 반환하는 엔드포인트의 경우 | false |
backupJobsEnabledOnly | 부울 | 옵션 | 데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다. | true |
요청 본문 매개변수
요청 본문은 액세스 목록 엔터티가 하나만 있는 경우에도 액세스 목록 엔터티의 배열이어야 합니다. 각 요청 객체에 대해 지정해야 하는 유일한 필드는 IP-ADDRESS 입니다.
IP 주소 가 이미 액세스 목록에 있는 경우 해당 주소는 무시됩니다.
/32
서브넷 마스크와 함께 단일 IP 주소 를 지정하는 경우 MongoDB Ops Manager 는 /32
을(를) 저장 하지 않습니다. /32
이(가) 주소 를 변경하지 않기 때문입니다.
예시
12.34.56.78
의 주소 는 12.34.56.78/32
과 동일합니다.
Parameter | 유형 | 설명 |
---|---|---|
ipAddress | 문자열 | (필수 사항) 지정된 사용자의 액세스 목록에 추가하려는 IP 주소 또는 CIDR 블록입니다. |
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
---|---|---|
results | 배열 | 배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다. |
links | 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
totalCount | 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results
embeddedDocument
각 결과 는 하나의 액세스 목록입니다.
이름 | 유형 | 설명 |
---|---|---|
cidrBlock | 문자열 | CIDR로 표기된 IP 주소 범위입니다. |
created | 날짜 | 이 IP 주소가 액세스 목록에 추가된 날짜입니다. |
ipAddress | 문자열 | 액세스 목록의 IP 주소입니다. |
lastUsed | 날짜 | 이 IP 주소에서 시작된 가장 최근 요청의 날짜입니다. 이 필드는 액세스 목록으로 보호되는 리소스에 액세스할 때만 업데이트됩니다. |
lastUsedAddress | 문자열 | API에 대한 마지막 호출이 실행된 주소입니다. |
count | 숫자 | 이 IP 주소에서 시작된 요청의 총 개수입니다. 이 필드는 액세스 목록으로 보호되는 리소스에 액세스할 때만 업데이트됩니다. |
links | 배열 | 관련 하위 리소스에 대한 링크입니다. 응답의 모든 링크 배열에는 self 이라는 링크가 하나 이상 포함되어 있습니다. URL 간의 관계는 웹 링크 사양에 설명되어 있습니다. |
요청 예시
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --include \ --request POST "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/users/{USER-ID}/accessList" --data ' [ { "ipAddress" : "192.0.1.15", "comment" : "IP address for Application Server A" }, { "cidrBlock" : "192.0.2.0/24", "comment" : "CIDR block for Application Server B - D" } ]'
응답 예시
응답 헤더
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
201 Created 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}
응답 본문
{ "totalCount" : 3, "results" : [ { "cidrBlock" : "12.34.56.78/32", "ipAddress" : "12.34.56.78", "created" : "2014-04-23T16:17:44Z", "lastUsed" : "2016-08-17T19:34:05Z", "lastUsedAddress" : "12.34.56.78", "count" : 0, "links" : [] }, { "cidrBlock" : "76.54.32.10/32", "ipAddress" : "76.54.32.10", "created" : "2016-08-17T19:34:05Z", "count" : 0, "links" : [] }, { "cidrBlock" : "2.3.4.5/32", "ipAddress" : "2.3.4.5", "created" : "2016-08-17T19:34:05Z", "count" : 0, "links" : [] } ], "links" : [] }