1개의 조직 API 키에 대해 액세스 목록 항목 만들기

이 페이지의 내용

Resource

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

Cloud Manager는 2024년 8월 30일부터 더 이상 MongoDB 3.6 및 4.0에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다. MongoDB 배포를 업그레이드하거나 Atlas로 마이그레이션하세요.

Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.: 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

지정된 API 키에 대해 하나 이상의 새 액세스 목록 항목을 생성합니다.

Resource

POST /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList

요청 경로 매개변수

이름	유형	설명
`ORG-ID`	문자열	대상 API 키가 속한 조직 의 고유 식별자입니다. /orgs 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 조직을 조회합니다.
`API-KEY-ID`	문자열	새 액세스 목록 항목을 생성하려는 조직 API 키의 고유 식별자입니다.

요청 쿼리 매개변수

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

이름

유형

설명

기본값

pageNum

integer

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

1

itemsPerPage

integer

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

100

pretty

부울

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

false

envelope

부울

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

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

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

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

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

none

요청 본문 매개변수

각 문서는 프로젝트에 추가하려는 하나의 액세스 목록 항목을 나타내는 문서 배열을 지정합니다. 단일 액세스 목록 항목만 프로젝트에 연결하는 경우에도 배열을 지정해야 합니다.

액세스 목록에 아직 없는 ipAddress 또는 cidrBlock 값이 포함된 POST 요청 을 제출 하면 Cloud Manager 가 액세스 목록의 기존 항목 목록에 해당 항목을 추가합니다. Cloud Manager 는 요청 에 지정된 항목만 포함하도록 액세스 목록을 설정하다 하지 않습니다.

참고

Cloud Manager는 단일 조직 내에서 최대 500 개의 API 키를 지원합니다.

다음 표에서 [i] 배열 인덱스를 나타냅니다.

이름	유형	설명
`[i].ipAddress`	문자열	API 키에 대한 액세스 목록에 추가할 IP 주소입니다. 이 필드는 `cidrBlock` 필드와 상호 배타적입니다.
`[i].cidrBlock`	문자열	API 키에 추가될 CIDR 표기법의 액세스 목록 항목입니다. 이 필드는 `ipAddress` 필드와 상호 배타적입니다.

응답

응답 문서

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

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

`results` embeddedDocument

results 배열 내의 각 객체는 하나의 액세스 목록 항목입니다.

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

요청 예시

1 curl --user '{USER-ID}:{API-KEY}' --digest \
2      --header 'Accept: application/json' \
3      --header 'Content-Type: application/json' \
4      --include \
5      --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true" \
6      --data '
7        [{
8          "ipAddress" : "77.54.32.11"
9        }]'

응답 예시

응답 헤더

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://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100",
4     "rel" : "self"
5   } ],
6   "results" : [ {
7     "cidrBlock" : "206.252.195.126/32",
8     "count" : 47,
9     "created" : "2019-01-24T16:26:37Z",
10     "ipAddress" : "206.252.195.126",
11     "lastUsed" : "2019-01-25T16:32:47Z",
12     "lastUsedAddress" : "206.252.195.126",
13     "links" : [ {
14       "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126",
15       "rel" : "self"
16     } ]
17   }, {
18     "cidrBlock" : "76.54.32.11/32",
19     "count" : 0,
20     "created" : "2019-01-24T21:09:05Z",
21     "ipAddress" : null,
22     "links" : [ {
23      "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/76.54.32.11",
24       "rel" : "self"
25     } ]
26   } ],
27   "totalCount" : 2
28 }

돌아가기

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

API 키에 대해 하나의 액세스 목록 항목 삭제

1	curl --user '{USER-ID}:{API-KEY}' --digest \
2	--header 'Accept: application/json' \
3	--header 'Content-Type: application/json' \
4	--include \
5	--request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true" \
6	--data '
7	[{
8	"ipAddress" : "77.54.32.11"
9	}]'

1	{
2	"links" : [ {
3	"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100",
4	"rel" : "self"
5	} ],
6	"results" : [ {
7	"cidrBlock" : "206.252.195.126/32",
8	"count" : 47,
9	"created" : "2019-01-24T16:26:37Z",
10	"ipAddress" : "206.252.195.126",
11	"lastUsed" : "2019-01-25T16:32:47Z",
12	"lastUsedAddress" : "206.252.195.126",
13	"links" : [ {
14	"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126",
15	"rel" : "self"
16	} ]
17	}, {
18	"cidrBlock" : "76.54.32.11/32",
19	"count" : 0,
20	"created" : "2019-01-24T21:09:05Z",
21	"ipAddress" : null,
22	"links" : [ {
23	"href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/76.54.32.11",
24	"rel" : "self"
25	} ]
26	} ],
27	"totalCount" : 2
28	}