1개의 프로젝트에 대한 기능 정책 업데이트

이 페이지의 내용

필수 역할

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

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

필수 역할

이 리소스에는 Project Owner 이(가) 필요합니다.

Resource

PUT /groups/{PROJECT-ID}/controlledFeature

중요

포함하고 유지 관리하려는 모든 정책을 포함해야 합니다. 이 리소스는 기존 정책을 덮어씁니다. 이 리소스를 사용할 때 정책을 생략하면 업데이트 후 해당 정책이 적용되지 않습니다. 해당 정책은 삭제되었습니다.

요청 경로 매개변수

이름	유형	필요성	설명
`PROJECT-ID`	문자열	필수 사항	제어된 기능이 있는 프로젝트의 고유 식별자입니다.

요청 쿼리 매개변수

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

이름

유형

설명

기본값

pageNum

integer

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

1

itemsPerPage

integer

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

100

pretty

부울

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

false

envelope

부울

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

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

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

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

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

none

요청 본문 매개변수

이름

유형

설명

externalManagementSystem

객체

이 Ops Manager 프로젝트를 managed하는 외부 시스템의 매개변수 식별.

externalManagementSystem

.name

문자열

이 Ops Manager 프로젝트를 managed하는 외부 시스템의 식별 레이블입니다.

externalManagementSystem

.systemId

문자열

이 Ops Manager 프로젝트를 managed하는 외부 시스템의 고유 식별자입니다.

externalManagementSystem

.version

문자열

이 Ops Manager 프로젝트를 managed하는 외부 시스템의 활성 릴리스입니다.

policies

배열

외부 시스템이 이 Ops Manager 프로젝트에 적용하는 정책 목록입니다.

policies

.policy[n]

객체

이 Ops Manager 프로젝트에 대해 설정된 단일 정책입니다. 이 매개변수는 policies 배열에서 한 번 이상 설정할 수 있습니다.

허용되는 값은 다음과 같습니다.

값	목적
`EXTERNALLY_MANAGED_LOCK`	사용자는 Ops Manager를 사용하여 `policies.policy[n]` 배열에 지정된 다른 설정을 managed할 수 없습니다. 동일한 사용자가 Kubernetes 연산자와 같이 구성된 외부 시스템을 사용하여 이러한 설정을 managed 할 수 있습니다.
`DISABLE_USER_MANAGEMENT`	사용자는 사용자나 역할을 managed 수 없습니다.
`DISABLE_AUTHENTICATION_` `MECHANISMS`	사용자는 인증 설정을 변경할 수 없습니다.
`DISABLE_SET_MONGOD_` `CONFIG`	사용자는 `policies[n].disabledParams` 배열에 나열된 `mongod` 설정을 변경할 수 없습니다.
`DISABLE_SET_MONGOD_` `VERSION`	사용자는 `mongod` 또는 `mongos` 의 버전을 변경할 수 없습니다.
`DISABLE_BACKUP_AGENT`	사용자는 백업 에이전트를 활성화하거나 비활성화할 수 없습니다.
`DISABLE_MONGOD_LOG_` `MANAGEMENT`	사용자는 로그 관리 설정을 변경할 수 없습니다.
`DISABLE_IMPORT_TO_` `AUTOMATION`	사용자는 자동화를 사용하여 배포를 managed 수 없습니다.
`DISABLE_AGENT_API_KEY_` `MANAGEMENT`	사용자는 에이전트 API 키를 생성하거나 업데이트할 수 없습니다.
`DISABLE_MONGOD_HOST_` `MANAGEMENT`	사용자는 호스트의 서버 유형을 변경할 수 없습니다.

policies[n]

.disabledParams

배열

DISABLE_SET_MONGOD_CONFIG 정책을 적용 할 때 비활성화할 mongod 설정 목록입니다. 자동화는 모든 MongoDB 옵션을 지원 하지 않으므로 가져오기 시도가 실패할 수 있습니다. 학습 내용은 MongoDB 설정 및 자동화 지원을 참조하세요.

응답

이름

유형

설명

_id

문자열

이 정책을 설정하는 프로젝트의 고유 식별자입니다.

created

문자열

ISO 8601 의 타임스탬프 이 기능 제어 정책이 생성된 시점의 UTC 날짜 및 시간 형식입니다.

updated

문자열

ISO 8601 의 타임스탬프 이 기능 제어 정책이 업데이트된 날짜 및 시간 형식(UTC )입니다.

externalManagementSystem

객체

이 Cloud Manager 프로젝트를 managed하는 외부 시스템의 매개변수 식별.

externalManagementSystem

.name

문자열

이 Cloud Manager 프로젝트를 managed하는 외부 시스템의 식별 레이블입니다.

externalManagementSystem

.systemId

문자열

이 Cloud Manager 프로젝트를 managed하는 외부 시스템의 고유 식별자입니다.

externalManagementSystem

.version

문자열

이 Cloud Manager 프로젝트를 managed하는 외부 시스템의 활성 릴리스입니다.

policies

배열

외부 시스템이 이 Cloud Manager 프로젝트에 적용하는 정책 목록입니다.

policies

.policy[n]

객체

이 Cloud Manager 프로젝트에 대해 설정된 단일 정책입니다. 이 매개변수는 policies 배열에서 한 번 이상 설정할 수 있습니다.

가능한 값은 다음과 같습니다.

값	목적
`EXTERNALLY_MANAGED_LOCK`	사용자는 Cloud Manager를 사용하여 `policies.policy[n]` 배열에 지정된 다른 설정을 managed할 수 없습니다. 동일한 사용자가 Kubernetes 연산자와 같이 구성된 외부 시스템을 사용하여 이러한 설정을 managed 수 있습니다.
`DISABLE_USER_MANAGEMENT`	사용자는 사용자나 역할을 managed 수 없습니다.
`DISABLE_AUTHENTICATION_` `MECHANISMS`	사용자는 인증 설정을 변경할 수 없습니다.
`DISABLE_SET_MONGOD_` `CONFIG`	사용자는 `policies[n].disabledParams` 배열에 나열된 `mongod` 설정을 변경할 수 없습니다.
`DISABLE_SET_MONGOD_` `VERSION`	사용자는 `mongod` 또는 `mongos` 의 버전을 변경할 수 없습니다.
`DISABLE_BACKUP_AGENT`	사용자는 백업 에이전트를 활성화하거나 비활성화할 수 없습니다.
`DISABLE_MONGOD_LOG_` `MANAGEMENT`	사용자는 로그 관리 설정을 변경할 수 없습니다.
`DISABLE_IMPORT_TO_` `AUTOMATION`	사용자는 자동화를 사용하여 배포를 managed 수 없습니다.
`DISABLE_AGENT_API_KEY_` `MANAGEMENT`	사용자는 에이전트 API 키를 생성하거나 업데이트할 수 없습니다.
`DISABLE_MONGOD_HOST_` `MANAGEMENT`	사용자는 호스트의 서버 유형을 변경할 수 없습니다.

policies[n]

.disabledParams

배열

DISABLE_SET_MONGOD_CONFIG 정책을 적용 하는 경우 비활성화할 mongod 설정 목록입니다. 자동화는 모든 MongoDB 옵션을 지원 하지 않으므로 가져오기 시도가 실패할 수 있습니다. 학습 내용은 MongoDB 설정 및 자동화 지원을 참조하세요.

요청 예시

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PUT "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/controlledFeature?pretty=true" \
6      --data '{
7        "externalManagementSystem":
8        {
9          "name": "Operator",
10          "systemId": "6d6c139ae5528707b6e8e3b2",
11          "version": "0.2.1"
12        },
13        "policies": [
14          {"policy": "ExternallyManagedLock"},
15          {"policy": "DisableUserManagement"},
16          {"policy": "DisableAuthenticationMechanisms"},
17          {"policy": "DisableSetMongodVersion"},
18          {
19            "policy": "DisableSetMongodConfig",
20            "disabledParams": ["net.tls.CAFile"]
21          }
22        ]
23      }'

응답 예시

응답 헤더

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   "_id": "{PROJECT-ID}",
3   "created": "2019-08-29T15:03:24Z",
4   "updated": "2019-08-29T15:03:24Z",
5   "externalManagementSystem":
6   {
7     "name": "Operator",
8     "systemId": "6d6c139ae5528707b6e8e3b2",
9     "version": "0.2.1"
10   },
11   "policies": [
12     {"policy": "ExternallyManagedLock"},
13     {"policy": "DisableUserManagement"},
14     {"policy": "DisableAuthenticationMechanisms"},
15     {"policy": "DisableSetMongodVersion"},
16     {
17       "policy": "DisableSetMongodConfig",
18       "disabledParams": ["net.tls.CAFile"]
19     }
20   ]
21 }

돌아가기

1개의 프로젝트에 대한 기능 정책 조회

모든 기능 정책 조회

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PUT "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/controlledFeature?pretty=true" \
6	--data '{
7	"externalManagementSystem":
8	{
9	"name": "Operator",
10	"systemId": "6d6c139ae5528707b6e8e3b2",
11	"version": "0.2.1"
12	},
13	"policies": [
14	{"policy": "ExternallyManagedLock"},
15	{"policy": "DisableUserManagement"},
16	{"policy": "DisableAuthenticationMechanisms"},
17	{"policy": "DisableSetMongodVersion"},
18	{
19	"policy": "DisableSetMongodConfig",
20	"disabledParams": ["net.tls.CAFile"]
21	}
22	]
23	}'

1	{
2	"_id": "{PROJECT-ID}",
3	"created": "2019-08-29T15:03:24Z",
4	"updated": "2019-08-29T15:03:24Z",
5	"externalManagementSystem":
6	{
7	"name": "Operator",
8	"systemId": "6d6c139ae5528707b6e8e3b2",
9	"version": "0.2.1"
10	},
11	"policies": [
12	{"policy": "ExternallyManagedLock"},
13	{"policy": "DisableUserManagement"},
14	{"policy": "DisableAuthenticationMechanisms"},
15	{"policy": "DisableSetMongodVersion"},
16	{
17	"policy": "DisableSetMongodConfig",
18	"disabledParams": ["net.tls.CAFile"]
19	}
20	]
21	}